class PVRStreamProperty

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,
                                                     std::vector<kodi::addon::PVRStreamProperty>& properties)
{
  ...
  properties.emplace_back(PVR_STREAM_PROPERTY_INPUTSTREAM, "inputstream.adaptive");
  return PVR_ERROR_NO_ERROR;
}
 
...

Example 2:

...
 
PVR_ERROR CMyPVRInstance::GetChannelStreamProperties(const kodi::addon::PVRChannel& channel,
                                                     std::vector<kodi::addon::PVRStreamProperty>& properties)
{
  ...
  kodi::addon::PVRStreamProperty property;
  property.SetName(PVR_STREAM_PROPERTY_INPUTSTREAM);
  property.SetValue("inputstream.adaptive");
  properties.emplace_back(property);
  return PVR_ERROR_NO_ERROR;
}
 
...

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.

Note

Values must be set afterwards.

PVRStreamProperty() [2/2]

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

inline

Class constructor with integrated value set.

Parameters

[in]	name	Type identification
[in]	value	Type 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.