Stay organized with collections
Save and categorize content based on your preferences.
TimedText
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:
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.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# TimedText\n\nAdded in [API level 16](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nTimedText\n=========\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/media/TimedText \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\n\nfinal\n\nclass\nTimedText\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|-------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.media.TimedText |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nClass to hold the timed text's metadata, including:\n\n- The characters for rendering\n- The rendering position for the timed text\n\nTo render the timed text, applications need to do the following:\n\n- Implement the [MediaPlayer.OnTimedTextListener](/reference/android/media/MediaPlayer.OnTimedTextListener) interface\n- Register the [MediaPlayer.OnTimedTextListener](/reference/android/media/MediaPlayer.OnTimedTextListener) callback on a MediaPlayer object that is used for playback\n- When a onTimedText callback is received, do the following:\n - call [getText()](/reference/android/media/TimedText#getText()) to get the characters for rendering\n - call [getBounds()](/reference/android/media/TimedText#getBounds()) to get the text rendering area/region\n\n\u003cbr /\u003e\n\n**See also:**\n\n- [MediaPlayer](/reference/android/media/MediaPlayer)\n\nSummary\n-------\n\n| ### Public methods ||\n|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` `[Rect](/reference/android/graphics/Rect) | ` `[getBounds](/reference/android/media/TimedText#getBounds())`() ` Get the rectangle area or region for rendering the timed text as specified by a Rect object. |\n| ` `[String](/reference/java/lang/String) | ` `[getText](/reference/android/media/TimedText#getText())`() ` Get the characters in the timed text. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long,%20int))`(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](/reference/java/lang/Object#wait(long))`(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](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic methods\n--------------\n\n### getBounds\n\nAdded in [API level 16](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic Rect getBounds ()\n```\n\nGet the rectangle area or region for rendering the timed text as specified\nby a Rect object.\n\n\u003cbr /\u003e\n\n| Returns ||\n|------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Rect](/reference/android/graphics/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. \u003cbr /\u003e |\n\n### getText\n\nAdded in [API level 16](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic String getText ()\n```\n\nGet the characters in the timed text.\n\n\u003cbr /\u003e\n\n| Returns ||\n|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [String](/reference/java/lang/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. \u003cbr /\u003e |"]]