2. Stream constants

Used to exchange any additional data between the caller and processor.
This includes the standardized values, in addition, an addon can also use its own special uses to be exchanged in the same way. More...

Macros
#define	STREAM_PROPERTY_INPUTSTREAM   "inputstream"
	The name of the inputstream add-on that should be used by Kodi to play the stream.
#define	STREAM_PROPERTY_INPUTSTREAM_PLAYER   "inputstream-player"
	The name of the default player to use for this inputstream add-on that should be used by Kodi to play the stream.
#define	STREAM_PROPERTY_INPUTSTREAM_INSTANCE_ID   "inputstream-instance-id"
	Identification string for an input stream.
#define	STREAM_PROPERTY_ISREALTIMESTREAM   "isrealtimestream"
	"true" to denote that the stream that should be played is a realtime stream. Any other value indicates that this is not a realtime stream.
#define	STREAM_PROPERTY_VALUE_INPUTSTREAMFFMPEG   "inputstream.ffmpeg"
	Special value for STREAM_PROPERTY_INPUTSTREAM to use ffmpeg to directly play a stream URL.
#define	STREAM_MAX_PROPERTY_COUNT   30
	Max number of properties that can be sent to an Inputstream addon.

Detailed Description

Used to exchange any additional data between the caller and processor.
This includes the standardized values, in addition, an addon can also use its own special uses to be exchanged in the same way.

These values can be used by other addons (e.g. video addon) or stream files to select the respective inputstream addon and to transfer additional values.

---

Example:

This example use the STREAM_PROPERTY_INPUTSTREAM on a *.strm file to select needed addon and a additional value where related to selected addon itself.

#KODIPROP:inputstream=inputstream.adaptive
#KODIPROP:inputstream.adaptive.manifest_type=mpd
http://rdmedia.bbc.co.uk/dash/ondemand/testcard/1/client_manifest-events-multilang.mpd

These are then given to Kodi and the respectively selected addon by means of his Open call in kodi::addon::InputstreamProperty::GetProperties.

The largest possible amount of these #KODIPROP values is defined with STREAM_MAX_PROPERTY_COUNT.

Macro Definition Documentation

STREAM_MAX_PROPERTY_COUNT

#define STREAM_MAX_PROPERTY_COUNT   30

Max number of properties that can be sent to an Inputstream addon.

STREAM_PROPERTY_INPUTSTREAM

#define STREAM_PROPERTY_INPUTSTREAM   "inputstream"

The name of the inputstream add-on that should be used by Kodi to play the stream.

Leave blank to use Kodi's built-in playing capabilities or to allow ffmpeg to handle directly set to STREAM_PROPERTY_VALUE_INPUTSTREAMFFMPEG.

STREAM_PROPERTY_INPUTSTREAM_INSTANCE_ID

#define STREAM_PROPERTY_INPUTSTREAM_INSTANCE_ID   "inputstream-instance-id"

Identification string for an input stream.

This value can be used in addition to STREAM_PROPERTY_INPUTSTREAM. It is used to provide the respective inpustream addon with additional identification.

The difference between this and other stream properties is that it is also passed in the associated kodi::addon::CAddonBase::CreateInstance call.

This makes it possible to select different processing classes within the associated add-on.

STREAM_PROPERTY_INPUTSTREAM_PLAYER

#define STREAM_PROPERTY_INPUTSTREAM_PLAYER   "inputstream-player"

The name of the default player to use for this inputstream add-on that should be used by Kodi to play the stream.

Leave blank to use Kodi's built-in player selection mechanism. Permitted values are:

• "videodefaultplayer"
• "audiodefaultplayer"

STREAM_PROPERTY_ISREALTIMESTREAM

#define STREAM_PROPERTY_ISREALTIMESTREAM   "isrealtimestream"

"true" to denote that the stream that should be played is a realtime stream. Any other value indicates that this is not a realtime stream.

STREAM_PROPERTY_VALUE_INPUTSTREAMFFMPEG

#define STREAM_PROPERTY_VALUE_INPUTSTREAMFFMPEG   "inputstream.ffmpeg"

Special value for STREAM_PROPERTY_INPUTSTREAM to use ffmpeg to directly play a stream URL.