DIVA Player usage
What you learn
Learn how DIVA Player is used in the AXIS application.
Before starting
- Ensure your project is checked out into your local workspace.
- Install all project dependencies.
Instantiation
Video playback is managed by DIVA Player, replacing the legacy AXIS player. DIVA Player is set as the default player in a new AXIS application, controlled by the CLIENT_DIVA_ENABLED environment variable.
CLIENT_DIVA_ENABLED = true;
DIVA Player is injected into AXIS from a separate package provided by the DIVA team. The current version of DIVA Player is 5.8.2.
The player setup is defined in the related page entry export from the playback feature module, based on the environment variable configuration:
function getPlayerStandardEntry(configAPI: IConfigAPI<PlaybackModuleConfig>) {
return configAPI.getModule().get('isDivaEnabled') ? getDivaPlayerComponent() : FullScreenPlayerStandard;
}
export function getPageEntries(configAPI: IConfigAPI<PlaybackModuleConfig>) {
return {
'RW': {
[PlayerStandardEntryTemplate]: getPlayerStandardEntry(configAPI),
// other entries...
},
'TV': {},
};
}
The DivaPlayerComponent offers an option to use either the standard DIVA Web Player or DIVA Player with BO (Back Office) adapter.
BO Settings Configuration
The CLIENT_DIVA_BO_SETTING_BASE_PATH environment variable is used to define the BO adapter settings path:
CLIENT_DIVA_BO_SETTING_BASE_PATH = https://path.to.bo.settings;
DIVA Player also exports a rich configuration API for both the standard and BO player workflows. Additionally, it supports two analytics plugins, Conviva and Youbora, for video analytics data consumption.
Check the next section for more details on DIVA Player configuration.