CaptionStyleCompat
@UnstableApi
class CaptionStyleCompat
A compatibility wrapper for CaptionStyle.
Summary
Nested types |
|---|
@DocumentedThe type of edge, which may be none. |
Constants |
|
|---|---|
const CaptionStyleCompat! |
Default caption style. |
const Int |
Edge type value specifying depressed bevel character edges. |
const Int |
Edge type value specifying drop-shadowed character edges. |
const Int |
EDGE_TYPE_NONE = 0Edge type value specifying no character edges. |
const Int |
Edge type value specifying uniformly outlined character edges. |
const Int |
EDGE_TYPE_RAISED = 3Edge type value specifying raised bevel character edges. |
const Int |
Use color setting specified by the track and fallback to default caption style. |
Public constructors |
|---|
CaptionStyleCompat( |
Public functions |
|
|---|---|
java-static CaptionStyleCompat! |
createFromCaptionStyle(captionStyle: CaptioningManager.CaptionStyle!)Creates a |
Public properties |
|
|---|---|
Int |
The preferred background color. |
Int |
The preferred edge color, if using an edge type other than |
Int |
The preferred edge type. |
Int |
The preferred foreground color. |
Typeface? |
The preferred typeface, or |
Int |
The preferred window color. |
Constants
EDGE_TYPE_DEPRESSED
const val EDGE_TYPE_DEPRESSED = 4: Int
Edge type value specifying depressed bevel character edges.
EDGE_TYPE_DROP_SHADOW
const val EDGE_TYPE_DROP_SHADOW = 2: Int
Edge type value specifying drop-shadowed character edges.
EDGE_TYPE_OUTLINE
const val EDGE_TYPE_OUTLINE = 1: Int
Edge type value specifying uniformly outlined character edges.
EDGE_TYPE_RAISED
const val EDGE_TYPE_RAISED = 3: Int
Edge type value specifying raised bevel character edges.
USE_TRACK_COLOR_SETTINGS
const val USE_TRACK_COLOR_SETTINGS = 1: Int
Use color setting specified by the track and fallback to default caption style.
Public constructors
CaptionStyleCompat
CaptionStyleCompat(
foregroundColor: Int,
backgroundColor: Int,
windowColor: Int,
@CaptionStyleCompat.EdgeType edgeType: Int,
edgeColor: Int,
typeface: Typeface?
)
| Parameters | |
|---|---|
foregroundColor: Int |
See |
backgroundColor: Int |
See |
windowColor: Int |
See |
@CaptionStyleCompat.EdgeType edgeType: Int |
See |
edgeColor: Int |
See |
typeface: Typeface? |
See |
Public functions
createFromCaptionStyle
java-static fun createFromCaptionStyle(captionStyle: CaptioningManager.CaptionStyle!): CaptionStyleCompat!
Creates a CaptionStyleCompat equivalent to a provided CaptionStyle.
| Parameters | |
|---|---|
captionStyle: CaptioningManager.CaptionStyle! |
A |
| Returns | |
|---|---|
CaptionStyleCompat! |
The equivalent |
Public properties
edgeColor
val edgeColor: Int
The preferred edge color, if using an edge type other than EDGE_TYPE_NONE.