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.

Instances of this class must be obtained using Context.getSystemService(Class) with the argument CaptioningManager.class or Context.getSystemService(String) with the argument Context.CAPTIONING_SERVICE.

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()
final boolean isEnabled()
void removeCaptioningChangeListener(CaptioningManager.CaptioningChangeListener listener)

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

Inherited methods

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 must never 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 CaptioningManager.CaptionStyle, or the default style if not specified

This value will never be null.

isEnabled

added in API level 19
public final boolean isEnabled ()

Returns
boolean the user's preferred captioning enabled state

removeCaptioningChangeListener

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

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

Parameters
listener CaptioningManager.CaptioningChangeListener: the listener to remove

This value must never be null.