VideoViewer

Last update: March 9, 2022

CREATED FOR:

  • Developer
  • User

JavaScript API reference for Video Viewer.

VideoViewer([config])

Constructor; creates a new Video Viewer instance.

Parameters

config

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

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

  • params - {Object} JSON object with viewer configuration parameters where the property name is either a viewer-specific configuration option or an 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 an appropriate callback. Optional.

    See Event callbacksfor more information about viewer events.

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

    See Viewer SDK namespacefor more information.

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

Returns

None.

Example 

var videoViewer = new s7viewers.VideoViewer({
 "containerId":"s7viewer",
"params":{
 "asset":"Scene7SharedAssets/Glacier_Climber_MP4",
 "serverurl":"http://s7d1.scene7.com/is/image/",
 "videoserverurl":"http://s7d1.scene7.com/is/content/"
},
"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"
}
});

Experience Manager