web.vtt.VTTCue
This interface also inherits properties from web.media.TextTrackCue.
This interface also inherits properties from `web.media.TextTrackCue`.
constructorcljs
(constructor & args)Constructor.
The VTTCue() constructor creates and returns a new web.vtt.VTTCue object.
startTime
This is a double representing the initial text track cue start time. This is the time, given in seconds and fractions of a second, denoting the beginning of the range of the media data to which this cue applies. For example, if a cue is to be visible from 50 seconds to a one minute, five and a half seconds in the media's playback, startTime will be 50.0.
endTime
This is a double representing the ending time for this text track cue. This is the time at which the cue should stop being presented to the user, given in seconds and fractions thereof. Given the example cue mentioned under startTime, the value of endTime would be 65.5.
text
A web.DOMString providing the text that will be shown during the time span indicated by startTime and endTime.
See also: https://developer.mozilla.org/en-US/docs/Web/API/VTTCue/VTTCue
Constructor. The VTTCue() constructor creates and returns a new `web.vtt.VTTCue` object. startTime This is a double representing the initial text track cue start time. This is the time, given in seconds and fractions of a second, denoting the beginning of the range of the media data to which this cue applies. For example, if a cue is to be visible from 50 seconds to a one minute, five and a half seconds in the media's playback, startTime will be 50.0. endTime This is a double representing the ending time for this text track cue. This is the time at which the cue should stop being presented to the user, given in seconds and fractions thereof. Given the example cue mentioned under startTime, the value of endTime would be 65.5. text A `web.DOMString` providing the text that will be shown during the time span indicated by startTime and endTime. See also: `https://developer.mozilla.org/en-US/docs/Web/API/VTTCue/VTTCue`
get-cue-as-htmlcljs
(get-cue-as-html this & args)Method.
Returns the cue text as a DocumentFragment.
Method. Returns the cue text as a DocumentFragment.
linecljs
(line this)Property.
Returns the line positioning of the cue. This can be the string or a number whose interpretation depends on the value of VTTCue.snapToLines.
Property. Returns the line positioning of the cue. This can be the string or a number whose interpretation depends on the value of VTTCue.snapToLines.
line-aligncljs
(line-align this)Property.
Returns an enum representing the alignment of the VTTCue.line.
Property. Returns an enum representing the alignment of the VTTCue.line.
positioncljs
(position this)Property.
Returns the indentation of the cue within the line. This can the string auto or a number representing the percentage of the or the video size if VTTCue.region is null.
Property. Returns the indentation of the cue within the line. This can the string auto or a number representing the percentage of the or the video size if VTTCue.region is null.
position-aligncljs
(position-align this)Property.
Returns an enum representing the alignment of the cue. This is to determine what the VTTCue.position is anchored to. The default auto.
Property. Returns an enum representing the alignment of the cue. This is to determine what the VTTCue.position is anchored to. The default auto.
regioncljs
(region this)Property.
A VTTRegion object describing the video's sub-region that the will be drawn onto, or null if none is assigned.
Property. A VTTRegion object describing the video's sub-region that the will be drawn onto, or null if none is assigned.
set-line!cljs
(set-line! this val)Property.
Returns the line positioning of the cue. This can be the string or a number whose interpretation depends on the value of VTTCue.snapToLines.
Property. Returns the line positioning of the cue. This can be the string or a number whose interpretation depends on the value of VTTCue.snapToLines.
set-line-align!cljs
(set-line-align! this val)Property.
Returns an enum representing the alignment of the VTTCue.line.
Property. Returns an enum representing the alignment of the VTTCue.line.
set-position!cljs
(set-position! this val)Property.
Returns the indentation of the cue within the line. This can the string auto or a number representing the percentage of the or the video size if VTTCue.region is null.
Property. Returns the indentation of the cue within the line. This can the string auto or a number representing the percentage of the or the video size if VTTCue.region is null.
set-position-align!cljs
(set-position-align! this val)Property.
Returns an enum representing the alignment of the cue. This is to determine what the VTTCue.position is anchored to. The default auto.
Property. Returns an enum representing the alignment of the cue. This is to determine what the VTTCue.position is anchored to. The default auto.
set-region!cljs
(set-region! this val)Property.
A VTTRegion object describing the video's sub-region that the will be drawn onto, or null if none is assigned.
Property. A VTTRegion object describing the video's sub-region that the will be drawn onto, or null if none is assigned.
set-size!cljs
(set-size! this val)Property.
Returns a double representing the size of the cue, as a percentage the video size.
Property. Returns a double representing the size of the cue, as a percentage the video size.
set-snap-to-lines!cljs
(set-snap-to-lines! this val)Property.
Returns true if the VTTCue.line attribute is an integer number lines or a percentage of the video size.
Property. Returns true if the VTTCue.line attribute is an integer number lines or a percentage of the video size.
set-text!cljs
(set-text! this val)Property.
Returns a DOMString with the contents of the cue.
Property. Returns a DOMString with the contents of the cue.
set-text-align!cljs
(set-text-align! this val)Property.
Returns an enum representing the alignment of all the lines of within the cue box.
Property. Returns an enum representing the alignment of all the lines of within the cue box.
set-vertical!cljs
(set-vertical! this val)Property.
Returns an enum representing the cue writing direction.
Property. Returns an enum representing the cue writing direction.
sizecljs
(size this)Property.
Returns a double representing the size of the cue, as a percentage the video size.
Property. Returns a double representing the size of the cue, as a percentage the video size.
snap-to-linescljs
(snap-to-lines this)Property.
Returns true if the VTTCue.line attribute is an integer number lines or a percentage of the video size.
Property. Returns true if the VTTCue.line attribute is an integer number lines or a percentage of the video size.
textcljs
(text this)Property.
Returns a DOMString with the contents of the cue.
Property. Returns a DOMString with the contents of the cue.
text-aligncljs
(text-align this)Property.
Returns an enum representing the alignment of all the lines of within the cue box.
Property. Returns an enum representing the alignment of all the lines of within the cue box.
verticalcljs
(vertical this)Property.
Returns an enum representing the cue writing direction.
Property. Returns an enum representing the cue writing direction.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close