Kodi Docs 20.0
Kodi is an open source media player and entertainment hub.
Modules | Classes | Functions
class InputstreamCapabilities
C++ » Interface - kodi::addon » Addon type instances » Inputstream » Definitions, structures and enumerators » 1. Interface

InputStream add-on capabilities. All capabilities are set to "false" as default.
Asked to addon on GetCapabilities. More...

Modules

 Value Help
 

Classes

class  kodi::addon::InputstreamCapabilities
 

Functions

void kodi::addon::InputstreamCapabilities::SetMask (uint32_t mask) const
 Set of supported capabilities. More...
 
uint32_t kodi::addon::InputstreamCapabilities::GetMask () const
 Get of supported capabilities. More...
 
enum  INPUTSTREAM_MASKTYPE {
  INPUTSTREAM_SUPPORTS_IDEMUX = (1 << 0) , INPUTSTREAM_SUPPORTS_IPOSTIME = (1 << 1) , INPUTSTREAM_SUPPORTS_IDISPLAYTIME = (1 << 2) , INPUTSTREAM_SUPPORTS_SEEK = (1 << 3) ,
  INPUTSTREAM_SUPPORTS_PAUSE = (1 << 4) , INPUTSTREAM_SUPPORTS_ITIME = (1 << 5) , INPUTSTREAM_SUPPORTS_ICHAPTER = (1 << 6)
}
 Capability types of inputstream addon.
This values are needed to tell Kodi which options are supported on the addon. More...
 

Detailed Description

InputStream add-on capabilities. All capabilities are set to "false" as default.
Asked to addon on GetCapabilities.

The following table contains values that can be set with class InputstreamCapabilities :

Name Type Set call Get call
Capabilities bit mask uint32_t SetMask GetMask

Enumeration Type Documentation

◆ INPUTSTREAM_MASKTYPE

enum INPUTSTREAM_MASKTYPE

Capability types of inputstream addon.
This values are needed to tell Kodi which options are supported on the addon.

If one of this is defined, then the corresponding methods from kodi::addon::CInstanceInputStream need to be implemented.

Used on kodi::addon::CInstanceInputStream::GetCapabilities().

Enumerator
INPUTSTREAM_SUPPORTS_IDEMUX 

0000 0000 0000 0001 : Supports interface demuxing. 

If set must be @ref cpp_kodi_addon_inputstream_Demux "Demux support" included.
INPUTSTREAM_SUPPORTS_IPOSTIME 

0000 0000 0000 0010 : Supports interface position time. 

This means that the start time and the current stream time are used.

If set must be @ref cpp_kodi_addon_inputstream_Time "Time support" included.
INPUTSTREAM_SUPPORTS_IDISPLAYTIME 

0000 0000 0000 0100 : Supports interface for display time. 

This will call up the complete stream time information. The start time
and the individual PTS times are then given using @ref cpp_kodi_addon_inputstream_Defs_Times.

If set must be @ref cpp_kodi_addon_inputstream_Times "Times support" included.
INPUTSTREAM_SUPPORTS_SEEK 

0000 0000 0000 1000 : Supports seek

INPUTSTREAM_SUPPORTS_PAUSE 

0000 0000 0001 0000 : Supports pause

INPUTSTREAM_SUPPORTS_ITIME 

0000 0000 0010 0000 : Supports interface to give position time. 

This will only ask for the current time of the stream, not for length or
start.

If set must be @ref cpp_kodi_addon_inputstream_PosTime "Position time support" included.
INPUTSTREAM_SUPPORTS_ICHAPTER 

0000 0000 0100 0000 : Supports interface for chapter selection. 

If set must be @ref cpp_kodi_addon_inputstream_Chapter "Chapter support" included.

Function Documentation

◆ GetMask()

uint32_t kodi::addon::InputstreamCapabilities::GetMask ( ) const
inline

Get of supported capabilities.

◆ SetMask()

void kodi::addon::InputstreamCapabilities::SetMask ( uint32_t  mask) const
inline

Set of supported capabilities.