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.

Nested Classes

class

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()
final boolean	isEnabled()
void	removeCaptioningChangeListener(CaptioningManager.CaptioningChangeListener listener) Removes a listener previously added using `addCaptioningChangeListener(CaptioningManager.CaptioningChangeListener)`.

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()

final boolean

isEnabled()

void

removeCaptioningChangeListener(CaptioningManager.CaptioningChangeListener listener)

Removes a listener previously added using addCaptioningChangeListener(CaptioningManager.CaptioningChangeListener).

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public void addCaptioningChangeListener (CaptioningManager.CaptioningChangeListener listener)

Added in API level 19

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

Parameters

listener	the listener to add

public final float getFontScale ()

Added in API level 19

Returns

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

public final Locale getLocale ()

Added in API level 19

Returns

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

public CaptioningManager.CaptionStyle getUserStyle ()

Added in API level 19

Returns

the user's preferred visual properties for captions as a CaptioningManager.CaptionStyle, or the default style if not specified

public final boolean isEnabled ()

Added in API level 19

Returns

the user's preferred captioning enabled state

Results

Interfaces

Classes

Class Overview

Summary

Public Methods

public void addCaptioningChangeListener (CaptioningManager.CaptioningChangeListener listener)

Parameters

public final float getFontScale ()

Returns

public final Locale getLocale ()

Returns

public CaptioningManager.CaptionStyle getUserStyle ()

Returns

public final boolean isEnabled ()

Returns

public void removeCaptioningChangeListener (CaptioningManager.CaptioningChangeListener listener)

Parameters

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