caption
CREATED FOR:
- Developer
- User
URL command for Interactive Video Viewer.
caption= *file*[,0|1]
The viewer supports closed captioning through hosted WebVTT files. Overlapping cues and regions are not supported. Supported cue positioning operators include the following:
| Key | Name | Value | Description |
|---|---|---|---|
| A | text align | left|right|middle|start|end |
Control text alignment. 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 (no percent sign), then it is the number of lines from the top where the text is displayed. If it is a percentage (the percent sign is the last character), then the caption text is displayed that percent down the display area. Default is 100%. |
Other WebVTT features present in the WebVTT file are not supported, but should not disrupt the captioning.
| file | Specifies a URL or path to the WebVTT caption content. Serve the WebVTT file by Image Serving. |
| 0|1 | Specifies the default caption state (enabled is 1 ). |
Properties
Optional.
Default
None.
Example
caption=is/content/content/dam/mac/aodmarketingna/_VTT/dm-viewers-content/video/Glacier.mp4.caption.vtt,1