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

PVR stream property value handler
To set for Kodi wanted stream properties. More...

Topics

 Value Help
 

Classes

class  kodi::addon::PVRStreamProperty
 

Functions

 kodi::addon::PVRStreamProperty::PVRStreamProperty ()=default
 Default class constructor.
 
 kodi::addon::PVRStreamProperty::PVRStreamProperty (const std::string &name, const std::string &value)
 Class constructor with integrated value set.
 
void kodi::addon::PVRStreamProperty::SetName (const std::string &name)
 To set with the identification name.
 
std::string kodi::addon::PVRStreamProperty::GetName () const
 To get with the identification name.
 
void kodi::addon::PVRStreamProperty::SetValue (const std::string &value)
 To set with the used property value.
 
std::string kodi::addon::PVRStreamProperty::GetValue () const
 To get with the used property value.
 

Detailed Description

PVR stream property value handler
To set for Kodi wanted stream properties.


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

Name Type Set call Get call
Name int SetName GetName
Value std::string SetValue GetValue
Remarks
Further can there be used his class constructor to set values.

Example:

...
PVR_ERROR CMyPVRInstance::GetChannelStreamProperties(const kodi::addon::PVRChannel& channel,
PVR_SOURCE source,
std::vector<kodi::addon::PVRStreamProperty>& properties)
{
...
properties.emplace_back(PVR_STREAM_PROPERTY_INPUTSTREAM, "inputstream.adaptive");
}
...
Definition Channels.h:39
@ PVR_ERROR_NO_ERROR
0 : No error occurred.
Definition pvr_general.h:38
PVR_SOURCE
Definition pvr_general.h:127
#define PVR_STREAM_PROPERTY_INPUTSTREAM
To define in stream properties the name of the inputstream add-on that should be used.
Definition pvr_general.h:235

Example 2:

...
PVR_ERROR CMyPVRInstance::GetChannelStreamProperties(const kodi::addon::PVRChannel& channel,
PVR_SOURCE source,
std::vector<kodi::addon::PVRStreamProperty>& properties)
{
...
property.SetValue("inputstream.adaptive");
properties.emplace_back(property);
}
...
Definition kodi-dev-kit/include/kodi/addon-instance/pvr/General.h:1440
void SetName(const std::string &name)
To set with the identification name.
Definition kodi-dev-kit/include/kodi/addon-instance/pvr/General.h:1476

Function Documentation

◆ GetName()

std::string kodi::addon::PVRStreamProperty::GetName ( ) const
inline

To get with the identification name.

◆ GetValue()

std::string kodi::addon::PVRStreamProperty::GetValue ( ) const
inline

To get with the used property value.

◆ PVRStreamProperty() [1/2]

kodi::addon::PVRStreamProperty::PVRStreamProperty ( )
default

Default class constructor.

◆ PVRStreamProperty() [2/2]

kodi::addon::PVRStreamProperty::PVRStreamProperty ( const std::string & name,
const std::string & value )
inline

Class constructor with integrated value set.

Parameters
[in]nameType identification
[in]valueType used property value

◆ SetName()

void kodi::addon::PVRStreamProperty::SetName ( const std::string & name)
inline

To set with the identification name.

◆ SetValue()

void kodi::addon::PVRStreamProperty::SetValue ( const std::string & value)
inline

To set with the used property value.