Namespaces

Classes

FrameworkRegistrationObject
VideoElementData
VideoSourceData
VideoContentMetadata
VideoDownloadingMetadata
VideoBufferingStartedData
VideoBufferingEndedData
VideoBitrateProfileLookupData
VideoBitrateProfileData
VideoTargetBitrateData
VideoSeekRequestedData
VideoSeekCompletedData
VideoStreamPositionChangedData
VideoErrorData
GeneralErrorData
MetadataLoadingErrorData
VideoPlaybackErrorData
AuthorizationErrorData
AdPodStartedData
AdPodEndedData
AdStartedData
LinearVideoData
NonLinearOverlayData
AdEndedData
AdErrorData
VideoPlayerCreatedData
InitialPlayStartingData
PlaybackReadyData
ApiErrorData
BitrateInitialData
BitrateFiveSecData
BitrateStableData
PlaybackStartErrorData
PlaybackMidstreamErrorData
PluginLoadedData
AdErrorData
AdRequestData
AdRequestSuccssData
AdRequestEmptyData
AdRequestErrorData
AdPlaybackErrorData
AdSdkImpressionData
AdCompletedData
AdSdkLoadedData
AdSdkLoadFailureData
FullscreenChangedData
VolumeChangedData
RecordedEvent
Framework

Namespaces

AD_TYPE
STREAM_TYPE
ERROR_CODE
EVENTS

Events

VIDEO_PLAYER_CREATED

This message is sent when the player is first created.
Parameters:
Name Type Description
paramArray Array Array of length 1, containing the original parameters passed into the player

VIDEO_ELEMENT_CREATED

This message is sent when the video element is first created.

INITIAL_PLAYBACK_REQUESTED

This message is sent the first time the user tries to play the video. In the case of autoplay, it will be sent immediately after the player is ready to play.

VIDEO_CONTENT_COMPLETED

This message is sent when main content playback has completed.

PLAYBACK_COMPLETED

This message is sent when video and ad playback has completed.

VIDEO_PLAY_REQUESTED

This message is sent every time there is a request to try and initiate video playback (except the first time. See VIDEO_FIRST_PLAY_REQUESTED). This is only the request, not when video playback has actually started.

VIDEO_PAUSE_REQUESTED

This message is sent every time there is a request to try and pause the video. This is only the request, not when video playback has actually paused.

VIDEO_PLAYING

This message is sent when video playback has started or resumed.

VIDEO_REPLAY_REQUESTED

This message is sent after VIDEO_ENDED, when the player is requested to start video playback from the beginning of the video. This is only the request, not when the video actually start playing again.

VIDEO_SOURCE_CHANGED

This message is sent when the player has received a new video source to load. This will happen when the first video initially starts to load, when switching video sources during playback and also when switching to a new video after VIDEO_ENDED. This will not be received on VIDEO_REPLAY_REQUESTED.
Parameters:
Name Type Description
paramArray Array Array of length 1, containing an instance of OO.Analytics.EVENT_DATA.VideoSourceData

VIDEO_CONTENT_METADATA_UPDATED

This message is sent when the video content data has been downloaded. This will contain information about the video content. For example, title and description.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.VideoContentMetadata

STREAM_TYPE_UPDATED

This message is sent when the content stream type has been determined by the player.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.StreamTypeMetadata

VIDEO_SEEK_REQUESTED

This message is sent when a video seek is requested.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.VideoSeekRequestedData

VIDEO_SEEK_COMPLETED

This message is sent when a video seek has completed.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.VideoSeekCompletedData

VIDEO_STREAM_DOWNLOADING

This message is sent when a video stream is downloading data. If the stream has to stop because of a buffer underrun, that is considered a buffering event.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.VideoDownloadingMetadata

VIDEO_BUFFERING_STARTED

This message is sent when a video stream has to pause playback to load more data. It is also sent when the stream is buffering before initial playback is started.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.VideoBufferingStartedData

VIDEO_BUFFERING_ENDED

This message is sent when a video stream has buffered and is ready to resume playback.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.VideoBufferingEndedData

VIDEO_STREAM_BITRATE_PROFILES

This message is sent when all of the possible bitrate profiles for a stream are available.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.VideoBitrateProfileLookupData

VIDEO_STREAM_TARGET_BITRATE_REQUESTED

Sent when the a specific bitrate profile is requested. Automatic bitrate selection is "auto".
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.VideoTargetBitrateData

VIDEO_STREAM_BITRATE_CHANGED

This message is sent when the video stream's bitrate changes.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.VideoBitrateProfileData

VIDEO_STREAM_POSITION_CHANGED

This message is sent, periodically, when the video stream position changes.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.VideoStreamPositionChangedData

VIDEO_ERROR

[DEPRECATED] (NOTE: replaced by OO.Analytics.EVENTS.ERROR#VIDEO_PLAYBACK) This message is sent when a video error occurs.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.VideoErrorData

INITIAL_PLAY_STARTING

This message is sent when the player has begun playback for the first time, first frame has been received.

PLAYBACK_READY

This message is sent when the player has indicated that it is in a playback-ready state.

API_ERROR

This message is sent if an api related error has occurred.

BITRATE_INITIAL

This message contains the bitrate used at the start of playback.

BITRATE_FIVE_SEC

This message contains the bitrate used five seconds into playback.

BITRATE_STABLE

This message contains the bitrate used thirty seconds into playback.

PLAYBACK_START_ERROR

This message is sent when a playback error has occurred before the video start.

PLAYBACK_MIDSTREAM_ERROR

This message is sent when a playback error has occurred midstream.

PLUGIN_LOADED

This message is sent when a plugin is loaded in core.

VC_PLUGIN_ERROR

This message is sent when the video plugin has reported an error message.

AD_SDK_LOADED

This message is sent when ad sdk has loaded successfully.

AD_SDK_LOAD_FAILURE

This message is sent when ad sdk has failed to load.

AD_REQUEST

This message is sent when an ad request is sent to the ad sdk.

AD_REQUEST_SUCCESS

This event is sent when an ad request successfully returns an ad or playlist of ads.

AD_REQUEST_ERROR

This event is sent when an ad request fails due to an error.

AD_REQUEST_EMPTY

This event is sent when an ad request returns but contains no ads.

AD_PLAYBACK_ERROR

This event is sent when an ad playback fails due to an error.

AD_SDK_IMPRESSION

This message is sent when an impression is recorded by the ad plugin SDK.

AD_BREAK_STARTED

This message is sent when the player stops the main content to start playing linear ads.

AD_BREAK_ENDED

This message is sent when the player has finished playing ads and is ready to playback the main video.

AD_POD_ENDED

This message is sent when an ad pod ends.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.AdPodEndedData

AD_STARTED

This message is sent when the player starts an ad playback.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.AdStartedData

AD_ENDED

This message is sent when the player ends an ad playback.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.AdEndedData

AD_SKIPPED

This message is sent when an ad is skipped.

AD_ERROR

This message is sent when there is an error during ad playback.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.AdErrorData

AD_IMPRESSION

This message is sent when the ad video element first plays.

AD_COMPLETED

This message is sent when the ad playback is completed.

AD_CLICKTHROUGH_OPENED

This message is sent when an ad clickthrough event has occurred.

FULLSCREEN_CHANGED

This message is sent when the player enters and exits fullscreen.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.FullscreenChangedData

VOLUME_CHANGED

This message is sent when the player volume has changed.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.VolumeChangedData

DESTROY

This message is sent when the player and its plugins are destroying.

ERROR

This property contains different the categories of Ooyala Player Errors.

GENERAL

This message is sent when a general error occurs.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.GeneralErrorData

METADATA_LOADING

This message is sent when a metadata loading error occurs (invalid metadata, invalid content, or a network error when loading metadata).
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.MetadataLoadingError

VIDEO_PLAYBACK

This message is sent when a video playback error occurs.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.VideoPlaybackErrorData

AUTHORIZATION

This message is sent when a stream authorization server (SAS) error occurs.
Parameters:
Name Type Description
paramArray Array Array of length 1, contains an instance of OO.Analytics.EVENT_DATA.AuthorizationErrorData