ToiMediaPlayerBase

This is an Event identifier for ToiMediaPlayerCapabilitiesChangedEvent.

Tells the observer that the media player capabilities has changed. This may happen when time shifting is started and stopped.

This is an Event identifier for ToiMediaPlayerDataAvailableEvent.

Tells the observer when the status of stream data availability changes, e.g. when there is not enough data available for playback.

This is an Event identifier for ToiMediaPlayerMediaBufferStatusChangedEvent.

Tells the observer that the media buffer information has changed. This notification wil be triggered once a second if the session supports the capability ToiMediaPlayerBase.CAPABILITY_MEDIA_BUFFER&.

This is an Event identifier for ToiMediaPlayerParameterChangedEvent.

Tells the observer that the value has changed for one of the parameters that the observer is subscribing to.

This is an Event identifier for ToiMediaPlayerPositionStatusChangedEvent.

Gives the observer an up-to-date snapshot of the position in the stream, together with information about how the position changes. This event may be emitted at any time within a session, but generally it is emitted every time the pace changes and in regular intervals in-between.

This is an Event identifier for ToiMediaPlayerPresentationStatusChangedEvent.

Tells the observer when the video or audio locked status changes. Presentation information is also available through the function ToiMediaPlayerBase#getPresentationInfo.

This is an Event identifier for ToiMediaPlayerStateChangedEvent.

A call to this function tells the observer that the media player state has changed. The application is not notified this way about implicit state changes triggered by commands from the application itself. For example, assume the player is in ToiMediaPlayerBase.STATE_PLAYING. If the application calls ToiMediaPlayer#play with a pace greater than 1000 and the function returns without error, the player state has changed implicitly to ToiMediaPlayerBase.STATE_FASTFORWARDING but the application will not receive a call to ToiMediaPlayerStateChangedEvent for that particular state transition. However, other applications that have registered observers to the status interface will, assuming this particular player is in focus, receive calls to ToiMediaPlayerStateChangedEvent with state ToiMediaPlayerBase.STATE_FASTFORWARDING and reason ToiMediaService.REASON_COMMAND_FASTFORWARD.

Note that there is no timing constraint on these messages, and they may arrive late in certain situations. For example, the application may receive a call to this function about a state transition after the application has successfully called ToiMediaPlayer#close and thereby ended the session. This implies that the application should take calls to this function as indications to state transitions that has in fact happened, but it cannot say for certain when these state transitions occurred.

This is an Event identifier for ToiMediaPlayerStreamInfoChangedEvent.

Tells the observer that the media player has updated the available or active stream components or that the information on the stream components has changed. Information on the stream is available through the ToiMediaPlayerBase#getStreamInfo function. Information on the different type of stream components is available through the respecitve info functions in ToiMediaPlayerBase.

The active format descriptor is 4:3 centre.

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

The active format descriptor is 14:9 centre.

The active format descriptor is 14:9 top.

The active format descriptor is 16:9 centre.

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

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

The active format descriptor is 16:9 top.

The active format descriptor is > 16:9 centre.

The active format descriptor is same as coded.

The active format descriptor is not known.

The aspect ratio is 4:3

The aspect ratio is 16:9

The aspect ratio is not known.

The audio is prepared for the hearing impaired.

The audio is prepared for normal audiance.

The audience type of the audio is not known.

The audio is prepared for the visually impaired.

Four audio channels. Three front and one back speakers.

Five audio channels. Three front and two back speakers.

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

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

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

One audio channel. One speaker.

Two audio channels. Two front speakers.

The audio channel format is not known.

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

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

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

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

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

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

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.

When this bit is set the session provides a position value which the client may read with ToiMediaPlayerBase#getPositionInfo and similar commands.

When this bit is set the session supports some type of media buffering and the client can get media buffer information using ToiMediaPlayerBase#getMediaBufferInfo.

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 occurred. This is similar to freeze.

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

When this bit is set the session accepts the position to be set ToiMediaPlayer#playFromPosition.

When this bit is set the session can perform timeshift buffering operations. It will not be unset when buffering or playing from the buffer as long as the session still supports timeshift operations.

Audio components have information of type ToiMediaPlayerBase.ToiAudioStreamInfo.

Denotes a regular subtitling component.

This is an ARIB specific type of subtitles.

This is an ARIB specific type of subtitles and used mainly for displaying alert messages on screen.

Teletext VBI component have information of type ToiMediaPlayerBase.ToiTeletextStreamInfo&.

Video components have information of type ToiMediaPlayerBase.ToiVideoStreamInfo.

Media download buffer Used

Timeshifter buffer Used

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

Predefined argument value for ToiMediaPlayer#play. Indicates that the player should be paused.

Predefined argument value for ToiMediaPlayer#play. Indicates that the player should play with normal speed.

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

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.

Automatic mode.

Non-automatic mode.

Select mode.

Special mode.

Automatic mode.

Non-automatic mode.

Select mode.

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

ToiMediaPlayerBase.SOURCE_UNKNOWN - An error of unknown type has occurred.

In ToiMediaPlayerBase.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 ToiMediaPlayerBase.STATE_PAUSED when it has successfully established the connection to the stream source. If the media player decides it cannot connect, it will enter ToiMediaPlayerBase.STATE_FAILED instead. If the application is not interested in knowing when the player has connected, it may call ToiMediaPlayer#play to set the player in ToiMediaPlayerBase.STATE_PLAYING directly. The application may also end the session by calling ToiMediaPlayer#close, which makes the player go to ToiMediaPlayerBase.STATE_IDLE.

In ToiMediaPlayerBase.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 ToiMediaPlayerBase.STATE_FAILED on a call by the application to ToiMediaPlayer#close.

In ToiMediaPlayerBase.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 ToiMediaPlayerBase.STATE_PLAYING, ToiMediaPlayerBase.STATE_PAUSED, or ToiMediaPlayerBase.STATE_REWINDING. The application may also end the session by calling ToiMediaPlayer#close, which makes the player go to ToiMediaPlayerBase.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 ToiMediaPlayerBase.STATE_FAILED.

In ToiMediaPlayerBase.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 ToiSessionViolationException in ToiMediaPlayerBase.STATE_IDLE. The media player will only leave ToiMediaPlayerBase.STATE_IDLE on a successful call to ToiMediaPlayer#open.

In ToiMediaPlayerBase.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 ToiMediaPlayerBase.STATE_PLAYING, ToiMediaPlayerBase.STATE_FASTFORWARDING, or ToiMediaPlayerBase.STATE_REWINDING. The application may also end the session by calling ToiMediaPlayer#close, which makes the player go to ToiMediaPlayerBase.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 ToiMediaPlayerBase.STATE_FAILED.

In ToiMediaPlayerBase.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 ToiMediaPlayerBase.STATE_PAUSED, ToiMediaPlayerBase.STATE_FASTFORWARDING, or ToiMediaPlayerBase.STATE_REWINDING. The application may also end the session by calling ToiMediaPlayer#close, which makes the player go to ToiMediaPlayerBase.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 ToiMediaPlayerBase.STATE_FAILED.

In ToiMediaPlayerBase.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 ToiMediaPlayerBase.STATE_PLAYING, ToiMediaPlayerBase.STATE_PAUSED, or ToiMediaPlayerBase.STATE_FASTFORWARDING. The application may also end the session by calling ToiMediaPlayer#close, which makes the player go to ToiMediaPlayerBase.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 ToiMediaPlayerBase.STATE_FAILED.

The subtitles are in ARIB format.

The subtitles are in DVB format.

The subtitles are in DVD format.

Deprecated:

Not supported.

The subtitles are designed for the hearing impaired.

The subtitles are designed for normal audience.

The subtitles are in SCTE-27 (Society of Cable Telecommunications Engineers) format.

Deprecated:

Not supported.

The subtitles are in SRT (SubRip Text) format.

The subtitles are in Teletext format.

The type of subtitles is not known.

The subtitles are in WEBVTT (Web Video Text Track) format.

The subtitles are in XSUB or XSUB plus format.

Deprecated:

Not supported.

Indicates cancel flag set.

Indicates SEI message absent.

Checkboard based arrangement.

Column based arrangement.

Reserved values.

Row based arrangement.

Side-by-side packing arrangement.

Temporal interleaving arrangement.

Top-bottom packing arrangement.

Interlaced video.

Progressive video.

Scan mode is unknown.

Audio stream data structure used to return audio stream information. Depending on the stream format some fields will be reported as unknown.

Identifier for a component type.

Structure holding both the source of an error and the error code produced by that source.

Data structure used to return buffering information.

Playback pace information data structure used to report pace information for the current media session.

Position information structure used to report position and pace information for the current media session.

Data structure used to return presentation info. Indicates whether audio and video are ready for presentation.

Range information data structure used to define a position range in milliseconds. The range is invalid if both positions are set to -1.

Stream information data structure used to return generic metadata about a stream.

Subtitle stream data structure used to return subtitle information.

Teletext stream data structure used to return teletext information.

Video stream data structure used to return video stream information. Depending on the stream format some fields will be reported as unknown. The type of video encoding is the only field that will not be reported as unknown if it is not the currently active video stream.