Android APIs
public static final class

CaptioningManager.CaptionStyle

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

Class Overview

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()
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int EDGE_TYPE_DEPRESSED

Edge type value specifying depressed bevel character edges.

Constant Value: 4 (0x00000004)

public static final int EDGE_TYPE_DROP_SHADOW

Added in API level 19

Edge type value specifying drop-shadowed character edges.

Constant Value: 2 (0x00000002)

public static final int EDGE_TYPE_NONE

Added in API level 19

Edge type value specifying no character edges.

Constant Value: 0 (0x00000000)

public static final int EDGE_TYPE_OUTLINE

Added in API level 19

Edge type value specifying uniformly outlined character edges.

Constant Value: 1 (0x00000001)

public static final int EDGE_TYPE_RAISED

Edge type value specifying raised bevel character edges.

Constant Value: 3 (0x00000003)

public static final int EDGE_TYPE_UNSPECIFIED

Unspecified edge type value.

Constant Value: -1 (0xffffffff)

Fields

public final int backgroundColor

Added in API level 19

The preferred background color for video captions.

public final int edgeColor

Added in API level 19

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

public final int edgeType

Added in API level 19

The preferred edge type for video captions, one of:

public final int foregroundColor

Added in API level 19

The preferred foreground color for video captions.

public final int windowColor

The preferred window color for video captions.

Public Methods

public Typeface getTypeface ()

Added in API level 19

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

public boolean hasBackgroundColor ()

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

public boolean hasEdgeColor ()

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

public boolean hasEdgeType ()

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

public boolean hasForegroundColor ()

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

public boolean hasWindowColor ()

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