Video Session API Diagram for JavaScript VideoJS Module

Conviva.Analytics.init(customerKey, null, settings);

Initialize the top-level object.

Conviva.Analytics.buildVideoAnalytics();

This object needs to be instantiated once for each video playback, and is used to report the video-related events in an application. Typically, it is instantiated after the init() call, and ideally just before the user hits play.

videoAnalytics.setPlayerInfo(playerInfo):

Call this API to set the Predefined metadata.

Call this API to set the Device metadata. To know about the values for device metadata constants, such as device Model and Category, refer to the API reference document, and search for the desired constant.

videoAnalytics.setContentInfo(contentInfo);

Call this API to update or amend metadata.

videoAnalytics.setPlayer(videojs);

Set VideoJS player reference to Conviva video analytics object. If Core SDK and Video.js module are loaded in private scope instead of global scope, then pass the Video.js module object as the second argument:

videoAnalytics.setPlayer(videojs, convivaVideojsModuleObj);

videoAnalytics.reportPlaybackRequested(/* object */ contentInfo);

Call this API when:

• User clicks the video play button

• Video starts in auto-play mode

• User replays video

• A new video starts in play list

It's critical to make this API call correctly to monitor the video experience. For example, if the call is delayed (say, when the video starts rather than the user clicking play*), the Video Startup Time will be under-reported and the Video Start Failures will be missed.

videoAnalytics.reportAdBreakStarted(/* Conviva.Constants.AdType / adType, / Conviva.Constants.AdPlayer */ adPlayer):

Required, if your application has Ads.

Inform videoAnalytics object that an ad break has been started.

videoAnalytics.reportAdBreakEnded();

Only applicable for custom ad integration, don't call for ad modules. For more details, refer to the Ad session diagrams.

videoAnalytics.reportPlaybackEnded();

Call this when the video play back ends.

videoAnalytics.reportPlaybackMetric(string key, Object val);

Most of the metrics such as player states, seek, buffering, are automatically collected.

However, there are these metrics that you need to report for VideoJS module:

Report frequently the rendered frame rate

videoAnalytics.reportPlaybackMetric(Conviva.Constants.Playback.CDN_IP, val);

Report the CDN IP address

videoAnalytics.reportPlaybackEvent(Conviva.Constants.Events.USER_WAIT_STARTED); Optional when the video playback request halts due to user dialogues like pin popup, accepting strong language or violence, or confirming age.

videoAnalytics.reportPlaybackEvent(Conviva.Constants.Events.USER_WAIT_ENDED); Optional when the user wait time ends

Conviva.Analytics.reportAppBackgrounded(); To handle backgrounding events such as pressing home or power off buttons, or attending a phone call

Conviva.Analytics.reportAppForegrounded(); To handle foregrounding events

VideoJS module auto-collects the reportPlaybackErrors. Need not report them.

videoAnalytics.reportPlaybackFailed(errorMessage, contentInfo);

When the playback has FATAL errors from which it does not recover, invoke this method, which internally closes the video session.

For more details about the custom playback events, reach out to your Conviva representative.

videoAnalytics.release();

Conviva.Analytics.release();

Call these APIs to release the object on player's sudden exit, application's graceful exit, or when the Conviva object needs to be destroyed.