ToiMediaPlayer Interface Reference

Active format descriptor used to identify the active video format provided in the ToiMediaPlayerBaseVideoStreamInfo structure.

Aspect ratio identifier used to identify the video aspect ratio provided in the ToiMediaPlayerBaseVideoStreamInfo structure.

Audio type identifier used to identify the audio type provided in the ToiMediaPlayerBaseAudioStreamInfo structure.

The audio channel format specifies the number of channels and desired speaker setup.

The audio channel mode specifies audio channel to speaker mappings.

List of media component entries

Media component identifier types used to set and get information about media components of a session.

Enumeration of various sources that can cause an OnError event to occur. Typically, this can be a streamer element or similar low-level component.

Technical Preview:

List of supported paces

Receive DMF mode used for ARIB CC/CS

Receive DMF mode used for ARIB CC/CS

Enumeration of media player states.

Subtitle format identifier used to identify the subtitle format provided in the ToiMediaPlayerBaseSubtitleStreamInfo structure.

Subtitle type identifier used to identify the subtitle type provided in the ToiMediaPlayerBaseSubtitleStreamInfo structure.

State identifier used to identify the media player timeshift state.

This function selects a media component to be used. The player state is not affected.

Parameters:

mediaComponent

The media component entry to be activated.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiInvalidArgumentException	If the component argument does not identify a valid component, an invalid argument exception is raised.
	TToiUnavailableException	TToiUnavailableException is raised if the player is temporarily unavailable due to platform resource management.

See also:

ToiMediaPlayer::getComponentInfo()

This method registers an event listener for a specific event. Multiple listeners can be added for the same event. Events are broadcast to all registered listeners.

Parameters:

	type	The event type of the event to subscribe to.
	listener	The JavaScript function that will receive events.

Exceptions:

TInvalidArgumentException

Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the application calls addEventListener with the same combination of type and listener twice.

This function ends the current session by stopping any playback and disconnecting from the media source. For example, if the source is a video server it ends the server session and disconnects, or if the source is a multicast channel it leaves that multicast group. If this function returns successfully, the player state will change to STATE_IDLE. If an exception is raised, the player state is unaffected.

Exceptions:

	TToiSessionViolationException	If the player is in idle state a session violation exception is raised.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

See also:

ToiMediaPlayer::open()

TToiState

This function deactivates a media component type.

Parameters:

mediaType

The media component type to be deactivated.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiInvalidArgumentException	Raised if the component argument does not identify a valid component.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

Discards the timeshift buffer and resumes live stream playback, if not already playing live. This disables further timeshift operations. If this function returns successfully, the timeshift state has changed to TIMESHIFT_STATE_INACTIVE.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiInvalidPreconditionException	If the timeshift state is not TIMESHIFT_STATE_STOPPED or TIMESHIFT_STATE_BUFFERING_FAILED an invalid precondition exception is raised.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

This function returns the selected media components currently selected.

Deprecated:

Same information can be obtained by using GetStreamInfo().

Return values:

components

The media component entries currently selected.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

Returns information about a specified audio stream in the current media stream multiplex in the form of an audio stream info structure.

Parameters:

mediaComponent

The media component entry for which the stream info has to be retrieved.

Return values:

streamInfo

Information about the specified audio stream.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiInvalidArgumentException	If the mediaComponent given as argument does not identify an audio stream in the current stream multiplex, an invalid argument exception is raised.
	TToiUnavailableException	TToiUnavailableException is raised if the player is temporarily unavailable due to platform resource management.

Returns the capabilities present for the current session.

Return values:

capabilityMask

A bit mask describing the capabilities of the current session. The mask can include the following capabilities: Bit 0: ToiMediaPlayerBase::CAPABILITY_PAUSE Bit 1: ToiMediaPlayerBase::CAPABILITY_REWIND Bit 2: ToiMediaPlayerBase::CAPABILITY_FASTFORWARD Bit 3: ToiMediaPlayerBase::CAPABILITY_GETPOSITION Bit 4: ToiMediaPlayerBase::CAPABILITY_SETPOSITION Bit 5: ToiMediaPlayerBase::CAPABILITY_FREEZE Bit 6: ToiMediaPlayerBase::CAPABILITY_TIMESHIFT

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiUnavailableException	TToiUnavailableException is raised if the player is temporarily unavailable due to platform resource management.

Returns the last error. This is typically called when state is changed to STATE_FAILED. The result is undefined if no error has occurred.

Return values:

error

The error

Returns the current pace that the media stream is played with.

Return values:

pace

The pace at which the position changes, given as a multiplier of normal playback times 1000. If the stream is paused the pace is zero. When the stream is played at normal speed the pace is 1000. In STATE_FASTFORWARDING the pace is generally above 1000, and in STATE_REWINDING generally below -1000. For example, if the stream is rewinded at a pace three times normal playback, the pace is -3000.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiOperationNotSupportedException	If the session lacks the capability to get position, the operation not supported exception is raised.
	TToiUnavailableException	TToiUnavailableException is raised if the player is temporarily unavailable due to platform resource management.

Get the current value of a parameter.

Parameters:

name

Name of the requested parameter.

Return values:

value

The current value of the parameter.

Exceptions:

	TToiInvalidArgumentException	The parameter name is invalid or not recognized.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

See also:

ToiMediaPlayer::setParameter()

ToiMediaPlayer::unsetParameter()

ToiMediaPlayerBase::subscribeParameter()

Returns the current position in the media stream.

Return values:

position

The current position in milliseconds. If asset start is 0, relative position from start is equal to current position. Otherwise, relative position from start is current position - asset start.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiOperationNotSupportedException	If the session lacks the capability to get position, the operation not supported exception is raised.
	TToiUnavailableException	TToiUnavailableException is raised if the player is temporarily unavailable due to platform resource management.

Returns the session identifier. This identifier can be used to open a session object with (C++) ToiMediaService::OpenSession().

Return values:

id

The session identifier.

Exceptions:

TToiSessionViolationException

If the player is in STATE_IDLE a session violation exception is raised.

See also:

ToiMediaService::openSession()

Returns the current state of the media player instance.

Return values:

state

The current player state.

Returns information about the current stream in form of a stream info structure. The lists of audio and video streams provided as parts of this information can be used for further exploration using the ToiMediaPlayerBase::getAudioStreamInfo() and ToiMediaPlayerBase::getVideoStreamInfo() functions, respectively.

Return values:

streamInfo

Information about the current stream.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiUnavailableException	TToiUnavailableException is raised if the player is temporarily unavailable due to platform resource management.

Returns information about a specified subtitle stream in the current media stream multiplex in the form of a subtitle stream info structure.

Parameters:

mediaComponent

The media component entry for which the stream info has to be retrieved.

Return values:

streamInfo

Information about the specified subtitle stream.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiInvalidArgumentException	If the streamId given as argument does not identify a subtitle stream in the current stream multiplex, an invalid argument exception is raised.
	TToiUnavailableException	TToiUnavailableException is raised if the player is temporarily unavailable due to platform resource management.

Returns information about a specified teletext stream in the current media stream multiplex in the form of a teletext stream info structure.

Parameters:

mediaComponent

The media component entry for which the stream info has to be retrieved.

Return values:

streamInfo

Information about the specified teletext stream.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiInvalidArgumentException	If the mediaComponent given as argument does not identify a teletext stream in the current stream multiplex, an invalid argument exception is raised.
	TToiUnavailableException	TToiUnavailableException is raised if the player is temporarily unavailable due to platform resource management.

Returns the last timeshift error. This is typically called after a state change to TIMESHIFT_STATE_BUFFERING_FAILED. The result is undefined if no error has occurred.

Return values:

timeshiftError

The error.

Retrieve information about the current timeshift operation.

Return values:

timeshiftInfo

Information about the current timeshift operation.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

Returns the URL for the media stream.

Return values:

url

The URL for the media stream.

Exceptions:

TToiSessionViolationException

If the player is in STATE_IDLE a session violation exception is raised.

Returns information about a specified video stream in the current media stream multiplex in the form of a video stream info structure.

Parameters:

mediaComponent

The media component entry for which the stream info has to be retrieved.

Return values:

streamInfo

Information about the specified video stream.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiInvalidArgumentException	If the mediaComponent given as argument does not identify a video stream in the current stream multiplex, an invalid argument exception is raised.
	TToiUnavailableException	TToiUnavailableException is raised if the player is temporarily unavailable due to platform resource management.

Returns true if the player is playing from the timeshift buffer.

Return values:

timeshiftPlayback

True if the player is playing from the timeshift buffer, otherwise false.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

This function starts a new stream session by trying to establish a connection to a media source. If this function returns successfully, the player state will change to STATE_CONNECTING. If an exception is raised, the player state is unaffected.

Depending on the success of the connection attempt to the media source, the player will make a second state transition to either STATE_PAUSED or STATE_FAILED, on success and failure, respectively. In any respect, the application will be notified with the event ToiMediaPlayerStateChangedEvent.

Parameters:

url

The URL identifying the media source. The URL string may contain additional parameter information in accordance to the extended URL format.

Exceptions:

	TToiSessionViolationException	If the player is not in idle state at the time of the call to ToiMediaPlayer::open(), a session violation exception is raised.
	TToiInvalidArgumentException	If the URL given as argument does not follow the extended URL format, an invalid argument exception is raised.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

See also:

ToiMediaPlayer::close()

TToiState

This function controls playback of the stream. If this function returns successfully, the player state will change to one of four states: STATE_PLAYING, STATE_PAUSED, STATE_FASTFORWARDING, and STATE_REWINDING. Different values pace result one of these different states with the corresponding effect. In the case of pausing, it keeps the session alive, i.e. it remains connected to video servers and joined in multicast groups. If an exception is raised, the player state is unaffected.

Parameters:

pace

The pace at which the position will change, given as a multiplier of normal playback times 1000. Zero will pause the stream. 1000 is normal speed (playing). Values above 1000 will result in fast forward, and below -1000 will result in rewind. This are desired paces, the actual implementation may not set the desired speed, but the different states will change according to this description.

Exceptions:

	TToiSessionViolationException	Raised if the player does not have an active session and will not have one soon (due to a recent call to Open) either.
	TToiOperationNotSupportedException	If the player is in a state is which this operation is not supported, an operation not supported exception is raised. This is the case when in STATE_FAILED, for example. What is supported in which state may in other cases vary depending on which media source is used.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

See also:

ToiMediaPlayer::open()

TToiState

This function moves the playback position of the current stream and resumes playback at the new position with the desired pace. Streams without a well defined notion of beginning and end, like multicast channels, generally do not support this operation. A position value greater than the length of the stream will be clamped.

If this function returns successfully, the player state will change to one of four states: STATE_PLAYING, STATE_PAUSED, STATE_FASTFORWARDING, and STATE_REWINDING. Different values of pace results in the different states. In the case of pausing, it keeps the session alive, i.e. it remains connected to the video server or the joined in multicast group. If an exception is raised, the player state is unaffected.

Parameters:

position

The position, specified as the number of milliseconds from the beginnig of the stream, to which the playback position is to be moved. The length of the stream can be obtained by calling the ToiMediaPlayer::getStreamInfo() function.

When playing from the timeshift buffer, the constant POSITION_LIVE can be used to stop buffer playback and start playback of the live stream.

Parameters:

pace

The pace at which the position will change, given as a multiplier of normal playback times 1000. Zero will pause the stream. 1000 is normal speed (playing). Values above 1000 will result in fast forward, and below -1000 will result in rewind. This are desired paces, the actual implementation may not set the desired speed, but the different states will change according to this description.

Exceptions:

	TToiSessionViolationException	Raised if the player does not have an active session and will not have one soon (due to a recent call to Open) either .
	TToiOperationNotSupportedException	If the player is in a state is which this operation is not supported, an operation not supported exception is raised. This is the case when in STATE_FAILED, for example. What is supported in which state may in other cases vary depending on which media source is used. The client may investigate this in advance by checking capabilities with ToiMediaPlayer::getCapabilities().
	TToiInvalidArgumentException	Raised if the position is negative.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

This function releases the resources used by this instance. When this function returns all observers has also been released.

This method removes an event listener for a specific event.

Parameters:

	type	The event type of the event to remove the listener from.
	listener	The JavaScript function that was previously added as an event listener.

Exceptions:

TInvalidArgumentException

Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the listener had not previously been added.

Technical Preview:

This method is a TECHNICAL PREVIEW, it may change.

This function sets the audio channel mode for a given stream identifier. For the active stream the mode will be set instantly.

Parameters:

	streamId	The audio stream identifier.
	channelMode	The audio channel mode.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiInvalidArgumentException	An invalid argument exception is raised if the stream identifier argument does not identify a valid audio stream or the channel mode is not supported.

This function sets the value of a parameter. Depending on the current state, the new value is used differently. If the function is called when in idle state, the new value is used for all sessions started after the parameter is set. If the function is called in any other state but the idle state, the new value is applied to that session only and is discarded automatically when the session ends.

Parameters:

	name	The name of the parameter to set.
	value	The value to set the parameter to.

Exceptions:

	TToiInvalidArgumentException	The parameter name is invalid or not recognized.
	TToiPermissionDeniedException	The application does not have permission to change the value of the parameter.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

See also:

ToiMediaPlayer::unsetParameter()

ToiMediaPlayer::getParameter()

Starts background buffering of the currently viewed stream and therefore enables timeshift operations. The media player will continue to display the live stream until either pause or rewind is performed. The timeshift buffering is stopped either by an excplicit call to ToiMediaPlayer::stopTimeshiftBuffering() or when the buffer is full. Timeshift operations are disabled by calling ToiMediaPlayer::discardTimeshiftBuffer(). If this function returns successfully, the timeshift state has changed to TIMESHIFT_STATE_BUFFERING. The media player should be in STATE_PLAYING when calling this.

Parameters:

maxBufferLength

The maximum size of the timeshift buffer in seconds.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiInvalidArgumentException	If maxBufferLength is <= 0 an invalid argument exception is raised.
	TToiInvalidPreconditionException	If the timeshift state is not TIMESHIFT_STATE_INACTIVE or the media player is not in STATE_PLAYING then an invalid precondition exception is raised.
	TToiOperationNotSupportedException	If the current media source does not have the timeshift capability an operation not supported exception is raised.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

Stops the timeshift buffering but preserves the content in the buffer until the function ToiMediaPlayer::discardTimeshiftBuffer() is called. The player will continue to play from the current media source. If this function returns successfully, the timeshift state has changed to TIMESHIFT_STATE_STOPPED.

Exceptions:

	TToiSessionViolationException	If the player is in STATE_IDLE a session violation exception is raised.
	TToiInvalidPreconditionException	If the timeshift state is not TIMESHIFT_STATE_BUFFERING an invalid precondition exception is raised.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

This function makes the application subscribe to updates of a specific named parameter. When the subscription is made there will be an immediate call to ToiMediaPlayerParameterChangedEvent if there is a value available.

Parameters:

	eventListener	ToiEventListener
	name	The name of the parameter for which changes the application wants to subscribe to.

Exceptions:

	TToiInvalidArgumentException	The parameter name is invalid or not recognized.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

See also:

ToiMediaPlayerBase::unsubscribeParameter()

This function restores the value of a parameter to the default. Depending on the current state, the new value is used differently. If the function is called when in idle state, all sessions started after the parameter is restored will use the default value. If the function is called in any other state but the idle state, the value is changed for that session only.

Parameters:

name

The name of the parameter for which the value is to be restored to the default.

Exceptions:

	TToiInvalidArgumentException	The parameter name is invalid or not recognized.
	TToiPermissionDeniedException	The application does not have permission to change the value of the parameter.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

See also:

ToiMediaPlayer::setParameter(), ToiMediaPlayer::getParameter()

This function undoes the effect of a previous call to ToiMediaPlayerBase::subscribeParameter().

Parameters:

	eventListener	ToiEventListener
	name	The name of the parameter that the application is no longer interested in.

Exceptions:

	TToiInvalidArgumentException	The parameter name is invalid or not recognized.
	TToiUnavailableException	Raised if the player is temporarily unavailable due to platform resource management.

See also:

ToiMediaPlayerBase::subscribeParameter()

The active format descriptor is 14:9 centre.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ACTIVE_FORMAT_14_9_CENTRE.

The active format descriptor is 14:9 top.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ACTIVE_FORMAT_14_9_TOP.

The active format descriptor is 16:9 centre.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ACTIVE_FORMAT_16_9_CENTRE.

The active format descriptor is 16:9 with shoot and protect 14:9 centre.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ACTIVE_FORMAT_16_9_SHOOT_AND_PROTECT_14_9_CENTRE.

The active format descriptor is 16:9 with shoot and protect 4:3 centre.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ACTIVE_FORMAT_16_9_SHOOT_AND_PROTECT_4_3_CENTRE.

The active format descriptor is 16:9 top.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ACTIVE_FORMAT_16_9_TOP.

The active format descriptor is 4:3 centre.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ACTIVE_FORMAT_4_3_CENTRE.

The active format descriptor is 4:3 with shoot and protect 14:9 centre.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ACTIVE_FORMAT_4_3_SHOOT_AND_PROTECT_14_9_CENTRE.

The active format descriptor is > 16:9 centre.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ACTIVE_FORMAT_MORE_THAN_16_9_CENTRE.

The active format descriptor is same as coded.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ACTIVE_FORMAT_SAME_AS_CODED.

The active format descriptor is not known.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ACTIVE_FORMAT_UNKNOWN.

The aspect ratio is 16:9

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ASPECT_RATIO_16_9.

The aspect ratio is 4:3

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ASPECT_RATIO_4_3.

The aspect ratio is not known.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ASPECT_RATIO_UNKNOWN.

The audio is prepared for the hearing impaired.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_AUDIENCE_TYPE_HEARING_IMPAIRED.

The audio is prepared for normal audiance.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_AUDIENCE_TYPE_NORMAL.

The audience type of the audio is not known.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_AUDIENCE_TYPE_UNKNOWN.

The audio is prepared for the visually impaired.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_AUDIENCE_TYPE_VISUALLY_IMPAIRED.

Four audio channels. Three front and one back speakers.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_CHANNEL_FORMAT_3_FRONT_1_BACK.

Five audio channels. Three front and two back speakers.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_CHANNEL_FORMAT_3_FRONT_2_BACK.

Five audio channels. Three front and two back speakers. One low frequency effects channel (LFE). One subwoofer speaker.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_CHANNEL_FORMAT_3_FRONT_2_BACK_LFE.

Seven audio channels. Three front, two side and two back speakers. One low frequency effects channel (LFE). One subwoofer speaker.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_CHANNEL_FORMAT_3_FRONT_2_SIDE_2_BACK_LFE.

Two content separate audio channels. Either one or two speakers.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_CHANNEL_FORMAT_DUAL_MONO.

One audio channel. One speaker.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_CHANNEL_FORMAT_SINGLE_MONO.

Two audio channels. Two front speakers.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_CHANNEL_FORMAT_STEREO.

The audio channel format is not known.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_CHANNEL_FORMAT_UNKNOWN.

The dual mono mode where the left channel is sent to both left and right front speaker outputs.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_CHANNEL_MODE_DUAL_MONO_LEFT_ONLY.

The dual mono mode where the left and right channels are mixed and sent to both left and right front speaker outputs

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_CHANNEL_MODE_DUAL_MONO_MIXED.

The dual mono mode where the right channel is sent to both left and right front speaker outputs.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_CHANNEL_MODE_DUAL_MONO_RIGHT_ONLY.

The dual mono mode where the left channel is sent to the left front speaker output and the right channel is sent to the right front speaker output

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_CHANNEL_MODE_DUAL_MONO_STEREO.

The normal mode where each channel is sent to its speaker output.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.AUDIO_CHANNEL_MODE_NORMAL.

When this bit is set the session accepts the ToiMediaPlayer::Play([pace > 0]) command.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.CAPABILITY_FASTFORWARD.

When this bit is set the session accepts the ToiMediaPlayer::Play(PACE_PAUSE) command. Freeze is similar to pause, except that when resuming a frozen session it will continue from the current live position.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.CAPABILITY_FREEZE.

When this bit is set the session provides a position value which the client may read with ToiMediaPlayerBase::getPosition() and similar commands.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.CAPABILITY_GETPOSITION.

When this bit is set the session accepts the ToiMediaPlayer::Play(PACE_PAUSE) command. When a paused session is resumed it will continue playing from the position where the pause occured. This is similar to freeze.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.CAPABILITY_PAUSE.

When this bit is set the session accepts the ToiMediaPlayer::Play([pace < 0]) command.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.CAPABILITY_REWIND.

When this bit is set the session accepts the position to be set ToiMediaPlayer::playFromPosition().

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.CAPABILITY_SETPOSITION.

When this bit is set the session can perform timeshift buffering.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.CAPABILITY_TIMESHIFT.

Audio components have information of type ToiMediaPlayerBaseAudioStreamInfo.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.COMPONENT_AUDIO.

Denotes a regular subtitling component.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.COMPONENT_SUBTITLE.

Technical Preview:

This enumerator is a TECHNICAL PREVIEW, it may change. This is an ARIB specific type of subtitles.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.COMPONENT_SUBTITLE_CAPTION.

Technical Preview:

This enumerator is a TECHNICAL PREVIEW, it may change. This is an ARIB specific type of subtitles and used mainly for displaying alert messages on screen.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.COMPONENT_SUBTITLE_SUPERIMPOSE.

Technical Preview:

This enumerator is a TECHNICAL PREVIEW, it may change. Teletext VBI component have information of type ToiMediaPlayerBaseTeletextStreamInfo.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.COMPONENT_TELETEXT_VBI.

Video components have information of type ToiMediaPlayerBaseVideoStreamInfo.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.COMPONENT_VIDEO.

This is an Event identifier for ToiMediaPlayerActiveComponentChangedEvent.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ON_ACTIVE_COMPONENT_CHANGED.

This is an Event identifier for ToiMediaPlayerCapabilitiesChangedEvent.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ON_CAPABILITIES_CHANGED.

This is an Event identifier for ToiMediaPlayerDataAvailableEvent.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ON_DATA_AVAILABLE.

This is an Event identifier for ToiMediaPlayerParameterChangedEvent.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ON_PARAMETER_CHANGED.

This is an Event identifier for ToiMediaPlayerPositionChangedEvent.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ON_POSITION_CHANGED.

This is an Event identifier for ToiMediaPlayerStateChangedEvent.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ON_STATE_CHANGED.

This is an Event identifier for ToiMediaPlayerStreamInfoChangedEvent.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ON_STREAM_INFO_CHANGED.

This is an Event identifier for ToiMediaPlayerTimeshiftStateChangedEvent.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.ON_TIMESHIFT_STATE_CHANGED.

Predefined argument value for ToiMediaPlayer::play(). Indicates that the player should play with a normal fast forward speed.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.PACE_FASTFORWARD.

Predefined argument value for ToiMediaPlayer::play(). Indicates that the player should be paused.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.PACE_PAUSE.

Predefined argument value for ToiMediaPlayer::play(). Indicates that the player should play with normal speed.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.PACE_PLAY.

Predefined argument value for ToiMediaPlayer::play(). Indicates that the player should play with a normal rewind speed.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.PACE_REWIND.

Predefined argument value for ToiMediaPlayer::playFromPosition(). Indicates that the player should stop playing from the timeshift buffer and instead start playback of the live stream.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.POSITION_LIVE.

Automatic mode.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.RECEIVE_DMF_MODE_AUTO.

Non-automatic mode.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.RECEIVE_DMF_MODE_NON_AUTO.

Select mode.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.RECEIVE_DMF_MODE_SELECT.

Special mode.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.RECEIVE_DMF_MODE_SPECIAL.

Automatic mode.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.RECORD_DMF_MODE_AUTO.

Non-automatic mode.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.RECORD_DMF_MODE_NON_AUTO.

Select mode.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.RECORD_DMF_MODE_SELECT.

SOURCE_BITBAND - A BitBand element has failed for some reason.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.SOURCE_BITBAND.

SOURCE_INTERNAL - An internal failure occured before an error code could be retrieved.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.SOURCE_INTERNAL.

SOURCE_UNKNOWN - An error of unknown type has occurred.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.SOURCE_UNKNOWN.

In STATE_CONNECTING the media player has an active session and is in the process of establishing a connection to a media stream source. The media player will leave this state automatically and enter STATE_PAUSED when it has successfully established the connection to the stream source. If the media player decides it cannot connect, it will enter STATE_FAILED instead. If the application is not interrested in knowing when the player has connected, it may call ToiMediaPlayer::play() to set the player in STATE_PLAYING directly. The application may also end the session by calling ToiMediaPlayer::close(), which makes the player go to STATE_IDLE.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.STATE_CONNECTING.

In STATE_FAILED the media player may or may not have a connection to a media source but the process of getting the stream from that source has failed in some fatal way. The media player will only leave STATE_FAILED on a call by the application to ToiMediaPlayer::close().

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.STATE_FAILED.

In STATE_FASTFORWARDING the media player has a connection to a media source and plays the stream from that source in forward direction at a pace above normal playback. For streams on which this operation cannot be performed, this state is not available. On a command from the application, the player will leave this state for one of the other playback states STATE_PLAYING, STATE_PAUSED, or STATE_REWINDING. The application may also end the session by calling ToiMediaPlayer::close(), which makes the player go to STATE_IDLE. If an error occurs with the stream severe enough for the player to determine it cannot continue playback, the player will go to STATE_FAILED.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.STATE_FASTFORWARDING.

In STATE_IDLE there is no active session. The media player does not handle a stream, and consequently has no connection to a media stream source. All functions requiring a session will raise a TToiSessionViolationException in STATE_IDLE. The media player will only leave STATE_IDLE on a successful call to ToiMediaPlayer::open().

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.STATE_IDLE.

In STATE_PAUSED the media player has a connection to a media source but playback is halted. On a command from the application, the player will leave this state for one of the other playback states STATE_PLAYING, STATE_FASTFORWARDING, or STATE_REWINDING. The application may also end the session by calling ToiMediaPlayer::close(), which makes the player go to STATE_IDLE. If an error occurs with the stream severe enough for the player to determine it cannot continue playback, the player will go to STATE_FAILED.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.STATE_PAUSED.

In STATE_PLAYING the media player has a connection to a media source and plays the stream from that source in normal pace. On a command from the application, the player will leave this state for one of the other playback states STATE_PAUSED, STATE_FASTFORWARDING, or STATE_REWINDING. The application may also end the session by calling ToiMediaPlayer::close(), which makes the player go to STATE_IDLE. If an error occurs with the stream severe enough for the player to determine it cannot continue playback, the player will go to STATE_FAILED.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.STATE_PLAYING.

In STATE_REWINDING the media player has a connection to a media source and plays the stream from that source in backward direction at a pace above normal playback. For streams on which this operation cannot be performed, this state is not available. On a command from the application, the player will leave this state for one of the other playback states STATE_PLAYING, STATE_PAUSED, or STATE_FASTFORWARDING. The application may also end the session by calling ToiMediaPlayer::close(), which makes the player go to STATE_IDLE. If an error occurs with the stream severe enough for the player to determine it cannot continue playback, the player will go to STATE_FAILED.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.STATE_REWINDING.

The subtitles are in ARIB format.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.SUBTITLE_ARIB.

The subtitles are in DVB format.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.SUBTITLE_DVB.

The subtitles are in DVD format.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.SUBTITLE_DVD.

The subtitles are designed for the hearing impaired.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.SUBTITLE_HEARING_IMPAIRED.

The subtitles are designed for normal audience.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.SUBTITLE_NORMAL.

The subtitles are in Teletext format.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.SUBTITLE_TELETEXT.

The type of subtitles is not known.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.SUBTITLE_UNKNOWN.

The subtitles are in XSUB or XSUB plus format.

Note:

{Request "_AviSubtitleXSubPlus<trackId>" parameter to specify which one.}

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.SUBTITLE_XSUB.

In TIMESHIFT_STATE_BUFFERING the media player is buffering the current media source to the timeshift buffer. In this state the capabilities change to include trick play capabilities such as pause, fast forward and rewind.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.TIMESHIFT_STATE_BUFFERING.

In TIMESHIFT_STATE_BUFFERING_FAILED the timeshift buffering has failed for some reason. The reason can be retrieved by calling ToiMediaPlayerBase::getTimeshiftError(). The media player will only leave TIMESHIFT_STATE_BUFFERING_FAILED on a call by the application to ToiMediaPlayer::discardTimeshiftBuffer().

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.TIMESHIFT_STATE_BUFFERING_FAILED.

In TIMESHIFT_STATE_INACTIVE the timeshift operation is not enabled. The capacity of the buffer is unknown and the capabilities are the same as for the current media source, e.g. if you play a multicasted stream, trick play capabilities such as pause, fast forward and rewind are not allowed.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.TIMESHIFT_STATE_INACTIVE.

In TIMESHIFT_STATE_STOPPED the buffering has been stopped either due to an explicit call to ToiMediaPlayer::stopTimeshiftBuffering() or due to full buffer.

This constant can also be accessed from toi.consts.ToiMediaPlayerBase.TIMESHIFT_STATE_STOPPED.