ToiMediaPlayerBaseStreamInfo Interface Reference

---

Description

This is the documentation for ToiMediaPlayerBaseStreamInfo.
Stream information data structure used to return generic metadata about a stream. Use toi.statics.ToiMediaPlayerBaseStreamInfo.create(<title>, <availableComponents>, <activeComponents>, <playTime>, <paces>) to create an instance of ToiMediaPlayerBaseStreamInfo. The following parameters in the create method are optional: <paces>. For the optional members that have default values, the values are: ; if they are not set from the portal, they will have the default value.

import "ToiMediaPlayerBaseStreamInfo.idl";

List of all members.

Public Attributes
attribute string	title
attribute ToiMediaPlayerBase::TToiComponentSequence	availableComponents
attribute ToiMediaPlayerBase::TToiComponentSequence	activeComponents
attribute long	playTime
attribute ToiMediaPlayerBase::TToiPaceSequence	paces

---

Member Data Documentation

attribute ToiMediaPlayerBase::TToiComponentSequence ToiMediaPlayerBaseStreamInfo::activeComponents

List of the currently active component entries.

attribute ToiMediaPlayerBase::TToiComponentSequence ToiMediaPlayerBaseStreamInfo::availableComponents

List of the currently available component entries.

attribute ToiMediaPlayerBase::TToiPaceSequence ToiMediaPlayerBaseStreamInfo::paces

Technical Preview:

This list, if not empty, specifies supported paces for ToiMediaPlayer::play() for the current stream. It is used for RTSP servers which support 'scales' parameter.

attribute long ToiMediaPlayerBaseStreamInfo::playTime

The duration of the stream in number of seconds. If the duration is unknown the value will be set to -1.

Deprecated:

The same information can be obtained from ToiMediaPlayerBasePositionInfo which is available from either ToiMediaPlayerBase::getPositionInfo() or ToiMediaPlayerPositionStatusChangedEvent.

attribute string ToiMediaPlayerBaseStreamInfo::title

The title of the stream. The string is empty if the server does not support this feature.