akamai.amp.Captioning
The Captioning API.
Members
hidden
:boolean
The hidden flag indicating whether of not the captions are currently displayed.
Methods
changeSettings
changeSettings(object)
Sets a caption Settings Object (styles)
Parameters
Name | Type | Description |
---|---|---|
object |
Object | The caption settings object. |
selectTrackByIndex
selectTrackByIndex(index) → {akamai.amp.Track}
Selects a caption track by its index in the getTracks array.
Parameters
Name | Type | Description |
---|---|---|
index |
number | The index to select |
Returns
- akamai.amp.Track
-
The selected caption track.
selectTrackByLanguage
selectTrackByLanguage(lang) → {akamai.amp.Track}
Selects a caption track by it's language property.
Parameters
Name | Type | Description |
---|---|---|
lang |
string | The language to select |
Returns
- akamai.amp.Track
-
The selected caption track.