PlaybackControlsRow.ClosedCaptioningAction

Added in 1.1.0

Kotlin |Java

class PlaybackControlsRow.ClosedCaptioningAction : PlaybackControlsRow.MultiAction

kotlin.Any
↳	androidx.leanback.widget.Action
	↳	androidx.leanback.widget.PlaybackControlsRow.MultiAction
		↳	androidx.leanback.widget.PlaybackControlsRow.ClosedCaptioningAction

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

Summary

Constants
`const Int`	`INDEX_OFF = 0` Action index for closed caption is off.
`const Int`	`INDEX_ON = 1` Action index for closed caption is on.
`const Int`	`OFF = 0` This property is deprecated. Use `INDEX_OFF`
`const Int`	`ON = 1` This property is deprecated. Use `INDEX_ON`

Public constructors
`ClosedCaptioningAction(context: Context!)` Constructor
`ClosedCaptioningAction(context: Context!, highlightColor: Int)` Constructor

const Long

NO_ID = -1

Indicates that an id has not been set.

`Unit`	`addKeyCode(keyCode: Int)` Adds a keycode used to invoke this Action.
`Drawable?`	`getIcon()` Returns the icon drawable for this Action.
`Long`	`getId()` Returns the id for this Action.
`CharSequence?`	`getLabel1()` Returns the first line label for this Action.
`CharSequence?`	`getLabel2()` Returns the second line label for this Action.
`Unit`	`removeKeyCode(keyCode: Int)` Removes a keycode used to invoke this Action.
`Boolean`	`respondsToKeyCode(keyCode: Int)` Returns true if the Action should respond to the given keycode.
`Unit`	`setIcon(icon: Drawable?)` Sets the icon drawable for this Action.
`Unit`	`setId(id: Long)` Sets the id for this Action.
`Unit`	`setLabel1(label: CharSequence?)` Sets the first line label for this Action.
`Unit`	`setLabel2(label: CharSequence?)` Sets the second line label for this Action.
`String`	`toString()`

`Int`	`getActionCount()` Returns the number of actions.
`Drawable!`	`getDrawable(index: Int)` Returns the drawable at the given index.
`Int`	`getIndex()` Returns the current index.
`String!`	`getLabel(index: Int)` Returns the label at the given index.
`String!`	`getSecondaryLabel(index: Int)` Returns the secondary label at the given index.
`Unit`	`nextIndex()` Increments the index, wrapping to zero once the end is reached.
`Unit`	`setDrawables(drawables: Array<Drawable!>!)` Sets the array of drawables.
`Unit`	`setIndex(index: Int)` Sets the current index.
`Unit`	`setLabels(labels: Array<String!>!)` Sets the array of strings used as labels.
`Unit`	`setSecondaryLabels(labels: Array<String!>!)` Sets the array of strings used as secondary labels.

Added in 1.1.0

const val INDEX_OFF = 0: Int

Action index for closed caption is off.

Added in 1.1.0

const val INDEX_ON = 1: Int

Action index for closed caption is on.

Added in 1.1.0

Deprecated in 1.1.0

const val OFF = 0: Int

Action index for closed caption is off.

Added in 1.1.0

Deprecated in 1.1.0

const val ON = 1: Int

Action index for closed caption is on.

Added in 1.1.0

ClosedCaptioningAction(context: Context!)

Constructor

Parameters
`context: Context!`	Context used for loading resources.

Added in 1.1.0

ClosedCaptioningAction(context: Context!, highlightColor: Int)

Constructor

Parameters
`context: Context!`	Context used for loading resources.
`highlightColor: Int`	Color for the highlighted icon state.