TextTrackCue


Supported Platform(s)

- BlackBerry OS 6.0+
- BlackBerry PlayBook 1.0+
- BlackBerry 10
- Ripple Emulator
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
getCueAsHTML   Y Y Y Y YY
getCueAsSource   Y Y Y Y YY
endTime   Y Y Y Y YY
id   Y Y Y Y YY
pauseOnExit   Y Y Y Y YY
startTime   Y Y Y Y YY
track   Y Y Y Y YY

Configuration Document Settings

To use all of the API described for this object, you must ensure the following settings are in your configuration document:

This API does not require a <feature> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Permission Elements (PlayBook and BlackBerry 10+)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Functions


Properties

void endTime
Number id
Boolean pauseOnExit
Number startTime
TextTrack track

Functions

void getCueAsHTML ()


Returns the text track cue text as a {DocumentFragment} of HTML elements and other DOM nodes.


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10
 - Ripple Emulator


Return:

String


void getCueAsSource ()


Returns the text track cue text in raw unparsed form.


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10
 - Ripple Emulator


Return:

String


Properties

readonly void endTime


Returns the text track cue end time, in seconds.


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10
 - Ripple Emulator

readonly Number id


Returns the text track cue identifier.


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10
 - Ripple Emulator

readonly Boolean pauseOnExit


Returns true if the text track cue pause-on-exit flag is set, false otherwise.


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10
 - Ripple Emulator

readonly Number startTime


Returns the text track cue start time, in seconds.


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10
 - Ripple Emulator

readonly TextTrack track


Returns the TextTrack object to which this text track cue belongs, if any, or null otherwise.


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10
 - Ripple Emulator

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Feb 11 2013 14:51:10 GMT-0500 (EST)