Skip to content

Most visited

Recently visited

navigation

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.

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)

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

Inherited methods

From class java.lang.Object

Public methods

addCaptioningChangeListener

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

getFontScale

Added in API level 19
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
Locale getLocale ()

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

getUserStyle

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

isEnabled

Added in API level 19
boolean isEnabled ()

Returns
boolean the user's preferred captioning enabled state

removeCaptioningChangeListener

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

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

Parameters
listener CaptioningManager.CaptioningChangeListener: the listener to remove
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.