Added in API level 16
TimedText
class TimedText
| kotlin.Any | |
| ↳ | android.media.TimedText |
Class to hold the timed text's metadata, including:
- The characters for rendering
- The rendering position for the timed text
To render the timed text, applications need to do the following:
- Implement the
MediaPlayer.OnTimedTextListenerinterface - Register the
MediaPlayer.OnTimedTextListenercallback on a MediaPlayer object that is used for playback - When a onTimedText callback is received, do the following:
Summary
| Public methods | |
|---|---|
| Rect! |
Get the rectangle area or region for rendering the timed text as specified by a Rect object. |
| String! |
getText()Get the characters in the timed text. |
Public methods
getBounds
Added in API level 16
fun getBounds(): Rect!
Get the rectangle area or region for rendering the timed text as specified by a Rect object.
| Return | |
|---|---|
Rect! |
the rectangle region to render the characters in the timed text. If no bounds information is available (a null is returned), render the timed text at the center bottom of the display. |
getText
Added in API level 16
fun getText(): String!
Get the characters in the timed text.
| Return | |
|---|---|
String! |
the characters as a String object in the TimedText. Applications should stop rendering previous timed text at the current rendering region if a null is returned, until the next non-null timed text is received. |