This interface also inherits properties from EventTarget
.
Documentation TextTrack by Mozilla Contributors, licensed under CC-BY-SA 2.5.
See also:
Variables
read onlyactiveCues:TextTrackCueList
A TextTrackCueList
object listing the currently active set of text track cues. Track cues are active if the current playback position of the media is between the cues' start and end times.
read onlyid:String
A DOMString
which identifies the track, if it has one. If it doesn't have an ID, then this value is an empty string (""
). If the TextTrack
is associated with a track
element, then the track's ID matches the element's ID.
read onlyinBandMetadataTrackDispatchType:String
Returns a DOMString
which indicates the track's in-band metadata track dispatch type. needs details
read onlykind:TextTrackKind
Returns a DOMString
indicating what kind of text track the TextTrack
describes. The value must be one of those in the TextTrackKind enum.
read onlylabel:String
A human-readable DOMString
which contains the text track's label, if one is present; otherwise, this is an empty string (""
), in which case a custom label may need to be generated by your code using other attributes of the track, if the track's label needs to be exposed to the user.
read onlylanguage:String
A DOMString
which specifies the text language in which the text track's contents is written. The value must adhere to the format specified in the Tags for Identifying Languages (BCP 47) document from the IETF, just like the HTML lang
attribute. For example, this can be "en-US"
for United States English or "pt-BR"
for Brazilian Portuguese.
mode:TextTrackMode
A DOMString
specifying the track's current mode. Changing this property's value changes the track's current mode to match. Permitted values are listed under Text track mode constants.
oncuechange:Function
A EventHandler
specifying a function to be called when a cuechange
event occurs. Handling these events lets you know when cues are entered and exited. A given text cue appears when the cue is entered and disappears when the cue is exited.