Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/view/accessibility/CaptioningManager#nestedclasses) \| [Methods](https://developer.android.com/reference/android/view/accessibility/CaptioningManager#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/view/accessibility/CaptioningManager#inhmethods)

# CaptioningManager

*** ** * ** ***

` public class CaptioningManager `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.view.accessibility.CaptioningManager |

<br />

*** ** * ** ***

Contains methods for accessing and monitoring preferred video captioning state and visual properties.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/view/accessibility/CaptioningManager.CaptionStyle` Specifies visual properties for video captions, including foreground and background colors, edge properties, and typeface. |
| ` class` | `https://developer.android.com/reference/android/view/accessibility/CaptioningManager.CaptioningChangeListener` Listener for changes in captioning properties, including enabled state and user style preferences. |

| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/view/accessibility/CaptioningManager#addCaptioningChangeListener(android.view.accessibility.CaptioningManager.CaptioningChangeListener)(https://developer.android.com/reference/android/view/accessibility/CaptioningManager.CaptioningChangeListener listener) ` Adds a listener for changes in the user's preferred captioning enabled state and visual properties. |
| ` final float` | ` https://developer.android.com/reference/android/view/accessibility/CaptioningManager#getFontScale()() ` |
| ` final https://developer.android.com/reference/java/util/Locale` | ` https://developer.android.com/reference/android/view/accessibility/CaptioningManager#getLocale()() ` |
| ` https://developer.android.com/reference/android/view/accessibility/CaptioningManager.CaptionStyle` | ` https://developer.android.com/reference/android/view/accessibility/CaptioningManager#getUserStyle()() ` |
| ` boolean` | ` https://developer.android.com/reference/android/view/accessibility/CaptioningManager#isCallCaptioningEnabled()() ` Returns true if system wide call captioning is enabled for this device. |
| ` final boolean` | ` https://developer.android.com/reference/android/view/accessibility/CaptioningManager#isEnabled()() ` |
| ` final boolean` | ` https://developer.android.com/reference/android/view/accessibility/CaptioningManager#isSystemAudioCaptioningEnabled()() ` |
| ` final boolean` | ` https://developer.android.com/reference/android/view/accessibility/CaptioningManager#isSystemAudioCaptioningUiEnabled()() ` |
| ` void` | ` https://developer.android.com/reference/android/view/accessibility/CaptioningManager#removeCaptioningChangeListener(android.view.accessibility.CaptioningManager.CaptioningChangeListener)(https://developer.android.com/reference/android/view/accessibility/CaptioningManager.CaptioningChangeListener listener) ` Removes a listener previously added using `https://developer.android.com/reference/android/view/accessibility/CaptioningManager#addCaptioningChangeListener(android.view.accessibility.CaptioningManager.CaptioningChangeListener)`. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Public methods

### addCaptioningChangeListener

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void addCaptioningChangeListener (CaptioningManager.CaptioningChangeListener listener)
```

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

<br />

| Parameters ||
|---|---|
| `listener` | `CaptioningManager.CaptioningChangeListener`: the listener to add. This value cannot be `null`. <br /> |

### getFontScale

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final float getFontScale ()
```

<br />

<br />

| Returns ||
|---|---|
| `float` | the user's preferred font scaling factor for video captions, or 1 if not specified <br /> |

### getLocale

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final Locale getLocale ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Locale` | the locale for the user's preferred captioning language, or null if not specified <br /> |

### getUserStyle

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CaptioningManager.CaptionStyle getUserStyle ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/view/accessibility/CaptioningManager.CaptionStyle` | the user's preferred visual properties for captions as a `https://developer.android.com/reference/android/view/accessibility/CaptioningManager.CaptionStyle`, or the default style if not specified. This value cannot be `null`. <br /> |

### isCallCaptioningEnabled

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isCallCaptioningEnabled ()
```

Returns true if system wide call captioning is enabled for this device.

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### isEnabled

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final boolean isEnabled ()
```

<br />

<br />

| Returns ||
|---|---|
| `boolean` | the user's preferred captioning enabled state <br /> |

### isSystemAudioCaptioningEnabled

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final boolean isSystemAudioCaptioningEnabled ()
```

<br />

<br />

| Returns ||
|---|---|
| `boolean` | the system audio caption enabled state. <br /> |

### isSystemAudioCaptioningUiEnabled

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final boolean isSystemAudioCaptioningUiEnabled ()
```

<br />

<br />

| Returns ||
|---|---|
| `boolean` | the system audio caption UI enabled state. <br /> |

### removeCaptioningChangeListener

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void removeCaptioningChangeListener (CaptioningManager.CaptioningChangeListener listener)
```

Removes a listener previously added using `https://developer.android.com/reference/android/view/accessibility/CaptioningManager#addCaptioningChangeListener(android.view.accessibility.CaptioningManager.CaptioningChangeListener)`.

<br />

| Parameters ||
|---|---|
| `listener` | `CaptioningManager.CaptioningChangeListener`: the listener to remove. This value cannot be `null`. <br /> |