Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
Public Member Functions | Public Attributes | Protected Attributes | List of all members
IPlayer Class Referenceabstract

#include <IPlayer.h>

Inheritance diagram for IPlayer:
CExternalPlayer CVideoPlayer KODI::RETRO::CRetroPlayer PAPlayer UPNP::CUPnPPlayer

Public Member Functions

 IPlayer (IPlayerCallback &callback)
 
virtual ~IPlayer ()=default
 
virtual bool Initialize (TiXmlElement *pConfig)
 
virtual bool OpenFile (const CFileItem &file, const CPlayerOptions &options)
 
virtual bool QueueNextFile (const CFileItem &file)
 
virtual void OnNothingToQueueNotify ()
 
virtual bool CloseFile (bool reopen=false)=0
 
virtual bool IsPlaying () const
 
virtual bool CanPause ()
 
virtual void Pause ()=0
 
virtual bool HasVideo () const =0
 
virtual bool HasAudio () const =0
 
virtual bool HasGame () const
 
virtual bool HasRDS () const
 
virtual bool IsPassthrough () const
 
virtual bool CanSeek ()
 
virtual void Seek (bool bPlus=true, bool bLargeStep=false, bool bChapterOverride=false)=0
 
virtual bool SeekScene (bool bPlus=true)
 
virtual void SeekPercentage (float fPercent=0)
 
virtual float GetCachePercentage ()
 
virtual void SetMute (bool bOnOff)
 
virtual void SetVolume (float volume)
 
virtual void SetDynamicRangeCompression (long drc)
 
virtual void SetAVDelay (float fValue=0.0f)
 
virtual float GetAVDelay ()
 
virtual void SetSubTitleDelay (float fValue=0.0f)
 
virtual float GetSubTitleDelay ()
 
virtual int GetSubtitleCount ()
 
virtual int GetSubtitle ()
 
virtual void GetSubtitleStreamInfo (int index, SubtitleStreamInfo &info)
 
virtual void SetSubtitle (int iStream)
 
virtual bool GetSubtitleVisible ()
 
virtual void SetSubtitleVisible (bool bVisible)
 
virtual void AddSubtitle (const std::string &strSubPath)
 Adds the subtitle(s) provided by the given file to the available player streams and actives the first of the added stream(s). E.g., vob subs can contain multiple streams. More...
 
virtual int GetAudioStreamCount ()
 
virtual int GetAudioStream ()
 
virtual void SetAudioStream (int iStream)
 
virtual void GetAudioStreamInfo (int index, AudioStreamInfo &info)
 
virtual int GetVideoStream () const
 
virtual int GetVideoStreamCount () const
 
virtual void GetVideoStreamInfo (int streamId, VideoStreamInfo &info)
 
virtual void SetVideoStream (int iStream)
 
virtual int GetPrograms (std::vector< ProgramInfo > &programs)
 
virtual void SetProgram (int progId)
 
virtual int GetProgramsCount ()
 
virtual std::shared_ptr< TextCacheStruct_t > GetTeletextCache ()
 
virtual void LoadPage (int p, int sp, unsigned char *buffer)
 
virtual std::string GetRadioText (unsigned int line)
 
virtual int GetChapterCount ()
 
virtual int GetChapter ()
 
virtual void GetChapterName (std::string &strChapterName, int chapterIdx=-1)
 
virtual int64_t GetChapterPos (int chapterIdx=-1)
 
virtual int SeekChapter (int iChapter)
 
virtual void SeekTime (int64_t iTime=0)
 
virtual bool SeekTimeRelative (int64_t iTime)
 
virtual void SetTime (int64_t time)
 Sets the current time. This can be used for injecting the current time. This is not to be confused with a seek. It just can be used if endless streams contain multiple tracks in reality (like with airtunes) More...
 
virtual void SetTotalTime (int64_t time)
 Set the total time in milliseconds this can be used for injecting the duration in case its not available in the underlaying decoder (airtunes for example) More...
 
virtual void SetSpeed (float speed)=0
 
virtual void SetTempo (float tempo)
 
virtual bool SupportsTempo ()
 
virtual void FrameAdvance (int frames)
 
virtual bool IsCaching () const
 
virtual int GetCacheLevel () const
 
virtual bool IsInMenu () const
 
virtual bool HasMenu () const
 
virtual void DoAudioWork ()
 
virtual bool OnAction (const CAction &action)
 
virtual std::string GetPlayerState ()
 
virtual bool SetPlayerState (const std::string &state)
 
virtual void GetAudioCapabilities (std::vector< int > &audioCaps)
 
virtual void GetSubtitleCapabilities (std::vector< int > &subCaps)
 define the subtitle capabilities of the player More...
 
virtual void Render (bool clear, uint32_t alpha=255, bool gui=true)
 hook into render loop of render thread More...
 
virtual void FlushRenderer ()
 
virtual void SetRenderViewMode (int mode, float zoom, float par, float shift, bool stretch)
 
virtual float GetRenderAspectRatio ()
 
virtual void TriggerUpdateResolution ()
 
virtual bool IsRenderingVideo ()
 
virtual bool Supports (EINTERLACEMETHOD method)
 
virtual EINTERLACEMETHOD GetDeinterlacingMethodDefault ()
 
virtual bool Supports (ESCALINGMETHOD method)
 
virtual bool Supports (ERENDERFEATURE feature)
 
virtual unsigned int RenderCaptureAlloc ()
 
virtual void RenderCaptureRelease (unsigned int captureId)
 
virtual void RenderCapture (unsigned int captureId, unsigned int width, unsigned int height, int flags)
 
virtual bool RenderCaptureGetPixels (unsigned int captureId, unsigned int millis, uint8_t *buffer, unsigned int size)
 
virtual CVideoSettings GetVideoSettings ()
 
virtual void SetVideoSettings (CVideoSettings &settings)
 
virtual bool HasGameAgent ()
 Check if any players are playing a game. More...
 

Public Attributes

std::string m_name
 
std::string m_type
 

Protected Attributes

IPlayerCallback & m_callback
 

Constructor & Destructor Documentation

◆ IPlayer()

IPlayer::IPlayer ( IPlayerCallback &  callback)
inlineexplicit

◆ ~IPlayer()

virtual IPlayer::~IPlayer ( )
virtualdefault

Member Function Documentation

◆ AddSubtitle()

virtual void IPlayer::AddSubtitle ( const std::string &  strSubPath)
inlinevirtual

Adds the subtitle(s) provided by the given file to the available player streams and actives the first of the added stream(s). E.g., vob subs can contain multiple streams.

Parameters
[in]strSubPathThe full path of the subtitle file.

Reimplemented in CVideoPlayer.

◆ CanPause()

virtual bool IPlayer::CanPause ( )
inlinevirtual

Reimplemented in KODI::RETRO::CRetroPlayer, and CVideoPlayer.

◆ CanSeek()

virtual bool IPlayer::CanSeek ( )
inlinevirtual

Reimplemented in CExternalPlayer, PAPlayer, KODI::RETRO::CRetroPlayer, and CVideoPlayer.

◆ CloseFile()

virtual bool IPlayer::CloseFile ( bool  reopen = false)
pure virtual

Implemented in CExternalPlayer, PAPlayer, KODI::RETRO::CRetroPlayer, CVideoPlayer, and UPNP::CUPnPPlayer.

◆ DoAudioWork()

virtual void IPlayer::DoAudioWork ( )
inlinevirtual

Reimplemented in CExternalPlayer, and UPNP::CUPnPPlayer.

◆ FlushRenderer()

virtual void IPlayer::FlushRenderer ( )
inlinevirtual

Reimplemented in CVideoPlayer.

◆ FrameAdvance()

virtual void IPlayer::FrameAdvance ( int  frames)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetAudioCapabilities()

virtual void IPlayer::GetAudioCapabilities ( std::vector< int > &  audioCaps)
inlinevirtual

Reimplemented in PAPlayer.

◆ GetAudioStream()

virtual int IPlayer::GetAudioStream ( )
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetAudioStreamCount()

virtual int IPlayer::GetAudioStreamCount ( )
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetAudioStreamInfo()

virtual void IPlayer::GetAudioStreamInfo ( int  index,
AudioStreamInfo &  info 
)
inlinevirtual

Reimplemented in PAPlayer, and CVideoPlayer.

◆ GetAVDelay()

virtual float IPlayer::GetAVDelay ( )
inlinevirtual

Reimplemented in CExternalPlayer, and CVideoPlayer.

◆ GetCacheLevel()

virtual int IPlayer::GetCacheLevel ( ) const
inlinevirtual

Reimplemented in PAPlayer, CVideoPlayer, and UPNP::CUPnPPlayer.

◆ GetCachePercentage()

virtual float IPlayer::GetCachePercentage ( )
inlinevirtual

Reimplemented in KODI::RETRO::CRetroPlayer, and CVideoPlayer.

◆ GetChapter()

virtual int IPlayer::GetChapter ( )
inlinevirtual

Reimplemented in CVideoPlayer, and UPNP::CUPnPPlayer.

◆ GetChapterCount()

virtual int IPlayer::GetChapterCount ( )
inlinevirtual

Reimplemented in CVideoPlayer, and UPNP::CUPnPPlayer.

◆ GetChapterName()

virtual void IPlayer::GetChapterName ( std::string &  strChapterName,
int  chapterIdx = -1 
)
inlinevirtual

Reimplemented in CVideoPlayer, and UPNP::CUPnPPlayer.

◆ GetChapterPos()

virtual int64_t IPlayer::GetChapterPos ( int  chapterIdx = -1)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetDeinterlacingMethodDefault()

virtual EINTERLACEMETHOD IPlayer::GetDeinterlacingMethodDefault ( )
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetPlayerState()

virtual std::string IPlayer::GetPlayerState ( )
inlinevirtual

Reimplemented in CExternalPlayer, KODI::RETRO::CRetroPlayer, and CVideoPlayer.

◆ GetPrograms()

virtual int IPlayer::GetPrograms ( std::vector< ProgramInfo > &  programs)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetProgramsCount()

virtual int IPlayer::GetProgramsCount ( )
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetRadioText()

virtual std::string IPlayer::GetRadioText ( unsigned int  line)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetRenderAspectRatio()

virtual float IPlayer::GetRenderAspectRatio ( )
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetSubtitle()

virtual int IPlayer::GetSubtitle ( )
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetSubtitleCapabilities()

virtual void IPlayer::GetSubtitleCapabilities ( std::vector< int > &  subCaps)
inlinevirtual

define the subtitle capabilities of the player

◆ GetSubtitleCount()

virtual int IPlayer::GetSubtitleCount ( )
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetSubTitleDelay()

virtual float IPlayer::GetSubTitleDelay ( )
inlinevirtual

Reimplemented in CExternalPlayer, and CVideoPlayer.

◆ GetSubtitleStreamInfo()

virtual void IPlayer::GetSubtitleStreamInfo ( int  index,
SubtitleStreamInfo &  info 
)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetSubtitleVisible()

virtual bool IPlayer::GetSubtitleVisible ( )
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetTeletextCache()

virtual std::shared_ptr< TextCacheStruct_t > IPlayer::GetTeletextCache ( )
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetVideoSettings()

virtual CVideoSettings IPlayer::GetVideoSettings ( )
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetVideoStream()

virtual int IPlayer::GetVideoStream ( ) const
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetVideoStreamCount()

virtual int IPlayer::GetVideoStreamCount ( ) const
inlinevirtual

Reimplemented in CVideoPlayer.

◆ GetVideoStreamInfo()

virtual void IPlayer::GetVideoStreamInfo ( int  streamId,
VideoStreamInfo &  info 
)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ HasAudio()

virtual bool IPlayer::HasAudio ( ) const
pure virtual

Implemented in CExternalPlayer, PAPlayer, KODI::RETRO::CRetroPlayer, CVideoPlayer, and UPNP::CUPnPPlayer.

◆ HasGame()

virtual bool IPlayer::HasGame ( ) const
inlinevirtual

Reimplemented in KODI::RETRO::CRetroPlayer.

◆ HasGameAgent()

virtual bool IPlayer::HasGameAgent ( )
inlinevirtual

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

Reimplemented in KODI::RETRO::CRetroPlayer.

◆ HasMenu()

virtual bool IPlayer::HasMenu ( ) const
inlinevirtual

Reimplemented in CVideoPlayer.

◆ HasRDS()

virtual bool IPlayer::HasRDS ( ) const
inlinevirtual

Reimplemented in CVideoPlayer.

◆ HasVideo()

virtual bool IPlayer::HasVideo ( ) const
pure virtual

Implemented in CExternalPlayer, PAPlayer, KODI::RETRO::CRetroPlayer, CVideoPlayer, and UPNP::CUPnPPlayer.

◆ Initialize()

virtual bool IPlayer::Initialize ( TiXmlElement *  pConfig)
inlinevirtual

Reimplemented in CExternalPlayer.

◆ IsCaching()

virtual bool IPlayer::IsCaching ( ) const
inlinevirtual

Reimplemented in CVideoPlayer, and UPNP::CUPnPPlayer.

◆ IsInMenu()

virtual bool IPlayer::IsInMenu ( ) const
inlinevirtual

Reimplemented in CVideoPlayer.

◆ IsPassthrough()

virtual bool IPlayer::IsPassthrough ( ) const
inlinevirtual

Reimplemented in CVideoPlayer.

◆ IsPlaying()

virtual bool IPlayer::IsPlaying ( ) const
inlinevirtual

Reimplemented in CExternalPlayer, PAPlayer, KODI::RETRO::CRetroPlayer, CVideoPlayer, and UPNP::CUPnPPlayer.

◆ IsRenderingVideo()

virtual bool IPlayer::IsRenderingVideo ( )
inlinevirtual

Reimplemented in KODI::RETRO::CRetroPlayer, and CVideoPlayer.

◆ LoadPage()

virtual void IPlayer::LoadPage ( int  p,
int  sp,
unsigned char *  buffer 
)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ OnAction()

virtual bool IPlayer::OnAction ( const CAction &  action)
inlinevirtual

Reimplemented in KODI::RETRO::CRetroPlayer, CVideoPlayer, and UPNP::CUPnPPlayer.

◆ OnNothingToQueueNotify()

virtual void IPlayer::OnNothingToQueueNotify ( )
inlinevirtual

Reimplemented in PAPlayer.

◆ OpenFile()

virtual bool IPlayer::OpenFile ( const CFileItem &  file,
const CPlayerOptions &  options 
)
inlinevirtual

Reimplemented in CExternalPlayer, PAPlayer, KODI::RETRO::CRetroPlayer, CVideoPlayer, and UPNP::CUPnPPlayer.

◆ Pause()

virtual void IPlayer::Pause ( )
pure virtual

Implemented in CExternalPlayer, PAPlayer, KODI::RETRO::CRetroPlayer, CVideoPlayer, and UPNP::CUPnPPlayer.

◆ QueueNextFile()

virtual bool IPlayer::QueueNextFile ( const CFileItem &  file)
inlinevirtual

Reimplemented in PAPlayer, and UPNP::CUPnPPlayer.

◆ Render()

virtual void IPlayer::Render ( bool  clear,
uint32_t  alpha = 255,
bool  gui = true 
)
inlinevirtual

hook into render loop of render thread

Reimplemented in KODI::RETRO::CRetroPlayer, and CVideoPlayer.

◆ RenderCapture()

virtual void IPlayer::RenderCapture ( unsigned int  captureId,
unsigned int  width,
unsigned int  height,
int  flags 
)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ RenderCaptureAlloc()

virtual unsigned int IPlayer::RenderCaptureAlloc ( )
inlinevirtual

Reimplemented in CVideoPlayer.

◆ RenderCaptureGetPixels()

virtual bool IPlayer::RenderCaptureGetPixels ( unsigned int  captureId,
unsigned int  millis,
uint8_t *  buffer,
unsigned int  size 
)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ RenderCaptureRelease()

virtual void IPlayer::RenderCaptureRelease ( unsigned int  captureId)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ Seek()

virtual void IPlayer::Seek ( bool  bPlus = true,
bool  bLargeStep = false,
bool  bChapterOverride = false 
)
pure virtual

Implemented in CExternalPlayer, CVideoPlayer, UPNP::CUPnPPlayer, PAPlayer, and KODI::RETRO::CRetroPlayer.

◆ SeekChapter()

virtual int IPlayer::SeekChapter ( int  iChapter)
inlinevirtual

Reimplemented in CVideoPlayer, and UPNP::CUPnPPlayer.

◆ SeekPercentage()

virtual void IPlayer::SeekPercentage ( float  fPercent = 0)
inlinevirtual

Reimplemented in KODI::RETRO::CRetroPlayer, UPNP::CUPnPPlayer, PAPlayer, CExternalPlayer, and CVideoPlayer.

◆ SeekScene()

virtual bool IPlayer::SeekScene ( bool  bPlus = true)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ SeekTime()

virtual void IPlayer::SeekTime ( int64_t  iTime = 0)
inlinevirtual

Reimplemented in CExternalPlayer, CVideoPlayer, PAPlayer, KODI::RETRO::CRetroPlayer, and UPNP::CUPnPPlayer.

◆ SeekTimeRelative()

virtual bool IPlayer::SeekTimeRelative ( int64_t  iTime)
inlinevirtual

Reimplemented in KODI::RETRO::CRetroPlayer, and CVideoPlayer.

◆ SetAudioStream()

virtual void IPlayer::SetAudioStream ( int  iStream)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ SetAVDelay()

virtual void IPlayer::SetAVDelay ( float  fValue = 0.0f)
inlinevirtual

Reimplemented in CExternalPlayer, and CVideoPlayer.

◆ SetDynamicRangeCompression()

virtual void IPlayer::SetDynamicRangeCompression ( long  drc)
inlinevirtual

Reimplemented in CExternalPlayer, PAPlayer, and CVideoPlayer.

◆ SetMute()

virtual void IPlayer::SetMute ( bool  bOnOff)
inlinevirtual

Reimplemented in KODI::RETRO::CRetroPlayer, and CVideoPlayer.

◆ SetPlayerState()

virtual bool IPlayer::SetPlayerState ( const std::string &  state)
inlinevirtual

Reimplemented in CExternalPlayer, KODI::RETRO::CRetroPlayer, and CVideoPlayer.

◆ SetProgram()

virtual void IPlayer::SetProgram ( int  progId)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ SetRenderViewMode()

virtual void IPlayer::SetRenderViewMode ( int  mode,
float  zoom,
float  par,
float  shift,
bool  stretch 
)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ SetSpeed()

virtual void IPlayer::SetSpeed ( float  speed)
pure virtual

Implemented in CExternalPlayer, KODI::RETRO::CRetroPlayer, CVideoPlayer, PAPlayer, and UPNP::CUPnPPlayer.

◆ SetSubtitle()

virtual void IPlayer::SetSubtitle ( int  iStream)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ SetSubTitleDelay()

virtual void IPlayer::SetSubTitleDelay ( float  fValue = 0.0f)
inlinevirtual

Reimplemented in CExternalPlayer, and CVideoPlayer.

◆ SetSubtitleVisible()

virtual void IPlayer::SetSubtitleVisible ( bool  bVisible)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ SetTempo()

virtual void IPlayer::SetTempo ( float  tempo)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ SetTime()

virtual void IPlayer::SetTime ( int64_t  time)
inlinevirtual

Sets the current time. This can be used for injecting the current time. This is not to be confused with a seek. It just can be used if endless streams contain multiple tracks in reality (like with airtunes)

Reimplemented in PAPlayer.

◆ SetTotalTime()

virtual void IPlayer::SetTotalTime ( int64_t  time)
inlinevirtual

Set the total time in milliseconds this can be used for injecting the duration in case its not available in the underlaying decoder (airtunes for example)

Reimplemented in PAPlayer.

◆ SetVideoSettings()

virtual void IPlayer::SetVideoSettings ( CVideoSettings &  settings)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ SetVideoStream()

virtual void IPlayer::SetVideoStream ( int  iStream)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ SetVolume()

virtual void IPlayer::SetVolume ( float  volume)
inlinevirtual

Reimplemented in CVideoPlayer, CExternalPlayer, PAPlayer, and UPNP::CUPnPPlayer.

◆ Supports() [1/3]

virtual bool IPlayer::Supports ( EINTERLACEMETHOD  method)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ Supports() [2/3]

virtual bool IPlayer::Supports ( ERENDERFEATURE  feature)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ Supports() [3/3]

virtual bool IPlayer::Supports ( ESCALINGMETHOD  method)
inlinevirtual

Reimplemented in CVideoPlayer.

◆ SupportsTempo()

virtual bool IPlayer::SupportsTempo ( )
inlinevirtual

Reimplemented in CVideoPlayer.

◆ TriggerUpdateResolution()

virtual void IPlayer::TriggerUpdateResolution ( )
inlinevirtual

Reimplemented in CVideoPlayer.

Member Data Documentation

◆ m_callback

IPlayerCallback& IPlayer::m_callback
protected

◆ m_name

std::string IPlayer::m_name

◆ m_type

std::string IPlayer::m_type
The documentation for this class was generated from the following file: