PlaybackControlsRow.ClosedCaptioningAction


public class PlaybackControlsRow.ClosedCaptioningAction extends PlaybackControlsRow.MultiAction


An action for displaying a CC (Closed Captioning) icon.

Summary

Constants

static final int

Action index for closed caption is off.

static final int

Action index for closed caption is on.

static final int
OFF = 0

This field is deprecated.

Use INDEX_OFF

static final int
ON = 1

This field is deprecated.

Use INDEX_ON

Public constructors

Constructor

ClosedCaptioningAction(Context context, int highlightColor)

Constructor

Inherited Constants

From androidx.leanback.widget.Action
static final long
NO_ID = -1

Indicates that an id has not been set.

Inherited methods

From androidx.leanback.widget.Action
final void
addKeyCode(int keyCode)

Adds a keycode used to invoke this Action.

final @Nullable Drawable

Returns the icon drawable for this Action.

final long

Returns the id for this Action.

final @Nullable CharSequence

Returns the first line label for this Action.

final @Nullable CharSequence

Returns the second line label for this Action.

final void
removeKeyCode(int keyCode)

Removes a keycode used to invoke this Action.

final boolean
respondsToKeyCode(int keyCode)

Returns true if the Action should respond to the given keycode.

final void

Sets the icon drawable for this Action.

final void
setId(long id)

Sets the id for this Action.

final void

Sets the first line label for this Action.

final void

Sets the second line label for this Action.

@NonNull String
From androidx.leanback.widget.PlaybackControlsRow.MultiAction
int

Returns the number of actions.

Drawable
getDrawable(int index)

Returns the drawable at the given index.

int

Returns the current index.

String
getLabel(int index)

Returns the label at the given index.

String
getSecondaryLabel(int index)

Returns the secondary label at the given index.

void

Increments the index, wrapping to zero once the end is reached.

void
setDrawables(Drawable[] drawables)

Sets the array of drawables.

void
setIndex(int index)

Sets the current index.

void
setLabels(String[] labels)

Sets the array of strings used as labels.

void
setSecondaryLabels(String[] labels)

Sets the array of strings used as secondary labels.

Constants

INDEX_OFF

Added in 1.1.0
public static final int INDEX_OFF = 0

Action index for closed caption is off.

INDEX_ON

Added in 1.1.0
public static final int INDEX_ON = 1

Action index for closed caption is on.

OFF

Added in 1.1.0
Deprecated in 1.1.0
public static final int OFF = 0

Action index for closed caption is off.

ON

Added in 1.1.0
Deprecated in 1.1.0
public static final int ON = 1

Action index for closed caption is on.

Public constructors

ClosedCaptioningAction

Added in 1.1.0
public ClosedCaptioningAction(Context context)

Constructor

Parameters
Context context

Context used for loading resources.

ClosedCaptioningAction

Added in 1.1.0
public ClosedCaptioningAction(Context context, int highlightColor)

Constructor

Parameters
Context context

Context used for loading resources.

int highlightColor

Color for the highlighted icon state.