Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
CApplicationPlayer Class Reference

#include <ApplicationPlayer.h>

Public Member Functions

 CApplicationPlayer ()
 
void ClosePlayer ()
 
void ResetPlayer ()
 
std::string GetCurrentPlayer ()
 
float GetPlaySpeed ()
 
float GetPlayTempo ()
 
bool HasPlayer () const
 
bool OpenFile (const CFileItem &item, const CPlayerOptions &options, const CPlayerCoreFactory &factory, const std::string &playerName, IPlayerCallback &callback)
 
void OpenNext (const CPlayerCoreFactory &factory)
 
void SetPlaySpeed (float speed)
 
void SetTempo (float tempo)
 
void FrameAdvance (int frames)
 
void FrameMove ()
 
void Render (bool clear, uint32_t alpha=255, bool gui=true)
 
void FlushRenderer ()
 
void SetRenderViewMode (int mode, float zoom, float par, float shift, bool stretch)
 
float GetRenderAspectRatio ()
 
void TriggerUpdateResolution ()
 
bool IsRenderingVideo ()
 
bool IsRenderingGuiLayer ()
 
bool IsRenderingVideoLayer ()
 
bool Supports (EINTERLACEMETHOD method)
 
EINTERLACEMETHOD GetDeinterlacingMethodDefault ()
 
bool Supports (ESCALINGMETHOD method)
 
bool Supports (ERENDERFEATURE feature)
 
unsigned int RenderCaptureAlloc ()
 
void RenderCapture (unsigned int captureId, unsigned int width, unsigned int height, int flags=0)
 
void RenderCaptureRelease (unsigned int captureId)
 
bool RenderCaptureGetPixels (unsigned int captureId, unsigned int millis, uint8_t *buffer, unsigned int size)
 
bool IsExternalPlaying ()
 
bool IsRemotePlaying ()
 
void AddSubtitle (const std::string &strSubPath)
 
bool CanPause ()
 
bool CanSeek ()
 
void DoAudioWork ()
 
void GetAudioCapabilities (std::vector< int > &audioCaps)
 
int GetAudioStream ()
 
int GetAudioStreamCount ()
 
void GetAudioStreamInfo (int index, AudioStreamInfo &info)
 
int GetCacheLevel () const
 
float GetCachePercentage () const
 
int GetChapterCount ()
 
int GetChapter ()
 
void GetChapterName (std::string &strChapterName, int chapterIdx=-1)
 
int64_t GetChapterPos (int chapterIdx=-1)
 
float GetPercentage () const
 
std::string GetPlayerState ()
 
int GetPreferredPlaylist () const
 
int GetSubtitle ()
 
void GetSubtitleCapabilities (std::vector< int > &subCaps)
 
int GetSubtitleCount ()
 
void GetSubtitleStreamInfo (int index, SubtitleStreamInfo &info)
 
bool GetSubtitleVisible ()
 
std::shared_ptr< TextCacheStruct_tGetTeletextCache ()
 
std::string GetRadioText (unsigned int line)
 
int64_t GetTime () const
 
int64_t GetMinTime () const
 
int64_t GetMaxTime () const
 
time_t GetStartTime () const
 
int64_t GetTotalTime () const
 
int GetVideoStream ()
 
int GetVideoStreamCount ()
 
void GetVideoStreamInfo (int streamId, VideoStreamInfo &info)
 
int GetPrograms (std::vector< ProgramInfo > &programs)
 
void SetProgram (int progId)
 
int GetProgramsCount ()
 
bool HasAudio () const
 
bool HasMenu () const
 
bool HasVideo () const
 
bool HasGame () const
 
bool HasRDS () const
 
bool IsCaching () const
 
bool IsInMenu () const
 
bool IsPaused ()
 
bool IsPausedPlayback ()
 
bool IsPassthrough () const
 
bool IsPlaying () const
 
bool IsPlayingAudio () const
 
bool IsPlayingVideo () const
 
bool IsPlayingGame () const
 
bool IsPlayingRDS () const
 
void LoadPage (int p, int sp, unsigned char *buffer)
 
bool OnAction (const CAction &action)
 
void OnNothingToQueueNotify ()
 
void Pause ()
 
bool QueueNextFile (const CFileItem &file)
 
void Seek (bool bPlus=true, bool bLargeStep=false, bool bChapterOverride=false)
 
int SeekChapter (int iChapter)
 
void SeekPercentage (float fPercent=0)
 
bool SeekScene (bool bPlus=true)
 
void SeekTime (int64_t iTime=0)
 
void SeekTimeRelative (int64_t iTime=0)
 
void SetAudioStream (int iStream)
 
void SetAVDelay (float fValue=0.0f)
 
void SetDynamicRangeCompression (long drc)
 
void SetMute (bool bOnOff)
 
bool SetPlayerState (const std::string &state)
 
void SetSubtitle (int iStream)
 
void SetSubTitleDelay (float fValue=0.0f)
 
void SetSubtitleVisible (bool bVisible)
 
void SetTime (int64_t time)
 
void SetTotalTime (int64_t time)
 
void SetVideoStream (int iStream)
 
void SetVolume (float volume)
 
void SetSpeed (float speed)
 
bool SupportsTempo ()
 
CVideoSettings GetVideoSettings ()
 
void SetVideoSettings (CVideoSettings &settings)
 
CSeekHandlerGetSeekHandler ()
 
void SetUpdateStreamDetails ()
 
bool HasGameAgent ()
 Check if any players are playing a game. More...
 

Constructor & Destructor Documentation

◆ CApplicationPlayer()

CApplicationPlayer::CApplicationPlayer ( )

Member Function Documentation

◆ AddSubtitle()

void CApplicationPlayer::AddSubtitle ( const std::string &  strSubPath)

◆ CanPause()

bool CApplicationPlayer::CanPause ( )

◆ CanSeek()

bool CApplicationPlayer::CanSeek ( )

◆ ClosePlayer()

void CApplicationPlayer::ClosePlayer ( )

◆ DoAudioWork()

void CApplicationPlayer::DoAudioWork ( )

◆ FlushRenderer()

void CApplicationPlayer::FlushRenderer ( )

◆ FrameAdvance()

void CApplicationPlayer::FrameAdvance ( int  frames)

◆ FrameMove()

void CApplicationPlayer::FrameMove ( )

◆ GetAudioCapabilities()

void CApplicationPlayer::GetAudioCapabilities ( std::vector< int > &  audioCaps)

◆ GetAudioStream()

int CApplicationPlayer::GetAudioStream ( )

◆ GetAudioStreamCount()

int CApplicationPlayer::GetAudioStreamCount ( )

◆ GetAudioStreamInfo()

void CApplicationPlayer::GetAudioStreamInfo ( int  index,
AudioStreamInfo info 
)

◆ GetCacheLevel()

int CApplicationPlayer::GetCacheLevel ( ) const

◆ GetCachePercentage()

float CApplicationPlayer::GetCachePercentage ( ) const

◆ GetChapter()

int CApplicationPlayer::GetChapter ( )

◆ GetChapterCount()

int CApplicationPlayer::GetChapterCount ( )

◆ GetChapterName()

void CApplicationPlayer::GetChapterName ( std::string &  strChapterName,
int  chapterIdx = -1 
)

◆ GetChapterPos()

int64_t CApplicationPlayer::GetChapterPos ( int  chapterIdx = -1)

◆ GetCurrentPlayer()

std::string CApplicationPlayer::GetCurrentPlayer ( )

◆ GetDeinterlacingMethodDefault()

EINTERLACEMETHOD CApplicationPlayer::GetDeinterlacingMethodDefault ( )

◆ GetMaxTime()

int64_t CApplicationPlayer::GetMaxTime ( ) const

◆ GetMinTime()

int64_t CApplicationPlayer::GetMinTime ( ) const

◆ GetPercentage()

float CApplicationPlayer::GetPercentage ( ) const

◆ GetPlayerState()

std::string CApplicationPlayer::GetPlayerState ( )

◆ GetPlaySpeed()

float CApplicationPlayer::GetPlaySpeed ( )

◆ GetPlayTempo()

float CApplicationPlayer::GetPlayTempo ( )

◆ GetPreferredPlaylist()

int CApplicationPlayer::GetPreferredPlaylist ( ) const

◆ GetPrograms()

int CApplicationPlayer::GetPrograms ( std::vector< ProgramInfo > &  programs)

◆ GetProgramsCount()

int CApplicationPlayer::GetProgramsCount ( )

◆ GetRadioText()

std::string CApplicationPlayer::GetRadioText ( unsigned int  line)

◆ GetRenderAspectRatio()

float CApplicationPlayer::GetRenderAspectRatio ( )

◆ GetSeekHandler()

CSeekHandler & CApplicationPlayer::GetSeekHandler ( )

◆ GetStartTime()

time_t CApplicationPlayer::GetStartTime ( ) const

◆ GetSubtitle()

int CApplicationPlayer::GetSubtitle ( )

◆ GetSubtitleCapabilities()

void CApplicationPlayer::GetSubtitleCapabilities ( std::vector< int > &  subCaps)

◆ GetSubtitleCount()

int CApplicationPlayer::GetSubtitleCount ( )

◆ GetSubtitleStreamInfo()

void CApplicationPlayer::GetSubtitleStreamInfo ( int  index,
SubtitleStreamInfo info 
)

◆ GetSubtitleVisible()

bool CApplicationPlayer::GetSubtitleVisible ( )

◆ GetTeletextCache()

std::shared_ptr< TextCacheStruct_t > CApplicationPlayer::GetTeletextCache ( )

◆ GetTime()

int64_t CApplicationPlayer::GetTime ( ) const

◆ GetTotalTime()

int64_t CApplicationPlayer::GetTotalTime ( ) const

◆ GetVideoSettings()

CVideoSettings CApplicationPlayer::GetVideoSettings ( )

◆ GetVideoStream()

int CApplicationPlayer::GetVideoStream ( )

◆ GetVideoStreamCount()

int CApplicationPlayer::GetVideoStreamCount ( )

◆ GetVideoStreamInfo()

void CApplicationPlayer::GetVideoStreamInfo ( int  streamId,
VideoStreamInfo info 
)

◆ HasAudio()

bool CApplicationPlayer::HasAudio ( ) const

◆ HasGame()

bool CApplicationPlayer::HasGame ( ) const

◆ HasGameAgent()

bool CApplicationPlayer::HasGameAgent ( )

Check if any players are playing a game.

Returns
True if at least one player has an input device attached to the game, false otherwise

◆ HasMenu()

bool CApplicationPlayer::HasMenu ( ) const

◆ HasPlayer()

bool CApplicationPlayer::HasPlayer ( ) const

◆ HasRDS()

bool CApplicationPlayer::HasRDS ( ) const

◆ HasVideo()

bool CApplicationPlayer::HasVideo ( ) const

◆ IsCaching()

bool CApplicationPlayer::IsCaching ( ) const

◆ IsExternalPlaying()

bool CApplicationPlayer::IsExternalPlaying ( )

◆ IsInMenu()

bool CApplicationPlayer::IsInMenu ( ) const

◆ IsPassthrough()

bool CApplicationPlayer::IsPassthrough ( ) const

◆ IsPaused()

bool CApplicationPlayer::IsPaused ( )

◆ IsPausedPlayback()

bool CApplicationPlayer::IsPausedPlayback ( )

◆ IsPlaying()

bool CApplicationPlayer::IsPlaying ( ) const

◆ IsPlayingAudio()

bool CApplicationPlayer::IsPlayingAudio ( ) const

◆ IsPlayingGame()

bool CApplicationPlayer::IsPlayingGame ( ) const

◆ IsPlayingRDS()

bool CApplicationPlayer::IsPlayingRDS ( ) const

◆ IsPlayingVideo()

bool CApplicationPlayer::IsPlayingVideo ( ) const

◆ IsRemotePlaying()

bool CApplicationPlayer::IsRemotePlaying ( )

◆ IsRenderingGuiLayer()

bool CApplicationPlayer::IsRenderingGuiLayer ( )

◆ IsRenderingVideo()

bool CApplicationPlayer::IsRenderingVideo ( )

◆ IsRenderingVideoLayer()

bool CApplicationPlayer::IsRenderingVideoLayer ( )

◆ LoadPage()

void CApplicationPlayer::LoadPage ( int  p,
int  sp,
unsigned char *  buffer 
)

◆ OnAction()

bool CApplicationPlayer::OnAction ( const CAction action)

◆ OnNothingToQueueNotify()

void CApplicationPlayer::OnNothingToQueueNotify ( )

◆ OpenFile()

bool CApplicationPlayer::OpenFile ( const CFileItem item,
const CPlayerOptions options,
const CPlayerCoreFactory factory,
const std::string &  playerName,
IPlayerCallback callback 
)

◆ OpenNext()

void CApplicationPlayer::OpenNext ( const CPlayerCoreFactory factory)

◆ Pause()

void CApplicationPlayer::Pause ( )

◆ QueueNextFile()

bool CApplicationPlayer::QueueNextFile ( const CFileItem file)

◆ Render()

void CApplicationPlayer::Render ( bool  clear,
uint32_t  alpha = 255,
bool  gui = true 
)

◆ RenderCapture()

void CApplicationPlayer::RenderCapture ( unsigned int  captureId,
unsigned int  width,
unsigned int  height,
int  flags = 0 
)

◆ RenderCaptureAlloc()

unsigned int CApplicationPlayer::RenderCaptureAlloc ( )

◆ RenderCaptureGetPixels()

bool CApplicationPlayer::RenderCaptureGetPixels ( unsigned int  captureId,
unsigned int  millis,
uint8_t buffer,
unsigned int  size 
)

◆ RenderCaptureRelease()

void CApplicationPlayer::RenderCaptureRelease ( unsigned int  captureId)

◆ ResetPlayer()

void CApplicationPlayer::ResetPlayer ( )

◆ Seek()

void CApplicationPlayer::Seek ( bool  bPlus = true,
bool  bLargeStep = false,
bool  bChapterOverride = false 
)

◆ SeekChapter()

int CApplicationPlayer::SeekChapter ( int  iChapter)

◆ SeekPercentage()

void CApplicationPlayer::SeekPercentage ( float  fPercent = 0)

◆ SeekScene()

bool CApplicationPlayer::SeekScene ( bool  bPlus = true)

◆ SeekTime()

void CApplicationPlayer::SeekTime ( int64_t  iTime = 0)

◆ SeekTimeRelative()

void CApplicationPlayer::SeekTimeRelative ( int64_t  iTime = 0)

◆ SetAudioStream()

void CApplicationPlayer::SetAudioStream ( int  iStream)

◆ SetAVDelay()

void CApplicationPlayer::SetAVDelay ( float  fValue = 0.0f)

◆ SetDynamicRangeCompression()

void CApplicationPlayer::SetDynamicRangeCompression ( long  drc)

◆ SetMute()

void CApplicationPlayer::SetMute ( bool  bOnOff)

◆ SetPlayerState()

bool CApplicationPlayer::SetPlayerState ( const std::string &  state)

◆ SetPlaySpeed()

void CApplicationPlayer::SetPlaySpeed ( float  speed)

◆ SetProgram()

void CApplicationPlayer::SetProgram ( int  progId)

◆ SetRenderViewMode()

void CApplicationPlayer::SetRenderViewMode ( int  mode,
float  zoom,
float  par,
float  shift,
bool  stretch 
)

◆ SetSpeed()

void CApplicationPlayer::SetSpeed ( float  speed)

◆ SetSubtitle()

void CApplicationPlayer::SetSubtitle ( int  iStream)

◆ SetSubTitleDelay()

void CApplicationPlayer::SetSubTitleDelay ( float  fValue = 0.0f)

◆ SetSubtitleVisible()

void CApplicationPlayer::SetSubtitleVisible ( bool  bVisible)

◆ SetTempo()

void CApplicationPlayer::SetTempo ( float  tempo)

◆ SetTime()

void CApplicationPlayer::SetTime ( int64_t  time)

◆ SetTotalTime()

void CApplicationPlayer::SetTotalTime ( int64_t  time)

◆ SetUpdateStreamDetails()

void CApplicationPlayer::SetUpdateStreamDetails ( )

◆ SetVideoSettings()

void CApplicationPlayer::SetVideoSettings ( CVideoSettings settings)

◆ SetVideoStream()

void CApplicationPlayer::SetVideoStream ( int  iStream)

◆ SetVolume()

void CApplicationPlayer::SetVolume ( float  volume)

◆ Supports() [1/3]

bool CApplicationPlayer::Supports ( EINTERLACEMETHOD  method)

◆ Supports() [2/3]

bool CApplicationPlayer::Supports ( ERENDERFEATURE  feature)

◆ Supports() [3/3]

bool CApplicationPlayer::Supports ( ESCALINGMETHOD  method)

◆ SupportsTempo()

bool CApplicationPlayer::SupportsTempo ( )

◆ TriggerUpdateResolution()

void CApplicationPlayer::TriggerUpdateResolution ( )

The documentation for this class was generated from the following files: