CaptioningManager

public class CaptioningManager
extends Object

java.lang.Object
   ↳ android.view.accessibility.CaptioningManager

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. 

Public methods

void addCaptioningChangeListener(CaptioningManager.CaptioningChangeListener listener)

Adds a listener for changes in the user's preferred captioning enabled state and visual properties.

final float getFontScale()
final Locale getLocale()
CaptioningManager.CaptionStyle getUserStyle()
boolean isCallCaptioningEnabled()

Returns true if system wide call captioning is enabled for this device.

final boolean isEnabled()
final boolean isSystemAudioCaptioningEnabled()
final boolean isSystemAudioCaptioningUiEnabled()
void removeCaptioningChangeListener(CaptioningManager.CaptioningChangeListener listener)

Removes a listener previously added using addCaptioningChangeListener(CaptioningChangeListener).

Inherited methods

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

Added in API level 19 
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

Added in API level 19 
public final float getFontScale ()

Returns
float the user's preferred font scaling factor for video captions, or 1 if not specified

getLocale

Added in API level 19 
public final Locale getLocale ()

Returns
Locale the locale for the user's preferred captioning language, or null if not specified

getUserStyle

Added in API level 19 
public CaptioningManager.CaptionStyle getUserStyle ()

Returns
CaptioningManager.CaptionStyle the user's preferred visual properties for captions as a CaptionStyle, or the default style if not specified This value cannot be null.

isCallCaptioningEnabled

Added in API level 33 
public boolean isCallCaptioningEnabled ()

Returns true if system wide call captioning is enabled for this device.

Returns
boolean

isEnabled

Added in API level 19 
public final boolean isEnabled ()

Returns
boolean the user's preferred captioning enabled state

isSystemAudioCaptioningEnabled

Added in API level 33 
public final boolean isSystemAudioCaptioningEnabled ()

Returns
boolean the system audio caption enabled state.

isSystemAudioCaptioningUiEnabled

Added in API level 33 
public final boolean isSystemAudioCaptioningUiEnabled ()

Returns
boolean the system audio caption UI enabled state.

removeCaptioningChangeListener

Added in API level 19 
public void removeCaptioningChangeListener (CaptioningManager.CaptioningChangeListener listener)

Removes a listener previously added using addCaptioningChangeListener(CaptioningChangeListener).

Parameters
listener CaptioningManager.CaptioningChangeListener: the listener to remove This value cannot be null.