lightbulb_outline Please take our October 2018 developer survey. Start survey

CaptioningManager.CaptionStyle

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:

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

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