Added in API level 19

Summary: Constants | Fields | Methods | Inherited Methods

CaptioningManager.CaptionStyle

Kotlin |Java

public static final class CaptioningManager.CaptionStyle
extends Object

java.lang.Object
↳	android.view.accessibility.CaptioningManager.CaptionStyle

Specifies visual properties for video captions, including foreground and background colors, edge properties, and typeface.

Summary

Constants
`int`	`EDGE_TYPE_DEPRESSED` Edge type value specifying depressed bevel character edges.
`int`	`EDGE_TYPE_DROP_SHADOW` Edge type value specifying drop-shadowed character edges.
`int`	`EDGE_TYPE_NONE` Edge type value specifying no character edges.
`int`	`EDGE_TYPE_OUTLINE` Edge type value specifying uniformly outlined character edges.
`int`	`EDGE_TYPE_RAISED` Edge type value specifying raised bevel character edges.
`int`	`EDGE_TYPE_UNSPECIFIED` Unspecified edge type value.

Fields
`public final int`	`backgroundColor` The preferred background color for video captions.
`public final int`	`edgeColor` The preferred edge color for video captions, if using an edge type other than `EDGE_TYPE_NONE`.
`public final int`	`edgeType` The preferred edge type for video captions, one of: `EDGE_TYPE_UNSPECIFIED` `EDGE_TYPE_NONE` `EDGE_TYPE_OUTLINE` `EDGE_TYPE_DROP_SHADOW` `EDGE_TYPE_RAISED` `EDGE_TYPE_DEPRESSED`
`public final int`	`foregroundColor` The preferred foreground color for video captions.
`public final int`	`windowColor` The preferred window color for video captions.

Public methods
`Typeface`	`getTypeface()`
`boolean`	`hasBackgroundColor()`
`boolean`	`hasEdgeColor()`
`boolean`	`hasEdgeType()`
`boolean`	`hasForegroundColor()`
`boolean`	`hasWindowColor()`

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 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`	`wait(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`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

EDGE_TYPE_DEPRESSED

Added in API level 21

public static final int EDGE_TYPE_DEPRESSED

Edge type value specifying depressed bevel character edges.

Constant Value: 4 (0x00000004)

EDGE_TYPE_DROP_SHADOW

Added in API level 19

public static final int EDGE_TYPE_DROP_SHADOW

Edge type value specifying drop-shadowed character edges.

Constant Value: 2 (0x00000002)

EDGE_TYPE_NONE

Added in API level 19

public static final int EDGE_TYPE_NONE

Edge type value specifying no character edges.

Constant Value: 0 (0x00000000)

EDGE_TYPE_OUTLINE

Added in API level 19

public static final int EDGE_TYPE_OUTLINE

Edge type value specifying uniformly outlined character edges.

Constant Value: 1 (0x00000001)

EDGE_TYPE_RAISED

Added in API level 21

public static final int EDGE_TYPE_RAISED

Edge type value specifying raised bevel character edges.

Constant Value: 3 (0x00000003)

EDGE_TYPE_UNSPECIFIED

Added in API level 21

public static final int EDGE_TYPE_UNSPECIFIED

Unspecified edge type value.

Constant Value: -1 (0xffffffff)

Fields

backgroundColor

Added in API level 19

public final int backgroundColor

The preferred background color for video captions.

edgeColor

Added in API level 19

public final int edgeColor

The preferred edge color for video captions, if using an edge type other than EDGE_TYPE_NONE.

edgeType

Added in API level 19

public final int edgeType

The preferred edge type for video captions, one of:

foregroundColor

Added in API level 19

public final int foregroundColor

The preferred foreground color for video captions.

windowColor

Added in API level 21

public final int windowColor

The preferred window color for video captions.

Public methods

getTypeface

Added in API level 19

public Typeface getTypeface ()

Returns
`Typeface`	the preferred `Typeface` for video captions, or null if not specified

hasBackgroundColor

Added in API level 21

public boolean hasBackgroundColor ()

Returns
`boolean`	`true` if the user has specified a background color that should override the application default, `false` otherwise

hasEdgeColor

Added in API level 21

public boolean hasEdgeColor ()

Returns
`boolean`	`true` if the user has specified an edge color that should override the application default, `false` otherwise

hasEdgeType

Added in API level 21

public boolean hasEdgeType ()

Returns
`boolean`	`true` if the user has specified an edge type that should override the application default, `false` otherwise

hasForegroundColor

Added in API level 21

public boolean hasForegroundColor ()

Returns
`boolean`	`true` if the user has specified a foreground color that should override the application default, `false` otherwise

hasWindowColor

Added in API level 21

public boolean hasWindowColor ()

Returns
`boolean`	`true` if the user has specified a window color that should override the application default, `false` otherwise