Relevant commentary
What you learn
You're instantiating DIVA Player in your web front-end and relying on DIVA Back Office as the video streaming source.
The goal of this article is to build the simplest front-end to stream a video from the DIVA Back Office with relevant commentary data.
Before starting
-
Ensure the DIVA Back Office instance you rely on is up and running.
-
Ask your video engineers team the
<video id>and the related<settings URL>. -
Ensure that, in the settings file, the
generalsection contains the fieldrelevantCommentaryStartsVisible"settings": {"general": {..."relevantCommentaryStartsVisible": true, //default is true...}} -
Ensure that, in the settings file, the
pushenginesection is available like in the following example:
"pushEngine": {
"configUrl": "https://example.com/fe/config/pushengine/pushengineConfig.json", //mandatory
"editorialCollectionName": "Editorial", //optional - it can to overwrite the default value
"editorialScopeName": "{v.id}.{d.Culture}" //optional - it can to overwrite the default value
}
Dictionary
Ensure the dictionary file contains the relevant keys.
Analytics events
Find here the available analytics events for Commentary.
Instantiation
There's no code to add to the Basic instantiation code.
Troubleshooting tips
In case the timeline and commentary don't show data as expected, double-check that pushengine data timecodes are equal or greater than programDateTime in the videoMetadata — get it by exploring Network in the Chrome developer tools — and less than the video duration.