DocumentationDynamic Media Viewers Reference Guide

caption caption

Last update: Tue Sep 14 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User

Parameter common to all viewers.

NOTE
This command does not apply to Video Image Viewer.

caption= *file*[,0|1]

file
Specifies a URL or path to the WebVTT caption content. Image Serving serves up the WebVTT file.
0|1
Specifies 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:

Key
Name
Values
Description
A
test align
left|right|middle|start|end

Controls the alignment of text.

Default is middle .

T
text position
0%-100%

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

Default is 0% .

S
line size
0%-100%

Percentage of video width used for captions.

Default is 100% .

L
line position
0%-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.

file
Specifies 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 .

Properties section-10ee45d637134e0fbcd943c62578cb78

Optional.

Default section-d411e450028c460392cb8508f8ccc5d9

None.

Example section-a8afbf76f8384aa0a83ed1feeccd5b9a

caption=Scene7SharedAssets/adobe_qbc_final_cc,1
recommendation-more-help
b7426f53-aad9-4c00-83fc-664f30f681e8