added in API level 19

Summary: Nested Classes | Methods | Inherited Methods | [Expand All]

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

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this 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 This value may be `null`.

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`.

Jun	JUL	Aug
	18
2016	2017	2018

Most visited

Recently visited

Results for

CaptioningManager

Summary

Nested classes

Public methods

Inherited methods

Public methods

addCaptioningChangeListener

getFontScale

getLocale

getUserStyle

isEnabled

removeCaptioningChangeListener

Interfaces

Classes