Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages

Used to get available chapters. More...

Functions

virtual int kodi::addon::CInstanceInputStream::GetChapter ()
 Return currently selected chapter.
 
virtual int kodi::addon::CInstanceInputStream::GetChapterCount ()
 Return number of available chapters.
 
virtual const char * kodi::addon::CInstanceInputStream::GetChapterName (int ch)
 Return name of chapter.
 
virtual int64_t kodi::addon::CInstanceInputStream::GetChapterPos (int ch)
 Return position if chapter # ch in milliseconds.
 
virtual bool kodi::addon::CInstanceInputStream::SeekChapter (int ch)
 Seek to the beginning of chapter # ch.
 

Detailed Description

Used to get available chapters.

Note
These are used and must be set by the addon if the INPUTSTREAM_SUPPORTS_ICHAPTER is set in the capabilities (see GetCapabilities()).

Function Documentation

◆ GetChapter()

virtual int kodi::addon::CInstanceInputStream::GetChapter ( )
inlinevirtual

Return currently selected chapter.

Returns
Chapter number
Remarks

◆ GetChapterCount()

virtual int kodi::addon::CInstanceInputStream::GetChapterCount ( )
inlinevirtual

Return number of available chapters.

Returns
Chapter count
Remarks

◆ GetChapterName()

virtual const char * kodi::addon::CInstanceInputStream::GetChapterName ( int ch)
inlinevirtual

Return name of chapter.

Parameters
[in]chChapter identifier
Returns
Chapter name
Remarks

◆ GetChapterPos()

virtual int64_t kodi::addon::CInstanceInputStream::GetChapterPos ( int ch)
inlinevirtual

Return position if chapter # ch in milliseconds.

Parameters
[in]chChapter to get position from
Returns
Position in milliseconds
Remarks

◆ SeekChapter()

virtual bool kodi::addon::CInstanceInputStream::SeekChapter ( int ch)
inlinevirtual

Seek to the beginning of chapter # ch.

Parameters
[in]chChapter to seek
Returns
True if successfully done, false if not
Remarks