Callback functions. More...

Functions
	XBMCAddon::xbmc::Player::onPlayBackStarted ()

	XBMCAddon::xbmc::Player::onAVStarted ()

	XBMCAddon::xbmc::Player::onAVChange ()

	XBMCAddon::xbmc::Player::onPlayBackEnded ()

	XBMCAddon::xbmc::Player::onPlayBackStopped ()

	XBMCAddon::xbmc::Player::onPlayBackError ()

	XBMCAddon::xbmc::Player::onPlayBackPaused ()

	XBMCAddon::xbmc::Player::onPlayBackResumed ()

	XBMCAddon::xbmc::Player::onQueueNextItem ()

	XBMCAddon::xbmc::Player::onPlayBackSpeedChanged (int speed)

	XBMCAddon::xbmc::Player::onPlayBackSeek (...)

	XBMCAddon::xbmc::Player::onPlayBackSeekChapter (...)

Detailed Description

Callback functions.

Functions to handle control callbacks from Kodi to Add-On.

Go back to normal functions from player

Function Documentation

◆ onAVChange()

void XBMCAddon::xbmc::Player::onAVChange ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onAVChange() </big></font></span></code></h4> \endhtmlonly

onAVChange method.

Will be called when Kodi has a video, audio or subtitle stream. Also happens when the stream changes.

v18 Python API changes:: New function added.

◆ onAVStarted()

void XBMCAddon::xbmc::Player::onAVStarted ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onAVStarted() </big></font></span></code></h4> \endhtmlonly

onAVStarted method.

Will be called when Kodi has a video or audiostream.

v18 Python API changes:: New function added.

◆ onPlayBackEnded()

void XBMCAddon::xbmc::Player::onPlayBackEnded ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onPlayBackEnded() </big></font></span></code></h4> \endhtmlonly

onPlayBackEnded method.

Will be called when Kodi stops playing a file.

◆ onPlayBackError()

void XBMCAddon::xbmc::Player::onPlayBackError ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onPlayBackError() </big></font></span></code></h4> \endhtmlonly

onPlayBackError method.

Will be called when playback stops due to an error.

◆ onPlayBackPaused()

void XBMCAddon::xbmc::Player::onPlayBackPaused ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onPlayBackPaused() </big></font></span></code></h4> \endhtmlonly

onPlayBackPaused method.

Will be called when user pauses a playing file.

◆ onPlayBackResumed()

void XBMCAddon::xbmc::Player::onPlayBackResumed ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onPlayBackResumed() </big></font></span></code></h4> \endhtmlonly

onPlayBackResumed method.

Will be called when user resumes a paused file.

◆ onPlayBackSeek()

void XBMCAddon::xbmc::Player::onPlayBackSeek ( ... )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onPlayBackSeek(time, seekOffset) </big></font></span></code></h4> \endhtmlonly

onPlayBackSeek method.

Will be called when user seeks to a time.

Parameters

time	[integer] Time to seek to
seekOffset	[integer] ?

◆ onPlayBackSeekChapter()

void XBMCAddon::xbmc::Player::onPlayBackSeekChapter ( ... )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onPlayBackSeekChapter(chapter) </big></font></span></code></h4> \endhtmlonly

onPlayBackSeekChapter method.

Will be called when user performs a chapter seek.

Parameters

chapter [integer] Chapter to seek to

◆ onPlayBackSpeedChanged()

void XBMCAddon::xbmc::Player::onPlayBackSpeedChanged ( int speed )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onPlayBackSpeedChanged(speed) </big></font></span></code></h4> \endhtmlonly

onPlayBackSpeedChanged method.

Will be called when players speed changes (eg. user FF/RW).

Parameters

speed [integer] Current speed of player

Note: Negative speed means player is rewinding, 1 is normal playback speed.

◆ onPlayBackStarted()

void XBMCAddon::xbmc::Player::onPlayBackStarted ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onPlayBackStarted() </big></font></span></code></h4> \endhtmlonly

onPlayBackStarted method.

Will be called when Kodi player starts. Video or audio might not be available at this point.

v18 Python API changes:: Use onAVStarted() instead if you need to detect if Kodi is actually playing a media file (i.e, if a stream is available)

◆ onPlayBackStopped()

void XBMCAddon::xbmc::Player::onPlayBackStopped ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onPlayBackStopped() </big></font></span></code></h4> \endhtmlonly

onPlayBackStopped method.

Will be called when user stops Kodi playing a file.

◆ onQueueNextItem()

void XBMCAddon::xbmc::Player::onQueueNextItem ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onQueueNextItem() </big></font></span></code></h4> \endhtmlonly

onQueueNextItem method.

Will be called when user queues the next item.