Kodi Documentation  20.0
Kodi is an open source media player and entertainment hub.
XBMCAddon::xbmc::Player Class Reference

#include <Player.h>

Inheritance diagram for XBMCAddon::xbmc::Player:
Collaboration diagram for XBMCAddon::xbmc::Player:

Public Member Functions

 play (...)
 

Function: play([item, listitem, windowed, startpos])


Play an item. More...
 
 stop ()
 

Function: stop()


Stop playing. More...
 
 pause ()
 

Function: pause()


Pause or resume playing if already paused. More...
 
 playnext ()
 

Function: playnext()


Play next item in playlist. More...
 
 playprevious ()
 

Function: playprevious()


Play previous item in playlist. More...
 
 playselected (...)
 

Function: playselected(selected)


Play a certain item from the current playlist. More...
 
 onPlayBackStarted ()
 

Function: onPlayBackStarted()


onPlayBackStarted method. More...
 
 onAVStarted ()
 

Function: onAVStarted()


onAVStarted method. More...
 
 onAVChange ()
 

Function: onAVChange()


onAVChange method. More...
 
 onPlayBackEnded ()
 

Function: onPlayBackEnded()


onPlayBackEnded method. More...
 
 onPlayBackStopped ()
 

Function: onPlayBackStopped()


onPlayBackStopped method. More...
 
 onPlayBackError ()
 

Function: onPlayBackError()


onPlayBackError method. More...
 
 onPlayBackPaused ()
 

Function: onPlayBackPaused()


onPlayBackPaused method. More...
 
 onPlayBackResumed ()
 

Function: onPlayBackResumed()


onPlayBackResumed method. More...
 
 onQueueNextItem ()
 

Function: onQueueNextItem()


onQueueNextItem method. More...
 
 onPlayBackSpeedChanged (int speed)
 

Function: onPlayBackSpeedChanged(speed)


onPlayBackSpeedChanged method. More...
 
 onPlayBackSeek (...)
 

Function: onPlayBackSeek(time, seekOffset)


onPlayBackSeek method. More...
 
 onPlayBackSeekChapter (...)
 

Function: onPlayBackSeekChapter(chapter)


onPlayBackSeekChapter method. More...
 
 isPlaying ()
 

Function: isPlaying()


Check Kodi is playing something. More...
 
 isPlayingAudio ()
 

Function: isPlayingAudio()


Check for playing audio. More...
 
 isPlayingVideo ()
 

Function: isPlayingVideo()


Check for playing video. More...
 
 isPlayingRDS ()
 

Function: isPlayingRDS()


Check for playing radio data system (RDS). More...
 
 isExternalPlayer ()
 

Function: isExternalPlayer()


Check for external player. More...
 
 getPlayingFile ()
 

Function: getPlayingFile()


Returns the current playing file as a string. More...
 
 getPlayingItem ()
 

Function: getPlayingItem()



Returns the current playing item. More...

 
 getTime ()
 

Function: getTime()


Get playing time. More...
 
 seekTime (...)
 

Function: seekTime(seekTime)


Seek time. More...
 
 setSubtitles (...)
 

Function: setSubtitles(subtitleFile)


Set subtitle file and enable subtitles. More...
 
 showSubtitles (...)
 

Function: showSubtitles(visible)


Enable / disable subtitles. More...
 
 getSubtitles ()
 

Function: getSubtitles()


Get subtitle stream name. More...
 
 getAvailableSubtitleStreams ()
 

Function: getAvailableSubtitleStreams()


Get Subtitle stream names. More...
 
 setSubtitleStream (...)
 

Function: setSubtitleStream(stream)


Set Subtitle Stream. More...
 
 updateInfoTag ()
 

Function: updateInfoTag(item)


Update info labels for currently playing item. More...
 
 getVideoInfoTag ()
 

Function: getVideoInfoTag()


To get video info tag. More...
 
 getMusicInfoTag ()
 

Function: getMusicInfoTag()


To get music info tag. More...
 
 getRadioRDSInfoTag ()
 

Function: getRadioRDSInfoTag()


To get Radio RDS info tag More...
 
 getTotalTime ()
 

Function: getTotalTime()


To get total playing time. More...
 
 getAvailableAudioStreams ()
 

Function: getAvailableAudioStreams()


Get Audio stream names More...
 
 setAudioStream (...)
 

Function: setAudioStream(stream)


Set Audio Stream. More...
 
 getAvailableVideoStreams ()
 

Function: getAvailableVideoStreams()


Get Video stream names More...
 
 setVideoStream (...)
 

Function: setVideoStream(stream)


Set Video Stream. More...
 
- Public Member Functions inherited from XBMCAddon::AddonCallback
 ~AddonCallback () override
 
void setHandler (CallbackHandler *_handler)
 
void invokeCallback (Callback *callback)
 
- Public Member Functions inherited from XBMCAddon::AddonClass
 AddonClass ()
 
virtual ~AddonClass ()
 
const char * GetClassname () const
 
LanguageHookGetLanguageHook ()
 
bool isDeallocating ()
 
void Release () const
 
void Acquire () const
 
- Public Member Functions inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
 CountingLockable ()=default
 
void lock ()
 
bool try_lock ()
 
void unlock ()
 
unsigned int exit (unsigned int leave=0)
 
void restore (unsigned int restoreCount)
 
XbmcThreads::CRecursiveMutex & get_underlying ()
 
- Public Member Functions inherited from IPlayerCallback
virtual ~IPlayerCallback ()=default
 
virtual void OnPlayBackEnded ()=0
 
virtual void OnPlayBackStarted (const CFileItem &file)=0
 
virtual void OnPlayerCloseFile (const CFileItem &file, const CBookmark &bookmark)
 
virtual void OnPlayBackPaused ()
 
virtual void OnPlayBackResumed ()
 
virtual void OnPlayBackStopped ()=0
 
virtual void OnPlayBackError ()=0
 
virtual void OnQueueNextItem ()=0
 
virtual void OnPlayBackSeek (int64_t iTime, int64_t seekOffset)
 
virtual void OnPlayBackSeekChapter (int iChapter)
 
virtual void OnPlayBackSpeedChanged (int iSpeed)
 
virtual void OnAVChange ()
 
virtual void OnAVStarted (const CFileItem &file)
 
virtual void RequestVideoSettings (const CFileItem &fileItem)
 
virtual void StoreVideoSettings (const CFileItem &fileItem, CVideoSettings vs)
 

Additional Inherited Members

- Static Public Member Functions inherited from XBMCAddon::AddonClass
static short getNumAddonClasses ()
 
- Protected Member Functions inherited from XBMCAddon::AddonCallback
bool hasHandler ()
 
 AddonCallback ()
 
- Protected Member Functions inherited from XBMCAddon::AddonClass
virtual void deallocating ()
 
- Static Protected Member Functions inherited from XBMCAddon::AddonClass
static short getNextClassIndex ()
 
- Protected Attributes inherited from XBMCAddon::AddonCallback
AddonClass::Ref< CallbackHandlerhandler
 
- Protected Attributes inherited from XBMCAddon::AddonClass
LanguageHooklanguageHook
 
- Protected Attributes inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
XbmcThreads::CRecursiveMutex mutex
 
unsigned int count
 

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