Command reference – Configuration attributes
Last update: November 3, 2023
CREATED FOR:
- Developer
- User
Configuration attributes documentation for Interactive Video Viewer.
Any configuration command can be set in URL or using setParam()
, or setParams()
, or both, API methods. Any config attribute can also be specified in the server-side configuration record.
Some configuration commands may be prefixed with the class name or instance name of corresponding Viewer SDK component. An instance name of the component is dynamic and depends on the ID of the viewer container DOM element passed to setContainerId()
API method. Documentation includes an optional prefix for such commands. For example, playback
command is documented as follows:
[VideoPlayer.|<containerId>_videoPlayer].playback
And means that you can use the following command as:
playback
(short syntax)VideoPlayer.playback
(qualified with component class name)cont_videoPlayer.playback
(qualified with component ID, assumingcont
is the ID of the container element)