• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

ToiMediaPlayerStateChangedEvent

Class Summary

Extends:
  • ToiEvent

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.

Parameters

Name Type Description
state ToiMediaPlayerBase.ToiState

The new state.

reason string

The reason for the state change.

  • Members

Members

evtTarget (Type: ToiEventTarget)

The event target that generated the event.

evtTimeStamp (Type: number)

The time (in seconds since the Epoch) at which the event was generated.

evtType (Type: number)

The type of the event.

reason (Type: string)

The reason for the state change.

state (Type: ToiMediaPlayerBase.ToiState)

The new state.

5.0.1

Copyright (c) 2016 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.