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.

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

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

This value must never be null.

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

This value will never be null.

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 value must never be null.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

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

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

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 short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)