Understand how DIVA Player is launched within integrated applications.*
This article explains how the DIVA Player is launched from within integrated applications.
The following topics are covered here:
How is DIVA Player launched?
Sitting within applications, DIVA Player launches when a user selects a call to action (CTA) or a video stream. DIVA’s unique interface takes control of the screen from the launch point, where video features are accessed.
Select a video from an integrated application or web page
DIVA Player launches when a video stream is selected (via a CTA, link, or entry point) from an integrated application. This action starts the Instantiation process and the video player interface displays.
Each time the video player launches, the Instantiation workflow repeats. For more information, see Instantiation workflow and sessions. Before end users can consume the selected video, several further steps are carried out:
Step 1: Player launch
The host application instantiates DIVA by calling parameters. Developers integrate DIVA with their Host Application and set it up by providing Settings (DIVA 5), or configurationFileURL (DIVA 4), Dictionary, and VideoMetadata, fitting their specific setup and video workflow. More on these parameters below.
The Settings file, allows integrators to enable/disable DIVA features and configure specific feature parameters.
The Dictionary file (DIVA 5), allows DIVA to localize the player experience and contains the supported label translations. In DIVA 4 setups, we call this the Vocabulary file.
The VideoMetadata file contains all metadata about the video, including the title, description, thumbnails, video URL, etc.
Note: additional parameters depend on project specifics, including further options, e.g., to open video streams from a specific moment in time via resume points and deep links. For additional technical configuration information, see the DIVA dev hub.
Step 2: Player instantiation workflow and sessions
The Instantiation workflow is repeated each time the video player launches. The scenarios that determine the behavior of the workflows include:
Remaining in the same Player session
Part of the Instantiation workflow is repeated when switching videos within the video player, by selecting a video list or an alert; this is known as the same DIVA session. DIVA internally changes the current videoID and only redownloads the video data for the newly selected video.
Closing and reopening the Player
If users leave the video player and return to the original integrated application, the Instantiation workflow restarts upon the user selecting a video stream (this is considered a new DIVA session). Both the Configuration file and the Dictionary are re-downloaded.
The entitlement check (DIVA 4 only)
Note: entitlement checks are managed outside of DIVA.
Several factors determine whether video playback is approved. The function and role of the entitlement service provides an answer to the question, "Can I watch this video?". The entitlement layer is project-specific and is not installed by default.
The entitlement service is responsible for:
- Collecting meaningful information based on logic, e.g., subscriptions, geo-locations
- Adding extra parameters to the video URL
DIVA 4 Player is instantiated with reference to:
- The Settings file URL
- The videoID
- A reference to the user (in any form: plain id, jwt token, ...)
If the request is valid, the Entitlement service can apply its own logic to either grant or deny the user access to the video stream.
What happens after a successful Entitlement check?
After a successful Entitlement check, users can play the selected content.
If the entitlement response is successful, the ContentURL fields should contain a valid (playable) URL (typically the URL of the manifest, including potential CDN-based protection mechanisms). If the video is DRM protected, the AuthToken field should contain the authorization header to request the license.
See our DIVA 5 feature articles for more information. For technical documentation, including SDKs and APIs, visit our DIVA developer hub.