Package com.google.android.exoplayer2.ui
Class CaptionStyleCompat
- java.lang.Object
-
- com.google.android.exoplayer2.ui.CaptionStyleCompat
-
public final class CaptionStyleCompat extends Object
A compatibility wrapper forCaptioningManager.CaptionStyle
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CaptionStyleCompat.EdgeType
The type of edge, which may be none.
-
Field Summary
Fields Modifier and Type Field Description int
backgroundColor
The preferred background color.static CaptionStyleCompat
DEFAULT
Default caption style.static int
EDGE_TYPE_DEPRESSED
Edge type value specifying depressed bevel character edges.static int
EDGE_TYPE_DROP_SHADOW
Edge type value specifying drop-shadowed character edges.static int
EDGE_TYPE_NONE
Edge type value specifying no character edges.static int
EDGE_TYPE_OUTLINE
Edge type value specifying uniformly outlined character edges.static int
EDGE_TYPE_RAISED
Edge type value specifying raised bevel character edges.int
edgeColor
The preferred edge color, if using an edge type other thanEDGE_TYPE_NONE
.@com.google.android.exoplayer2.ui.CaptionStyleCompat.EdgeType int
edgeType
The preferred edge type.int
foregroundColor
The preferred foreground color.Typeface
typeface
The preferred typeface, ornull
if unspecified.static int
USE_TRACK_COLOR_SETTINGS
Use color setting specified by the track and fallback to default caption style.int
windowColor
The preferred window color.
-
Constructor Summary
Constructors Constructor Description CaptionStyleCompat(int foregroundColor, int backgroundColor, int windowColor, @com.google.android.exoplayer2.ui.CaptionStyleCompat.EdgeType int edgeType, int edgeColor, Typeface typeface)
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CaptionStyleCompat
createFromCaptionStyle(CaptioningManager.CaptionStyle captionStyle)
Creates aCaptionStyleCompat
equivalent to a providedCaptioningManager.CaptionStyle
.
-
-
-
Field Detail
-
EDGE_TYPE_NONE
public static final int EDGE_TYPE_NONE
Edge type value specifying no character edges.- See Also:
- Constant Field Values
-
EDGE_TYPE_OUTLINE
public static final int EDGE_TYPE_OUTLINE
Edge type value specifying uniformly outlined character edges.- See Also:
- Constant Field Values
-
EDGE_TYPE_DROP_SHADOW
public static final int EDGE_TYPE_DROP_SHADOW
Edge type value specifying drop-shadowed character edges.- See Also:
- Constant Field Values
-
EDGE_TYPE_RAISED
public static final int EDGE_TYPE_RAISED
Edge type value specifying raised bevel character edges.- See Also:
- Constant Field Values
-
EDGE_TYPE_DEPRESSED
public static final int EDGE_TYPE_DEPRESSED
Edge type value specifying depressed bevel character edges.- See Also:
- Constant Field Values
-
USE_TRACK_COLOR_SETTINGS
public static final int USE_TRACK_COLOR_SETTINGS
Use color setting specified by the track and fallback to default caption style.- See Also:
- Constant Field Values
-
DEFAULT
public static final CaptionStyleCompat DEFAULT
Default caption style.
-
foregroundColor
public final int foregroundColor
The preferred foreground color.
-
backgroundColor
public final int backgroundColor
The preferred background color.
-
windowColor
public final int windowColor
The preferred window color.
-
edgeType
public final @com.google.android.exoplayer2.ui.CaptionStyleCompat.EdgeType int edgeType
The preferred edge type. One of:
-
edgeColor
public final int edgeColor
The preferred edge color, if using an edge type other thanEDGE_TYPE_NONE
.
-
typeface
@Nullable public final Typeface typeface
The preferred typeface, ornull
if unspecified.
-
-
Constructor Detail
-
CaptionStyleCompat
public CaptionStyleCompat(int foregroundColor, int backgroundColor, int windowColor, @com.google.android.exoplayer2.ui.CaptionStyleCompat.EdgeType int edgeType, int edgeColor, @Nullable Typeface typeface)
- Parameters:
foregroundColor
- SeeforegroundColor
.backgroundColor
- SeebackgroundColor
.windowColor
- SeewindowColor
.edgeType
- SeeedgeType
.edgeColor
- SeeedgeColor
.typeface
- Seetypeface
.
-
-
Method Detail
-
createFromCaptionStyle
@RequiresApi(19) public static CaptionStyleCompat createFromCaptionStyle(CaptioningManager.CaptionStyle captionStyle)
Creates aCaptionStyleCompat
equivalent to a providedCaptioningManager.CaptionStyle
.- Parameters:
captionStyle
- ACaptioningManager.CaptionStyle
.- Returns:
- The equivalent
CaptionStyleCompat
.
-
-