TextTrack
Supported Platform(s)
- BlackBerry OS 6.0+
- BlackBerry PlayBook
| API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| activeCues | Y | Y | Y | ||
| cues | Y | Y | Y | ||
| kind | Y | Y | Y | ||
| label | Y | Y | Y | ||
| language | Y | Y | Y | ||
| mode | Y | Y | Y | ||
| readyState | Y | Y | Y | ||
| NONE | Y | Y | Y | ||
| LOADING | Y | Y | Y | ||
| LOADED | Y | Y | Y | ||
| ERROR | Y | Y | Y | ||
| OFF | Y | Y | Y | ||
| HIDDEN | Y | Y | Y | ||
| SHOWING | Y | Y | Y | ||
| oncuechange | Y | Y | Y | ||
| onenter | Y | Y | Y | ||
| onerror | Y | Y | Y | ||
| onexit | Y | Y | Y | ||
| onload | 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
Events
Properties
oncuechange
| void oncuechange(event : Event) |
Supported Platform(s)
- BlackBerry OS 6.0+- BlackBerry PlayBook
Description
When the current playback position of a media element changes fire an oncuechange event for affected track if the text cue becomes active.
| Parameter | Type | Description |
|---|---|---|
| event | Event |
onenter
| void onenter(event : Event) |
Supported Platform(s)
- BlackBerry OS 6.0+- BlackBerry PlayBook
Description
Fire the onenter event if the current position now includes this text cue.
| Parameter | Type | Description |
|---|---|---|
| event | Event |
onerror
| void onerror(event : Event) |
Supported Platform(s)
- BlackBerry OS 6.0+- BlackBerry PlayBook
Description
Fire the onerror event if an error has occured with this TextTrack. For example loading has failed.
| Parameter | Type | Description |
|---|---|---|
| event | Event |
onexit
| void onexit(event : Event) |
Supported Platform(s)
- BlackBerry OS 6.0+- BlackBerry PlayBook
Description
Fire the onexit event if the current position no longer includes this text cue.
| Parameter | Type | Description |
|---|---|---|
| event | Event |
onload
| void onload(event : Event) |
Supported Platform(s)
- BlackBerry OS 6.0+- BlackBerry PlayBook
Description
Fire the onload if the TextTrack has loaded.
| Parameter | Type | Description |
|---|---|---|
| event | Event |
Properties:
| Property | Type | Description | Supported Platform(s) |
|---|---|---|---|
| activeCues |
TextTrackCueList
readonly |
If the text track mode of the text track that the TextTrack object
represents is not the text track disabled mode, then the activeCues
attribute must return a live TextTrackCueList object that represents
the subset of the text track list of cues of the text track that the
TextTrack object represents whose active flag was set when the
script started, in text track cue order. Otherwise, it must
return null. When an object is returned, the same object must be
returned each time.
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| cues |
TextTrackCueList
readonly |
If the text track mode of the text track that the TextTrack object
represents is not the text track disabled mode, then the cues
attribute must return a live TextTrackCueList object that represents
the subset of the text track list of cues of the text track that
the TextTrack object represents whose start times occur before the
earliest possible position when the script started, in text track
cue order. Otherwise, it must return null. When an object is
returned, the same object must be returned each time.
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| kind |
String
readonly |
Kind is one of the following strings "subtitles", "captions",
"descriptions", "chapters", "metadata".
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| label |
String
readonly |
text track label
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| language |
String
readonly |
Language of the text track.
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| mode | Number | TextTrack.OFF | TextTrack.HIDDEN | TextTrack.SHOWING |
The mode attribute, on getting, must return the numeric value
corresponding to the text track mode of the text track that the
TextTrack object represents.
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| readyState |
Number | TextTrack.NONE | TextTrack.LOADING | TextTrack.LOADED | TextTrack.ERROR
readonly |
The readyState attribute must return the numeric value corresponding to the text track readiness state of the text track
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
Constants:
| Property | Type | Description | Supported Platform(s) |
|---|---|---|---|
| NONE | Number |
The text track not loaded state.
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| LOADING | Number |
The text track loading state.
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| LOADED | Number |
The text track loaded state.
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| ERROR | Number |
The text track failed to load state.
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| OFF | Number |
The text track disabled mode.
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| HIDDEN | Number |
The text track hidden mode.
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| SHOWING | Number |
The text track showing and showing by default modes.
|
- 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)