CaptionStyleCompat


@UnstableApi
public final class CaptionStyleCompat


A compatibility wrapper for CaptionStyle.

Summary

Nested types

This annotation is deprecated.

Use SubtitleStyle.EdgeType instead.

Constants

static final CaptionStyleCompat

This field is deprecated.

Use DEFAULT instead.

static final int

This field is deprecated.

Use EDGE_TYPE_DEPRESSED instead.

static final int

This field is deprecated.

Use EDGE_TYPE_DROP_SHADOW instead.

static final int

This field is deprecated.

Use EDGE_TYPE_NONE instead.

static final int

This field is deprecated.

Use EDGE_TYPE_OUTLINE instead.

static final int

This field is deprecated.

Use EDGE_TYPE_RAISED instead.

static final int

This field is deprecated.

This constant is not used by the library.

Public fields

final int

This field is deprecated. Deprecated in Java

final int

This field is deprecated. Deprecated in Java

final int

This field is deprecated. Deprecated in Java

final int

This field is deprecated. Deprecated in Java

final @Nullable Typeface

This field is deprecated. Deprecated in Java

final int

This field is deprecated. Deprecated in Java

Public constructors

CaptionStyleCompat(
    int foregroundColor,
    int backgroundColor,
    int windowColor,
    @CaptionStyleCompat.EdgeType int edgeType,
    int edgeColor,
    @Nullable Typeface typeface
)

This method is deprecated.

Use SubtitleStyle.Builder instead.

Public methods

static CaptionStyleCompat

This method is deprecated.

Use fromCaptionStyle instead.

Constants

DEFAULT

public static final CaptionStyleCompat DEFAULT

EDGE_TYPE_DEPRESSED

public static final int EDGE_TYPE_DEPRESSED = 4

EDGE_TYPE_DROP_SHADOW

public static final int EDGE_TYPE_DROP_SHADOW = 2

EDGE_TYPE_NONE

public static final int EDGE_TYPE_NONE = 0

EDGE_TYPE_OUTLINE

public static final int EDGE_TYPE_OUTLINE = 1

EDGE_TYPE_RAISED

public static final int EDGE_TYPE_RAISED = 3

USE_TRACK_COLOR_SETTINGS

public static final int USE_TRACK_COLOR_SETTINGS = 1

Use color setting specified by the track and fallback to default caption style.

Public fields

backgroundColor

public final int backgroundColor

The preferred background color.

edgeColor

public final int edgeColor

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

edgeType

@CaptionStyleCompat.EdgeType
public final int edgeType

The preferred edge type. One of:

foregroundColor

public final int foregroundColor

The preferred foreground color.

typeface

public final @Nullable Typeface typeface

The preferred typeface, or null if unspecified.

windowColor

public final int windowColor

The preferred window color.

Public constructors

CaptionStyleCompat

public CaptionStyleCompat(
    int foregroundColor,
    int backgroundColor,
    int windowColor,
    @CaptionStyleCompat.EdgeType int edgeType,
    int edgeColor,
    @Nullable Typeface typeface
)

Public methods

createFromCaptionStyle

public static CaptionStyleCompat createFromCaptionStyle(CaptioningManager.CaptionStyle captionStyle)