DocumentationDynamic Media Viewers Reference Guide

InteractiveVideoViewer interactivevideoviewer

Last update: Wed Mar 09 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User

JavaScript API reference for Interactive Video Viewer.

InteractiveVideoViewer([config])

Constructor, creates an Interactive Video Viewer instance.

Parameters section-4fb77a645fdd45b3aaa5079c31e3bb05

config

{object} optional JSON configuration object, allows all the viewer settings to pass to the constructor to avoid calling individual setter methods. Contains the following properties:

  • containerId - {String} ID of the DOM container (normally a DIV ) into which the viewer is inserted. By the time this method is called, it is not necessary to have the container element created. However, the container must exist when init() is run.

    Required.

  • params - {Object} JSON object with viewer configuration parameters where the property name is either viewer-specific configuration option or SDK modifier, and the value of that property is a corresponding settings value.

    Required.

  • handlers - {Object} JSON object with viewer event callbacks, where the property name is the name of supported viewer event and the property value is a JavaScript function reference to appropriate callback.

    Optional.

    See Event callbacksfor more information about viewer events.

  • localizedTexts - {Object} JSON object with localization data. Optional.

    See Localization of user interface elementsfor more information.

    See also the Viewer SDK User Guide and the example for more information about the object's content.

Returns section-1d3cf85bc7cc4dfe9670e038d02b9101

None.

Example section-9e9332aa86b74a5fb321375c03fdc5b3

var interactiveVideoViewer = new s7viewers.InteractiveVideoViewer({
 "containerId":"s7viewer",
"params":{
 "asset":"/content/dam/mac/aodmarketingna/dm-viewers-content/video/Glacier.mp4",
"config":"/etc/dam/presets/viewer/Shoppable_Video_Dark",
 "serverurl":"https://aodmarketingna.assetsadobe.com/is/image/",
 "videoserverurl":"https://gateway-na.assetsadobe.com/DMGateway/public/aodmarketingna",
 "contenturl":"https://aodmarketingna.assetsadobe.com/",
"interactivedata":"is/content/content/dam/mac/aodmarketingna/_VTT/dm-viewers-content/video/Glacier.mp4.svideo.vtt"
},
"handlers":{
 "initComplete":function() {
  console.log("init complete");
}
},
"localizedTexts":{
"en":{
"VideoPlayer.ERROR":"Your Browser does not support HTML5 Video tag or the video cannot be played."
},
"fr":{
"VideoPlayer.ERROR":"Votre navigateur ne prend pas en charge la vidéo HTML5 tag ou la vidéo ne peuvent pas être lus."
},
defaultLocale:"en"
}
});
recommendation-more-help
b7426f53-aad9-4c00-83fc-664f30f681e8