CaptioningManager
public class CaptioningManager
extends Object
Contains methods for accessing and monitoring preferred video captioning state and visual properties.
Summary
Nested classes |
|---|
class | CaptioningManager.CaptionStyle Specifies visual properties for video captions, including foreground and background colors, edge properties, and typeface. |
class | CaptioningManager.CaptioningChangeListener Listener for changes in captioning properties, including enabled state and user style preferences. |
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
addCaptioningChangeListener
public void addCaptioningChangeListener (CaptioningManager.CaptioningChangeListener listener)
Adds a listener for changes in the user's preferred captioning enabled state and visual properties.
| Parameters |
|---|
listener | CaptioningManager.CaptioningChangeListener: the listener to add This value cannot be null. |
getFontScale
public final float getFontScale ()
| Returns |
|---|
float | the user's preferred font scaling factor for video captions, or 1 if not specified |
getLocale
public final Locale getLocale ()
| Returns |
|---|
Locale | the locale for the user's preferred captioning language, or null if not specified |
isCallCaptioningEnabled
public boolean isCallCaptioningEnabled ()
Returns true if system wide call captioning is enabled for this device.
isEnabled
public final boolean isEnabled ()
| Returns |
|---|
boolean | the user's preferred captioning enabled state |
isSystemAudioCaptioningEnabled
public final boolean isSystemAudioCaptioningEnabled ()
| Returns |
|---|
boolean | the system audio caption enabled state. |
isSystemAudioCaptioningUiEnabled
public final boolean isSystemAudioCaptioningUiEnabled ()
| Returns |
|---|
boolean | the system audio caption UI enabled state. |
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."],[],[]]
