TextTrackCueList

A TextTrackCueList object represents a dynamically updating list of TextTrackCues in a given order.

Supported Platform(s)

- BlackBerry OS 6.0+
- BlackBerry PlayBook

View Supported Platform Table

APIOS 5.0OS 6.0OS 7.0PlayBookRipple
[]   Y Y Y 
getCueById   Y Y Y 
length   Y Y Y 

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 Only)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

API Summary


Functions


Properties

[]


TextTrackCue [Index : Number]

Supported Platform(s)

 - BlackBerry OS 6.0+
 - BlackBerry PlayBook

Description

Returns the TextTrackCue with index index from the list.



Returns

The TextTrackCue with index index from the list.

Parameter Type Description
Index Number the identifier of the text track cue to fetch.

Throws Description
IndexOutOfBoundsException When the index is invalid.

getCueById


void getCueById(id : String)

Supported Platform(s)

 - BlackBerry OS 6.0+
 - BlackBerry PlayBook

Description

Returns the number of cues in the list.



Returns

TextTrackCue

Parameter Type Description
id String Returns the first text track cue (in text track cue order) with text track cue identifier id. Returns null if none of the cues have the given identifier or if the argument is the empty string.

Properties:


Property Type Description Supported Platform(s)
length Number
readonly
Returns the number of cues in the list.
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:20 GMT-0500 (EST)