caption

Last update: September 14, 2021

CREATED FOR:

  • Developer
  • User

Parameter common to all viewers.

NOTE
This command does not apply to Video Image Viewer.

caption= *file*[,0|1]

fileSpecifies a URL or path to the WebVTT caption content. Image Serving serves up the WebVTT file.
0|1Specifies the default caption state. Enabled is 1 .

This viewer supports closed captioning by way of hosted WebVTT files. Captions specified with this parameter apply to the video that comes first in media sets; subsequent videos play without captions. Overlapping cues and regions are not supported. Supported cue positioning operators:

KeyNameValuesDescription
Atest alignleft|right|middle|start|end

Controls the alignment of text.

Default is middle .

Ttext position0%-100%

Percentage of inset into the VideoPlayer component for the beginning of the caption text.

Default is 0% .

Sline size0%-100%

Percentage of video width used for captions.

Default is 100% .

Lline position0%-100%|integer

Determines the line position on the page.

If it is expressed as an integer with no percent sign, then it is the number of lines from the top where the text is displayed.

If it is expressed as a percentage - the percent sign is the last character - then the caption text is displayed that percent down the display area.

Default is 100% .

If there are any other WebVTT features present within the WebVTT file, they are not supported; however, they do not disrupt captioning.

fileSpecifies a URL or path to WebVTT caption content. The WebVTT file is served by Image Serving.
0|1

Specifies the default caption state.

Enabled is 1 .