Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
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)
Removes a listener previously added using addCaptioningChangeListener(CaptioningManager.CaptioningChangeListener) .
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public void addCaptioningChangeListener ( CaptioningManager.CaptioningChangeListener listener)

Adds a listener for changes in the user's preferred captioning enabled state and visual properties.

Parameters
listener the listener to add

public final float getFontScale ()

Returns
  • the user's preferred font scaling factor for video captions, or 1 if not specified

public final Locale getLocale ()

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

public CaptioningManager.CaptionStyle getUserStyle ()

Returns

public final boolean isEnabled ()

Returns
  • the user's preferred captioning enabled state

public void removeCaptioningChangeListener ( CaptioningManager.CaptioningChangeListener listener)

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

Parameters
listener the listener to remove