CaptionStyleCompat


@UnstableApi
class CaptionStyleCompat


A compatibility wrapper for CaptionStyle.

Summary

Nested types

This annotation is deprecated.

Use SubtitleStyle.EdgeType instead.

Constants

const CaptionStyleCompat!

This property is deprecated.

Use DEFAULT instead.

const Int

This property is deprecated.

Use EDGE_TYPE_DEPRESSED instead.

const Int

This property is deprecated.

Use EDGE_TYPE_DROP_SHADOW instead.

const Int

This property is deprecated.

Use EDGE_TYPE_NONE instead.

const Int

This property is deprecated.

Use EDGE_TYPE_OUTLINE instead.

const Int

This property is deprecated.

Use EDGE_TYPE_RAISED instead.

const Int

This property is deprecated.

This constant is not used by the library.

Public constructors

CaptionStyleCompat(
    foregroundColor: Int,
    backgroundColor: Int,
    windowColor: Int,
    @CaptionStyleCompat.EdgeType edgeType: Int,
    edgeColor: Int,
    typeface: Typeface?
)

This function is deprecated.

Use SubtitleStyle.Builder instead.

Public functions

java-static CaptionStyleCompat!

This function is deprecated.

Use fromCaptionStyle instead.

Public properties

Int

This property is deprecated. Deprecated in Java

Int

This property is deprecated. Deprecated in Java

Int

This property is deprecated. Deprecated in Java

Int

This property is deprecated. Deprecated in Java

Typeface?

This property is deprecated. Deprecated in Java

Int

This property is deprecated. Deprecated in Java

Constants

DEFAULT

const val DEFAULT: CaptionStyleCompat!

EDGE_TYPE_DEPRESSED

const val EDGE_TYPE_DEPRESSED = 4: Int

EDGE_TYPE_DROP_SHADOW

const val EDGE_TYPE_DROP_SHADOW = 2: Int

EDGE_TYPE_NONE

const val EDGE_TYPE_NONE = 0: Int

EDGE_TYPE_OUTLINE

const val EDGE_TYPE_OUTLINE = 1: Int

EDGE_TYPE_RAISED

const val EDGE_TYPE_RAISED = 3: Int

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?
)

Public functions

createFromCaptionStyle

java-static fun createFromCaptionStyle(captionStyle: CaptioningManager.CaptionStyle!): CaptionStyleCompat!

Public properties

backgroundColor

val backgroundColor: Int

The preferred background color.

edgeColor

val edgeColor: Int

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

edgeType

@CaptionStyleCompat.EdgeType
val edgeType: Int

The preferred edge type. One of:

foregroundColor

val foregroundColor: Int

The preferred foreground color.

typeface

val typeface: Typeface?

The preferred typeface, or null if unspecified.

windowColor

val windowColor: Int

The preferred window color.