Modules

Classes

voEvents
voErrorCode

Events


VO_OSMP_SRC_CB_OPEN_FINISHED

Triggered when the open is complete.


VO_OSMP_CB_PLAY_STARTED

Triggered when the media playing starts for the first time, resumes after pause, or restarts after ending.


VO_OSMP_CB_PLAY_PAUSED

Triggered when the media playing is paused.


VO_OSMP_CB_PLAY_WAITING

Triggered when the media playing is waiting.


VO_OSMP_CB_PLAY_PLAYING

Triggered when the media playing recovered from waiting.


VO_OSMP_CB_PLAY_COMPLETE

Triggered when the playback is completed.


VO_OSMP_CB_PLAY_VOLUME_CHANGED

Triggered when the playback volume is changed or the muted state is changed.


VO_OSMP_CB_PLAY_TIME_UPDATED

Triggered when the element's currentTime attribute is changed.

Type: object
Properties:
Name Type Description
position Number

The currentTime of the media.


VO_OSMP_CB_SEEK_START

Triggered when the seek operation is started.


VO_OSMP_CB_SEEK_COMPLETE

Triggered when the seek operation is completed.


VO_OSMP_CB_LOG_ADDED

Triggered when there is a new log message.

Type: object
Properties:
Name Type Description
message string

The added log message.


VO_OSMP_SRC_CB_PROGRAM_CHANGED

Triggered when the selected track is changed.


VO_OSMP_CB_ERROR_EVENTS

Triggered when there's an error occurred.

Type: object
Properties:
Name Type Description
code voErrorCode

ErrorCode defined in voErrorCode

message string

The detailed error message.


VO_OSMP_CB_CAST_CONNECTED

Triggered when the chromecast is connected.

Type: object
Properties:
Name Type Description
deviceName string

The remote device name.


VO_OSMP_CB_CAST_DISCONNECTED

Triggered when the chromecast is disconnected.


VO_OSMP_CB_PIP_MODE_CHANGED

Triggered when PIP presentation mode changed. (Safari Only)


VO_OSMP_SRC_ADAPTIVE_STREAMING_INFO_EVENT_BITRATE_CHANGE

Triggered when new ABR quality is being rendered on-screen.

Type: object
Properties:
Name Type Description
mediaType string

track type

oldQuality string

the id of old quality

newQuality string

the id of new quality

bandwidth number

the bandwidth of new quality


VO_OSMP_SRC_CB_CUSTOMER_TAG

Triggered when the customer tag information is available inside source

Type: object
Properties:
Name Type Description
tagType string

now only support 'VO_OSMP_SRC_CUSTOMERTAGID_TIMEDTAG'

timestamp number

pts of data(ms)

data object

rely on tagType. For 'VO_OSMP_SRC_CUSTOMERTAGID_TIMEDTAG', it is an Uint8Array object


VO_OSMP_CB_AIRPLAY_AVAILABILITY_CHANGED

Triggered when airplay availability is changed. (Safari Only)

Type: object
Properties:
Name Type Description
changedevent WebKitPlaybackTargetAvailabilityEvent

The WebKitPlaybackTargetAvailabilityEvent object.


VO_OSMP_AD_ALL_ADS_COMPLETED

Triggered when all ads playback is completed.


VO_OSMP_AD_COMPANION

Triggered when the ad contains desired companions. See adConfig.companions.


VO_OSMP_AD_ERROR

Triggered when an error occurred while the ad is loading or playing.


VO_OSMP_AD_PLAY

Triggered when the ad playback resumes.


VO_OSMP_AD_PAUSED

Triggered when the ad playback is paused.


VO_OSMP_AD_STARTED

Triggered when the ad playback is started.

Type: object
Properties:
Name Type Description
adType string

The current ad type. It could be 'linear' or 'nonlinear'.

width string

The current ad width, zero for linear ad.

height string

The current ad height, zero for linear ad.


VO_OSMP_AD_COMPLETE

Triggered when the ads playback is completed.

Type: object
Properties:
Name Type Description
adType string

The completed ad type. It could be 'linear' or 'nonlinear'.


VO_OSMP_TRICKMODE_CHANGED

Triggered when the trick mode playback is canceled.

Type: object
Properties:
Name Type Description
mode boolean

The trick mode value. It could be true or false.