Android APIs
public class

CaptioningManager

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

Class Overview

Contains methods for accessing and monitoring preferred video captioning state and visual properties.

To obtain a handle to the captioning manager, do the following:

CaptioningManager captioningManager =
        (CaptioningManager) context.getSystemService(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)
[Expand]
Inherited Methods
From class java.lang.Object

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 CaptioningManager.CaptioningChangeListener: the listener to add

public final float getFontScale ()

Added in API level 19

Returns
float 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
Locale the locale for the user's preferred captioning language, or null if not specified

public CaptioningManager.CaptionStyle getUserStyle ()

Added in API level 19

Returns
CaptioningManager.CaptionStyle 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
boolean the user's preferred captioning enabled state

public void removeCaptioningChangeListener (CaptioningManager.CaptioningChangeListener listener)

Added in API level 19

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

Parameters
listener CaptioningManager.CaptioningChangeListener: the listener to remove