Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches

Data to manage stream cryptography
This class structure manages any encryption values required in order to have them available in their stream processing. More...

Topics

 Value Help
 

Classes

class  kodi::addon::StreamCryptoSession
 

Functions

void kodi::addon::StreamCryptoSession::SetKeySystem (STREAM_CRYPTO_KEY_SYSTEM keySystem)
 To set keysystem for encrypted media, STREAM_CRYPTO_KEY_SYSTEM_NONE for unencrypted media.
 
STREAM_CRYPTO_KEY_SYSTEM kodi::addon::StreamCryptoSession::GetKeySystem () const
 Get keysystem for encrypted media.
 
void kodi::addon::StreamCryptoSession::SetFlags (uint8_t flags)
 Set bit flags to use special conditions, see STREAM_CRYPTO_FLAGS for available flags.
 
uint8_t kodi::addon::StreamCryptoSession::GetFlags () const
 Get flags for special conditions.
 
void kodi::addon::StreamCryptoSession::SetSessionId (const std::string &sessionId)
 To set the crypto session key identifier.
 
std::string kodi::addon::StreamCryptoSession::GetSessionId () const
 To get the crypto session key identifier.
 

Detailed Description

Data to manage stream cryptography
This class structure manages any encryption values required in order to have them available in their stream processing.

Used on inputstream by kodi::addon::InputstreamInfo::SetCryptoSession / kodi::addon::InputstreamInfo::GetCryptoSession and are given to the used video codec to decrypt related data.


The following table contains values that can be set with cpp_kodi_addon_inputstream_Defs_Info_StreamCryptoSession :

Name Type Set call Get call
Keysystem for encrypted media STREAM_CRYPTO_KEY_SYSTEM SetKeySystem GetKeySystem
Flags for special conditions uint8_t SetFlags GetFlags
Crypto session key id std::string SetSessionId GetSessionId

Function Documentation

◆ GetFlags()

uint8_t kodi::addon::StreamCryptoSession::GetFlags ( ) const
inline

Get flags for special conditions.

◆ GetKeySystem()

STREAM_CRYPTO_KEY_SYSTEM kodi::addon::StreamCryptoSession::GetKeySystem ( ) const
inline

Get keysystem for encrypted media.

◆ GetSessionId()

std::string kodi::addon::StreamCryptoSession::GetSessionId ( ) const
inline

To get the crypto session key identifier.

◆ SetFlags()

void kodi::addon::StreamCryptoSession::SetFlags ( uint8_t flags)
inline

Set bit flags to use special conditions, see STREAM_CRYPTO_FLAGS for available flags.

◆ SetKeySystem()

void kodi::addon::StreamCryptoSession::SetKeySystem ( STREAM_CRYPTO_KEY_SYSTEM keySystem)
inline

To set keysystem for encrypted media, STREAM_CRYPTO_KEY_SYSTEM_NONE for unencrypted media.

See STREAM_CRYPTO_KEY_SYSTEM for available options.

◆ SetSessionId()

void kodi::addon::StreamCryptoSession::SetSessionId ( const std::string & sessionId)
inline

To set the crypto session key identifier.