ToiMediaPlayerBase Interface Reference

Description

The ToiMediaPlayerBase interface is the base interface for player instances. It contains only read-only methods and no control functionality.

See also:: ToiMediaService; ToiMediaPlayer

import "ToiMediaPlayerBase.idl";

List of all members.

Public Member Functions
TToiState	getState ()
ToiMediaPlayerBaseError	getError ()
ToiMediaSession::TToiSessionId	getSessionId () raises (TToiSessionViolationException)
string	getUrl () raises (TToiSessionViolationException)
ToiMediaPlayerBaseStreamInfo	getStreamInfo () raises (TToiSessionViolationException, TToiUnavailableException)
ToiMediaPlayerBaseVideoStreamInfo	getVideoStreamInfo (in ToiMediaPlayerBaseComponentEntry mediaComponent) raises (TToiSessionViolationException, TToiInvalidArgumentException, TToiUnavailableException)
ToiMediaPlayerBaseAudioStreamInfo	getAudioStreamInfo (in ToiMediaPlayerBaseComponentEntry mediaComponent) raises (TToiSessionViolationException, TToiInvalidArgumentException, TToiUnavailableException)
ToiMediaPlayerBaseSubtitleStreamInfo	getSubtitleStreamInfo (in ToiMediaPlayerBaseComponentEntry mediaComponent) raises (TToiSessionViolationException, TToiInvalidArgumentException, TToiUnavailableException)
ToiMediaPlayerBaseTeletextStreamInfo	getTeletextStreamInfo (in ToiMediaPlayerBaseComponentEntry mediaComponent) raises (TToiSessionViolationException, TToiInvalidArgumentException, TToiUnavailableException)
long	getCapabilities () raises (TToiSessionViolationException, TToiUnavailableException)
long	getPosition () raises (TToiSessionViolationException, TToiOperationNotSupportedException, TToiUnavailableException)
long	getPace () raises (TToiSessionViolationException, TToiOperationNotSupportedException, TToiUnavailableException)
boolean	isTimeshiftPlayback () raises (TToiSessionViolationException, TToiUnavailableException)
ToiMediaPlayerBaseTimeshiftInfo	getTimeshiftInfo () raises (TToiSessionViolationException, TToiUnavailableException)
ToiMediaPlayerBaseError	getTimeshiftError ()
TToiComponentSequence	getActiveComponents () raises (TToiSessionViolationException, TToiUnavailableException)
string	getParameter (in string name) raises (TToiInvalidArgumentException, TToiUnavailableException)
void	subscribeParameter (in ToiEventListener eventListener, in string name) raises (TToiInvalidArgumentException, TToiUnavailableException)
void	unsubscribeParameter (in ToiEventListener eventListener, in string name) raises (TToiInvalidArgumentException, TToiUnavailableException)
void	releaseInstance ()
void	addEventListener (in long type, in ToiEventListener listener) raises (TToiInvalidArgumentException)
void	removeEventListener (in long type, in ToiEventListener listener) raises (TToiInvalidArgumentException)
Public Attributes
const long	PACE_PAUSE = 0
const long	PACE_PLAY = 1000
const long	PACE_FASTFORWARD = 5000
const long	PACE_REWIND = -5000
const long	POSITION_LIVE = -1616928864
const long	CAPABILITY_PAUSE = 1
const long	CAPABILITY_REWIND = 2
const long	CAPABILITY_FASTFORWARD = 4
const long	CAPABILITY_GETPOSITION = 8
const long	CAPABILITY_SETPOSITION = 16
const long	CAPABILITY_FREEZE = 32
const long	CAPABILITY_TIMESHIFT = 64
Events

const long	ON_STATE_CHANGED = 1700
const long	ON_DATA_AVAILABLE = 1701
const long	ON_POSITION_CHANGED = 1702
const long	ON_STREAM_INFO_CHANGED = 1703
const long	ON_ACTIVE_COMPONENT_CHANGED = 1704
const long	ON_PARAMETER_CHANGED = 1705
const long	ON_TIMESHIFT_STATE_CHANGED = 1706
const long	ON_CAPABILITIES_CHANGED = 1707
TToiComponentType

const TToiComponentType	COMPONENT_AUDIO = 0
const TToiComponentType	COMPONENT_VIDEO = 1
const TToiComponentType	COMPONENT_SUBTITLE = 2
const TToiComponentType	COMPONENT_SUBTITLE_CAPTION = 3
const TToiComponentType	COMPONENT_SUBTITLE_SUPERIMPOSE = 4
const TToiComponentType	COMPONENT_TELETEXT_VBI = 5
TToiErrorSource

const TToiErrorSource	SOURCE_UNKNOWN = 0
const TToiErrorSource	SOURCE_INTERNAL = 1
const TToiErrorSource	SOURCE_BITBAND = 2
TToiState

const TToiState	STATE_IDLE = 0
const TToiState	STATE_CONNECTING = 1
const TToiState	STATE_PAUSED = 2
const TToiState	STATE_PLAYING = 3
const TToiState	STATE_FASTFORWARDING = 4
const TToiState	STATE_REWINDING = 5
const TToiState	STATE_FAILED = 6
TToiTimeshiftState

const TToiTimeshiftState	TIMESHIFT_STATE_INACTIVE = 0
const TToiTimeshiftState	TIMESHIFT_STATE_BUFFERING = 1
const TToiTimeshiftState	TIMESHIFT_STATE_STOPPED = 2
const TToiTimeshiftState	TIMESHIFT_STATE_BUFFERING_FAILED = 3
TToiAudioAudienceType

const TToiAudioAudienceType	AUDIO_AUDIENCE_TYPE_UNKNOWN = 0
const TToiAudioAudienceType	AUDIO_AUDIENCE_TYPE_NORMAL = 1
const TToiAudioAudienceType	AUDIO_AUDIENCE_TYPE_VISUALLY_IMPAIRED = 2
const TToiAudioAudienceType	AUDIO_AUDIENCE_TYPE_HEARING_IMPAIRED = 3
TToiAudioChannelFormat

const TToiAudioChannelFormat	AUDIO_CHANNEL_FORMAT_UNKNOWN = 0
const TToiAudioChannelFormat	AUDIO_CHANNEL_FORMAT_SINGLE_MONO = 1
const TToiAudioChannelFormat	AUDIO_CHANNEL_FORMAT_DUAL_MONO = 2
const TToiAudioChannelFormat	AUDIO_CHANNEL_FORMAT_STEREO = 3
const TToiAudioChannelFormat	AUDIO_CHANNEL_FORMAT_3_FRONT_1_BACK = 4
const TToiAudioChannelFormat	AUDIO_CHANNEL_FORMAT_3_FRONT_2_BACK = 5
const TToiAudioChannelFormat	AUDIO_CHANNEL_FORMAT_3_FRONT_2_BACK_LFE = 6
const TToiAudioChannelFormat	AUDIO_CHANNEL_FORMAT_3_FRONT_2_SIDE_2_BACK_LFE = 7
TToiAudioChannelMode

const TToiAudioChannelMode	AUDIO_CHANNEL_MODE_NORMAL = 0
const TToiAudioChannelMode	AUDIO_CHANNEL_MODE_DUAL_MONO_LEFT_ONLY = 1
const TToiAudioChannelMode	AUDIO_CHANNEL_MODE_DUAL_MONO_RIGHT_ONLY = 2
const TToiAudioChannelMode	AUDIO_CHANNEL_MODE_DUAL_MONO_STEREO = 3
const TToiAudioChannelMode	AUDIO_CHANNEL_MODE_DUAL_MONO_MIXED = 4
TToiAspectRatio

const TToiAspectRatio	ASPECT_RATIO_UNKNOWN = 0
const TToiAspectRatio	ASPECT_RATIO_4_3 = 1
const TToiAspectRatio	ASPECT_RATIO_16_9 = 2
TToiActiveFormatDescriptor

const TToiActiveFormatDescriptor	ACTIVE_FORMAT_UNKNOWN = 0
const TToiActiveFormatDescriptor	ACTIVE_FORMAT_16_9_TOP = 1
const TToiActiveFormatDescriptor	ACTIVE_FORMAT_14_9_TOP = 2
const TToiActiveFormatDescriptor	ACTIVE_FORMAT_MORE_THAN_16_9_CENTRE = 3
const TToiActiveFormatDescriptor	ACTIVE_FORMAT_SAME_AS_CODED = 4
const TToiActiveFormatDescriptor	ACTIVE_FORMAT_4_3_CENTRE = 5
const TToiActiveFormatDescriptor	ACTIVE_FORMAT_16_9_CENTRE = 6
const TToiActiveFormatDescriptor	ACTIVE_FORMAT_14_9_CENTRE = 7
const TToiActiveFormatDescriptor	ACTIVE_FORMAT_4_3_SHOOT_AND_PROTECT_14_9_CENTRE = 8
const TToiActiveFormatDescriptor	ACTIVE_FORMAT_16_9_SHOOT_AND_PROTECT_14_9_CENTRE = 9
const TToiActiveFormatDescriptor	ACTIVE_FORMAT_16_9_SHOOT_AND_PROTECT_4_3_CENTRE = 10
TToiSubtitleType

const TToiSubtitleType	SUBTITLE_UNKNOWN = 0
const TToiSubtitleType	SUBTITLE_NORMAL = 1
const TToiSubtitleType	SUBTITLE_HEARING_IMPAIRED = 2
TToiSubtitleFormat

const TToiSubtitleFormat	SUBTITLE_DVB = 0
const TToiSubtitleFormat	SUBTITLE_ARIB = 1
const TToiSubtitleFormat	SUBTITLE_TELETEXT = 2
const TToiSubtitleFormat	SUBTITLE_DVD = 3
const TToiSubtitleFormat	SUBTITLE_XSUB = 4
TToiReceiveDmfMode

const TToiReceiveDmfMode	RECEIVE_DMF_MODE_AUTO = 0
const TToiReceiveDmfMode	RECEIVE_DMF_MODE_NON_AUTO = 1
const TToiReceiveDmfMode	RECEIVE_DMF_MODE_SELECT = 2
const TToiReceiveDmfMode	RECEIVE_DMF_MODE_SPECIAL = 3
TToiRecordDmfMode

const TToiRecordDmfMode	RECORD_DMF_MODE_AUTO = 0
const TToiRecordDmfMode	RECORD_DMF_MODE_NON_AUTO = 1
const TToiRecordDmfMode	RECORD_DMF_MODE_SELECT = 2
Public Types
typedef long	TToiComponentType
typedef sequence < ToiMediaPlayerBaseComponentEntry >	TToiComponentSequence
typedef sequence< long >	TToiPaceSequence
typedef long	TToiErrorSource
typedef long	TToiState
typedef long	TToiTimeshiftState
typedef long	TToiAudioAudienceType
typedef long	TToiAudioChannelFormat
typedef long	TToiAudioChannelMode
typedef long	TToiAspectRatio
typedef long	TToiActiveFormatDescriptor
typedef long	TToiSubtitleType
typedef long	TToiSubtitleFormat
typedef long	TToiReceiveDmfMode
typedef long	TToiRecordDmfMode

Member Typedef Documentation

typedef long ToiMediaPlayerBase::TToiActiveFormatDescriptor

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

typedef long ToiMediaPlayerBase::TToiAspectRatio

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

typedef long ToiMediaPlayerBase::TToiAudioAudienceType

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

typedef long ToiMediaPlayerBase::TToiAudioChannelFormat

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

typedef long ToiMediaPlayerBase::TToiAudioChannelMode

The audio channel mode specifies audio channel to speaker mappings.

typedef sequence< ToiMediaPlayerBaseComponentEntry > ToiMediaPlayerBase::TToiComponentSequence

List of media component entries

typedef long ToiMediaPlayerBase::TToiComponentType

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

typedef long ToiMediaPlayerBase::TToiErrorSource

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

typedef sequence< long > ToiMediaPlayerBase::TToiPaceSequence

Technical Preview:: List of supported paces

typedef long ToiMediaPlayerBase::TToiReceiveDmfMode

Receive DMF mode used for ARIB CC/CS

typedef long ToiMediaPlayerBase::TToiRecordDmfMode

Receive DMF mode used for ARIB CC/CS

typedef long ToiMediaPlayerBase::TToiState

Enumeration of media player states.

typedef long ToiMediaPlayerBase::TToiSubtitleFormat

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

typedef long ToiMediaPlayerBase::TToiSubtitleType

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

typedef long ToiMediaPlayerBase::TToiTimeshiftState

State identifier used to identify the media player timeshift state.

Member Function Documentation

void ToiEventTarget::addEventListener	(	in long	type,
		in ToiEventListener	listener
	)			raises (TToiInvalidArgumentException) `[inherited]`

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.

TToiComponentSequence ToiMediaPlayerBase::getActiveComponents ( ) raises (TToiSessionViolationException, TToiUnavailableException)

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.

ToiMediaPlayerBaseAudioStreamInfo ToiMediaPlayerBase::getAudioStreamInfo ( in ToiMediaPlayerBaseComponentEntry mediaComponent ) raises (TToiSessionViolationException, TToiInvalidArgumentException, TToiUnavailableException)

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.

long ToiMediaPlayerBase::getCapabilities ( ) raises (TToiSessionViolationException, TToiUnavailableException)

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.

ToiMediaPlayerBaseError ToiMediaPlayerBase::getError ( )

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

long ToiMediaPlayerBase::getPace ( ) raises (TToiSessionViolationException, TToiOperationNotSupportedException, TToiUnavailableException)

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.

string ToiMediaPlayerBase::getParameter ( in string name ) raises (TToiInvalidArgumentException, TToiUnavailableException)

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()

long ToiMediaPlayerBase::getPosition ( ) raises (TToiSessionViolationException, TToiOperationNotSupportedException, TToiUnavailableException)

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.

ToiMediaSession::TToiSessionId ToiMediaPlayerBase::getSessionId ( ) raises (TToiSessionViolationException)

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()

TToiState ToiMediaPlayerBase::getState ( )

Returns the current state of the media player instance.

Return values:

state

The current player state.

ToiMediaPlayerBaseStreamInfo ToiMediaPlayerBase::getStreamInfo ( ) raises (TToiSessionViolationException, TToiUnavailableException)

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.

ToiMediaPlayerBaseSubtitleStreamInfo ToiMediaPlayerBase::getSubtitleStreamInfo ( in ToiMediaPlayerBaseComponentEntry mediaComponent ) raises (TToiSessionViolationException, TToiInvalidArgumentException, TToiUnavailableException)

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.

ToiMediaPlayerBaseTeletextStreamInfo ToiMediaPlayerBase::getTeletextStreamInfo ( in ToiMediaPlayerBaseComponentEntry mediaComponent ) raises (TToiSessionViolationException, TToiInvalidArgumentException, TToiUnavailableException)

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.

ToiMediaPlayerBaseError ToiMediaPlayerBase::getTimeshiftError ( )

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.

ToiMediaPlayerBaseTimeshiftInfo ToiMediaPlayerBase::getTimeshiftInfo ( ) raises (TToiSessionViolationException, TToiUnavailableException)

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.

string ToiMediaPlayerBase::getUrl ( ) raises (TToiSessionViolationException)

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.

ToiMediaPlayerBaseVideoStreamInfo ToiMediaPlayerBase::getVideoStreamInfo ( in ToiMediaPlayerBaseComponentEntry mediaComponent ) raises (TToiSessionViolationException, TToiInvalidArgumentException, TToiUnavailableException)

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.

boolean ToiMediaPlayerBase::isTimeshiftPlayback ( ) raises (TToiSessionViolationException, TToiUnavailableException)

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.

void ToiMediaPlayerBase::releaseInstance ( )

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

void ToiEventTarget::removeEventListener	(	in long	type,
		in ToiEventListener	listener
	)			raises (TToiInvalidArgumentException) `[inherited]`

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.

void ToiMediaPlayerBase::subscribeParameter	(	in ToiEventListener	eventListener,
		in string	name
	)			raises (TToiInvalidArgumentException, TToiUnavailableException)

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()

void ToiMediaPlayerBase::unsubscribeParameter	(	in ToiEventListener	eventListener,
		in string	name
	)			raises (TToiInvalidArgumentException, TToiUnavailableException)

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()

Member Data Documentation

const TToiActiveFormatDescriptor ToiMediaPlayerBase::ACTIVE_FORMAT_14_9_CENTRE = 7

The active format descriptor is 14:9 centre.

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

const TToiActiveFormatDescriptor ToiMediaPlayerBase::ACTIVE_FORMAT_14_9_TOP = 2

The active format descriptor is 14:9 top.

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

const TToiActiveFormatDescriptor ToiMediaPlayerBase::ACTIVE_FORMAT_16_9_CENTRE = 6

The active format descriptor is 16:9 centre.

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

const TToiActiveFormatDescriptor ToiMediaPlayerBase::ACTIVE_FORMAT_16_9_SHOOT_AND_PROTECT_14_9_CENTRE = 9

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.

const TToiActiveFormatDescriptor ToiMediaPlayerBase::ACTIVE_FORMAT_16_9_SHOOT_AND_PROTECT_4_3_CENTRE = 10

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.

const TToiActiveFormatDescriptor ToiMediaPlayerBase::ACTIVE_FORMAT_16_9_TOP = 1

The active format descriptor is 16:9 top.

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

const TToiActiveFormatDescriptor ToiMediaPlayerBase::ACTIVE_FORMAT_4_3_CENTRE = 5

The active format descriptor is 4:3 centre.

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

const TToiActiveFormatDescriptor ToiMediaPlayerBase::ACTIVE_FORMAT_4_3_SHOOT_AND_PROTECT_14_9_CENTRE = 8

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.

const TToiActiveFormatDescriptor ToiMediaPlayerBase::ACTIVE_FORMAT_MORE_THAN_16_9_CENTRE = 3

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.

const TToiActiveFormatDescriptor ToiMediaPlayerBase::ACTIVE_FORMAT_SAME_AS_CODED = 4

The active format descriptor is same as coded.

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

const TToiActiveFormatDescriptor ToiMediaPlayerBase::ACTIVE_FORMAT_UNKNOWN = 0

The active format descriptor is not known.

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

const TToiAspectRatio ToiMediaPlayerBase::ASPECT_RATIO_16_9 = 2

The aspect ratio is 16:9

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

const TToiAspectRatio ToiMediaPlayerBase::ASPECT_RATIO_4_3 = 1

The aspect ratio is 4:3

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

const TToiAspectRatio ToiMediaPlayerBase::ASPECT_RATIO_UNKNOWN = 0

The aspect ratio is not known.

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

const TToiAudioAudienceType ToiMediaPlayerBase::AUDIO_AUDIENCE_TYPE_HEARING_IMPAIRED = 3

The audio is prepared for the hearing impaired.

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

const TToiAudioAudienceType ToiMediaPlayerBase::AUDIO_AUDIENCE_TYPE_NORMAL = 1

The audio is prepared for normal audiance.

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

const TToiAudioAudienceType ToiMediaPlayerBase::AUDIO_AUDIENCE_TYPE_UNKNOWN = 0

The audience type of the audio is not known.

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

const TToiAudioAudienceType ToiMediaPlayerBase::AUDIO_AUDIENCE_TYPE_VISUALLY_IMPAIRED = 2

The audio is prepared for the visually impaired.

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

const TToiAudioChannelFormat ToiMediaPlayerBase::AUDIO_CHANNEL_FORMAT_3_FRONT_1_BACK = 4

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.

const TToiAudioChannelFormat ToiMediaPlayerBase::AUDIO_CHANNEL_FORMAT_3_FRONT_2_BACK = 5

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.

const TToiAudioChannelFormat ToiMediaPlayerBase::AUDIO_CHANNEL_FORMAT_3_FRONT_2_BACK_LFE = 6

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.

const TToiAudioChannelFormat ToiMediaPlayerBase::AUDIO_CHANNEL_FORMAT_3_FRONT_2_SIDE_2_BACK_LFE = 7

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.

const TToiAudioChannelFormat ToiMediaPlayerBase::AUDIO_CHANNEL_FORMAT_DUAL_MONO = 2

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.

const TToiAudioChannelFormat ToiMediaPlayerBase::AUDIO_CHANNEL_FORMAT_SINGLE_MONO = 1

One audio channel. One speaker.

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

const TToiAudioChannelFormat ToiMediaPlayerBase::AUDIO_CHANNEL_FORMAT_STEREO = 3

Two audio channels. Two front speakers.

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

const TToiAudioChannelFormat ToiMediaPlayerBase::AUDIO_CHANNEL_FORMAT_UNKNOWN = 0

The audio channel format is not known.

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

const TToiAudioChannelMode ToiMediaPlayerBase::AUDIO_CHANNEL_MODE_DUAL_MONO_LEFT_ONLY = 1

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.

const TToiAudioChannelMode ToiMediaPlayerBase::AUDIO_CHANNEL_MODE_DUAL_MONO_MIXED = 4

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.

const TToiAudioChannelMode ToiMediaPlayerBase::AUDIO_CHANNEL_MODE_DUAL_MONO_RIGHT_ONLY = 2

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.

const TToiAudioChannelMode ToiMediaPlayerBase::AUDIO_CHANNEL_MODE_DUAL_MONO_STEREO = 3

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.

const TToiAudioChannelMode ToiMediaPlayerBase::AUDIO_CHANNEL_MODE_NORMAL = 0

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.

const long ToiMediaPlayerBase::CAPABILITY_FASTFORWARD = 4

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.

const long ToiMediaPlayerBase::CAPABILITY_FREEZE = 32

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.

const long ToiMediaPlayerBase::CAPABILITY_GETPOSITION = 8

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.

const long ToiMediaPlayerBase::CAPABILITY_PAUSE = 1

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.

const long ToiMediaPlayerBase::CAPABILITY_REWIND = 2

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.

const long ToiMediaPlayerBase::CAPABILITY_SETPOSITION = 16

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.

const long ToiMediaPlayerBase::CAPABILITY_TIMESHIFT = 64

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

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

const TToiComponentType ToiMediaPlayerBase::COMPONENT_AUDIO = 0

Audio components have information of type ToiMediaPlayerBaseAudioStreamInfo.

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

const TToiComponentType ToiMediaPlayerBase::COMPONENT_SUBTITLE = 2

Denotes a regular subtitling component.

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

const TToiComponentType ToiMediaPlayerBase::COMPONENT_SUBTITLE_CAPTION = 3

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.

const TToiComponentType ToiMediaPlayerBase::COMPONENT_SUBTITLE_SUPERIMPOSE = 4

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.

const TToiComponentType ToiMediaPlayerBase::COMPONENT_TELETEXT_VBI = 5

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.

const TToiComponentType ToiMediaPlayerBase::COMPONENT_VIDEO = 1

Video components have information of type ToiMediaPlayerBaseVideoStreamInfo.

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

const long ToiMediaPlayerBase::ON_ACTIVE_COMPONENT_CHANGED = 1704

This is an Event identifier for ToiMediaPlayerActiveComponentChangedEvent.

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

const long ToiMediaPlayerBase::ON_CAPABILITIES_CHANGED = 1707

This is an Event identifier for ToiMediaPlayerCapabilitiesChangedEvent.

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

const long ToiMediaPlayerBase::ON_DATA_AVAILABLE = 1701

This is an Event identifier for ToiMediaPlayerDataAvailableEvent.

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

const long ToiMediaPlayerBase::ON_PARAMETER_CHANGED = 1705

This is an Event identifier for ToiMediaPlayerParameterChangedEvent.

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

const long ToiMediaPlayerBase::ON_POSITION_CHANGED = 1702

This is an Event identifier for ToiMediaPlayerPositionChangedEvent.

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

const long ToiMediaPlayerBase::ON_STATE_CHANGED = 1700

This is an Event identifier for ToiMediaPlayerStateChangedEvent.

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

const long ToiMediaPlayerBase::ON_STREAM_INFO_CHANGED = 1703

This is an Event identifier for ToiMediaPlayerStreamInfoChangedEvent.

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

const long ToiMediaPlayerBase::ON_TIMESHIFT_STATE_CHANGED = 1706

This is an Event identifier for ToiMediaPlayerTimeshiftStateChangedEvent.

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

const long ToiMediaPlayerBase::PACE_FASTFORWARD = 5000

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.

const long ToiMediaPlayerBase::PACE_PAUSE = 0

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.

const long ToiMediaPlayerBase::PACE_PLAY = 1000

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.

const long ToiMediaPlayerBase::PACE_REWIND = -5000

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.

const long ToiMediaPlayerBase::POSITION_LIVE = -1616928864

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.

const TToiReceiveDmfMode ToiMediaPlayerBase::RECEIVE_DMF_MODE_AUTO = 0

Automatic mode.

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

const TToiReceiveDmfMode ToiMediaPlayerBase::RECEIVE_DMF_MODE_NON_AUTO = 1

Non-automatic mode.

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

const TToiReceiveDmfMode ToiMediaPlayerBase::RECEIVE_DMF_MODE_SELECT = 2

Select mode.

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

const TToiReceiveDmfMode ToiMediaPlayerBase::RECEIVE_DMF_MODE_SPECIAL = 3

Special mode.

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

const TToiRecordDmfMode ToiMediaPlayerBase::RECORD_DMF_MODE_AUTO = 0

Automatic mode.

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

const TToiRecordDmfMode ToiMediaPlayerBase::RECORD_DMF_MODE_NON_AUTO = 1

Non-automatic mode.

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

const TToiRecordDmfMode ToiMediaPlayerBase::RECORD_DMF_MODE_SELECT = 2

Select mode.

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

const TToiErrorSource ToiMediaPlayerBase::SOURCE_BITBAND = 2

SOURCE_BITBAND - A BitBand element has failed for some reason.

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

const TToiErrorSource ToiMediaPlayerBase::SOURCE_INTERNAL = 1

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.

const TToiErrorSource ToiMediaPlayerBase::SOURCE_UNKNOWN = 0

SOURCE_UNKNOWN - An error of unknown type has occurred.

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

const TToiState ToiMediaPlayerBase::STATE_CONNECTING = 1

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.

const TToiState ToiMediaPlayerBase::STATE_FAILED = 6

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.

const TToiState ToiMediaPlayerBase::STATE_FASTFORWARDING = 4

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.

const TToiState ToiMediaPlayerBase::STATE_IDLE = 0

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.

const TToiState ToiMediaPlayerBase::STATE_PAUSED = 2

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.

const TToiState ToiMediaPlayerBase::STATE_PLAYING = 3

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.

const TToiState ToiMediaPlayerBase::STATE_REWINDING = 5

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.

const TToiSubtitleFormat ToiMediaPlayerBase::SUBTITLE_ARIB = 1

The subtitles are in ARIB format.

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

const TToiSubtitleFormat ToiMediaPlayerBase::SUBTITLE_DVB = 0

The subtitles are in DVB format.

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

const TToiSubtitleFormat ToiMediaPlayerBase::SUBTITLE_DVD = 3

The subtitles are in DVD format.

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

const TToiSubtitleType ToiMediaPlayerBase::SUBTITLE_HEARING_IMPAIRED = 2

The subtitles are designed for the hearing impaired.

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

const TToiSubtitleType ToiMediaPlayerBase::SUBTITLE_NORMAL = 1

The subtitles are designed for normal audience.

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

const TToiSubtitleFormat ToiMediaPlayerBase::SUBTITLE_TELETEXT = 2

The subtitles are in Teletext format.

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

const TToiSubtitleType ToiMediaPlayerBase::SUBTITLE_UNKNOWN = 0

The type of subtitles is not known.

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

const TToiSubtitleFormat ToiMediaPlayerBase::SUBTITLE_XSUB = 4

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.

const TToiTimeshiftState ToiMediaPlayerBase::TIMESHIFT_STATE_BUFFERING = 1

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.

const TToiTimeshiftState ToiMediaPlayerBase::TIMESHIFT_STATE_BUFFERING_FAILED = 3

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.

const TToiTimeshiftState ToiMediaPlayerBase::TIMESHIFT_STATE_INACTIVE = 0

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.

const TToiTimeshiftState ToiMediaPlayerBase::TIMESHIFT_STATE_STOPPED = 2

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.

ToiMediaPlayerBase Interface Reference

Description

Public Member Functions

Public Attributes

Public Types

Member Typedef Documentation

Member Function Documentation

Member Data Documentation