# Print output for @column tags ?> CaptioningManager - Android SDK | Android Developers

Most visited


Recently visited


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

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

Inherited methods

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

getUserStyle

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.

isEnabled

public final boolean isEnabled ()

Returns
boolean the user's preferred captioning enabled state

removeCaptioningChangeListener

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 cannot be null.

Browse this site in English?

You requested a page in English, but your language preference for this site is English.

Would you like to change your language preference and browse this site in English? If you want to change your language preference later, use the language menu at the bottom of each page.