setVideo

Last update: 2022-03-09
  • Created for:
  • Developer
    User

JavaScript API reference for Video Viewer

setVideo(videoUrl[, data])

Sets new external video and optional additional video data. Can be called at any time, both before and after init(). If called after init(), the viewer swaps the video in run time.

See also init.

Parameters

videoUrl

{ String } an absolute URL to the new video.

data

{ JSON } JSON object with the following optional fields (case-sensitive):

  • posterimage - Image to display on the first frame before the video starts playing. See VideoPlayer.posterimage .
  • caption - Location of the new caption file. If no caption file is specified, the caption button is not displayed in the user interface.
  • navigation - URL or path to WebVTT navigation content. The WebVTT file should be served by Image Serving.

Returns

None.

Example

<instance>.setVideo("https://s7d9.scene7.com/is/content/Scene7SharedAssets/Glacier_Climber_MP4")

On this page