TimedText | API reference | Android Developers

public final class TimedText
extends Object

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.OnTimedTextListener interface
Register the MediaPlayer.OnTimedTextListener callback on a MediaPlayer object that is used for playback
When a onTimedText callback is received, do the following:
- call getText() to get the characters for rendering
- call getBounds() to get the text rendering area/region

Summary

Public methods
`Rect`	`getBounds()` 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.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

getBounds

public Rect getBounds ()

Get the rectangle area or region for rendering the timed text as specified by a Rect object.

Returns
`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

public String getText ()

Get the characters in the timed text.

Returns
`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.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.