The following page contains instructions on how to integrate using Xbox MediaPlayer/MediaElement library for a few advanced use cases, such as reporting live program and playlist changes, fatal errors, etc. After completing the initial stream sensor integration, use these instructions as an add-on to achieve specific goals.
Report Live, Live Linear, or FAST Program Changes
Report program changes during live, live linear, or FAST streaming
Users may switch from one program to another at the program boundary either during live or live linear streaming. To report such changes, use the WinClient.updateContentInfo(sessionId, contentInfo) API and update the asset name that has changed at the program boundary.
The following is the sample code:
// update ASSET_NAME and any other metadata that has changed.
WinContentInfo contentInfo = new WinContentInfo();
contentInfo.setAssetName("Asset name of the next program");
WinClient.updateContentInfo(sessionId, contentInfo);
Report Playlist Changes
Report video changes in playlist
Users may switch from one playlist item to another during streaming. To report these changes, close the previous session and open a new session using the WinClient.createSession(contentInfo) API.
The following is the sample code:
// close the previous session
...
// open a new session with new metadata
...
WinContentInfo contentInfo = new WinContentInfo();
contentInfo.setAssetName("Next playlist item");
SessionID sessionId = WinClient.createSession(contentInfo);
Report Errors
Playback does not recover from error and is reported once only
Playback encounters a fatal error from which it does not recover. Use the WinClient.reportError(sessionId, errorMessage, WinErrorSeverity.FATAL) API to report this to Conviva, so that Conviva can close the monitoring session.
The following is the sample code:
WinClient.reportError(sessionId, errorMessage, WinErrorSeverity.FATAL);
WinClient.cleanupSession(sessionId);
Retry - Playback does not recover from error and fatal errors are reported multiple times
Playback encounters an initial fatal error from which it does not recover. However, an application or player timeout triggers a retry behavior. In such a use case, invoke the WinClient.reportError(sessionId, errorMessage, WinErrorSeverity.FATAL) API to report each error to Conviva, so that Conviva can keep the session active until all retry attempts are exhausted. When no more retries are available from the application's perspective, the Conviva monitoring session is closed.
The following is the sample code:
// retry attempt 1, after first fatal error
WinClient.reportError(sessionId, errorMessage_1, WinErrorSeverity.FATAL);
// retry attempt 2, after second fatal error
WinClient.reportError(sessionId, errorMessage_2, WinErrorSeverity.FATAL);
// retry attempt 3, after 3rd fatal error
WinClient.reportError(sessionId, errorMessage_3, WinErrorSeverity.FATAL);
.
.
.
// retry attempt n, after nth fatal error and the app has no more retries
WinClient.reportError(sessionId, errorMessage_n, WinErrorSeverity.FATAL);
WinClient.cleanupSession(sessionId);
Player errors are auto collected by the library.
Playback recovers from a fatal error by switching to a different asset URL
Playback has encountered an error and on retrying with a different asset url, it recovered during the same playback session. In such cases, use the WinClient.reportError(sessionId, errorMessage, WinErrorSeverity.FATAL) API to report the error and WinClient.updateContentInfo(sessionId, contentInfo) API to update the stream URL once the playback has recovered.
The following is the sample code:
WinClient.reportError(sessionId, errorMessage, WinErrorSeverity.FATAL);
..
WinContentInfo contentInfo = new WinContentInfo();
contentInfo.setStreamURL("UPDATED_STREAM_URL");
WinClient.updateContentInfo(sessionId, contentInfo);
Player errors are auto collected by the library.
Playback recovery in multi CDN scenario
Playback has encountered an error and on retrying with a different CDN, it recovered during the same playback session. In such cases, use the WinClient.reportError(sessionId, errorMessage, WinErrorSeverity.FATAL) API to report the error and WinClient.updateContentInfo(sessionId, contentInfo) API to update the stream URL corresponding to the newer CDN once the playback has recovered.
The following is the sample code:
WinClient.reportError(sessionId, errorMessage, WinErrorSeverity.FATAL);
..
WinContentInfo contentInfo = new WinContentInfo();
contentInfo.setStreamURL("UPDATED_STREAM_URL");
WinClient.updateContentInfo(sessionId, contentInfo);
Player errors are auto collected by the library.
Playback is not impacted due to a warning error type
The player or application encountered an error that does not impact video playback. However, if you still want to report it, then ensure to report it as WARNING. Invoke the WinClient.reportError(sessionId, errorMessage, WinErrorSeverity.WARNING) API to report the error severity as a warning.
The following is the sample code:
WinClient.reportError(sessionId, errorMessage, WinErrorSeverity.WARNING);
Player errors are auto collected by the library.
Optimize Monitoring During User Wait State
User Actions: User Dialogues
Conviva prefers to optimize certain portions of monitoring during user wait state, so that it does not inaccurately reflect in metrics like VST. For that, monitoring must be turned off when video playback request is halted due to user dialogues like:
pin popup
accepting strong language or violence
confirming age
startover or resume dialogue
watch party initiation
These user dialogues can be handled using the following APIs:
On user wait started:
WinClient.detachPlayer(sessionId);
WinClient.adStart(sessionId);
On user wait ended:
WinClient.adEnd(sessionId);
WinClient.attachPlayer(sessionId, playerProxy);