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);
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
|
Inherited methods | |
---|---|
From
class
java.lang.Object
|
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
|
float getFontScale ()
Returns | |
---|---|
float |
the user's preferred font scaling factor for video captions, or 1 if not specified |
Locale getLocale ()
Returns | |
---|---|
Locale |
the locale for the user's preferred captioning language, or null if not specified |
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
|
boolean isEnabled ()
Returns | |
---|---|
boolean |
the user's preferred captioning enabled state |
void removeCaptioningChangeListener (CaptioningManager.CaptioningChangeListener listener)
Removes a listener previously added using
addCaptioningChangeListener(CaptioningManager.CaptioningChangeListener)
.
Parameters | |
---|---|
listener |
CaptioningManager.CaptioningChangeListener :
the listener to remove
|