PlaybackControlsRow

Added in 1.1.0

Kotlin |Java

class PlaybackControlsRow : Row

kotlin.Any
↳	androidx.leanback.widget.Row
	↳	androidx.leanback.widget.PlaybackControlsRow

A Row of playback controls to be displayed by a PlaybackControlsRowPresenter. This row consists of some optional item detail, a series of primary actions, and an optional series of secondary actions.

Controls are specified via an ObjectAdapter containing one or more Actions.

Adapters should have their PresenterSelector set to an instance of ControlButtonPresenterSelector.

Summary

Nested types
`class PlaybackControlsRow.ClosedCaptioningAction : PlaybackControlsRow.MultiAction` An action for displaying a CC (Closed Captioning) icon.
`class PlaybackControlsRow.FastForwardAction : PlaybackControlsRow.MultiAction` An action displaying an icon for fast forward.
`class PlaybackControlsRow.HighQualityAction : PlaybackControlsRow.MultiAction` An action for displaying a HQ (High Quality) icon.
`class PlaybackControlsRow.MoreActions : Action` An action displaying an icon for "more actions".
`abstract class PlaybackControlsRow.MultiAction : Action` Base class for an action comprised of a series of icons.
`class PlaybackControlsRow.OnPlaybackProgressCallback` Listener for progress or duration change.
`class PlaybackControlsRow.PictureInPictureAction : Action` An action displaying an icon for picture-in-picture.
`class PlaybackControlsRow.PlayPauseAction : PlaybackControlsRow.MultiAction` An action displaying icons for play and pause.
`class PlaybackControlsRow.RepeatAction : PlaybackControlsRow.MultiAction` An action for displaying three repeat states: none, one, or all.
`class PlaybackControlsRow.RewindAction : PlaybackControlsRow.MultiAction` An action displaying an icon for rewind.
`class PlaybackControlsRow.ShuffleAction : PlaybackControlsRow.MultiAction` An action for displaying a shuffle icon.
`class PlaybackControlsRow.SkipNextAction : Action` An action displaying an icon for skip next.
`class PlaybackControlsRow.SkipPreviousAction : Action` An action displaying an icon for skip previous.
`abstract class PlaybackControlsRow.ThumbsAction : PlaybackControlsRow.MultiAction` A base class for displaying a thumbs action.
`class PlaybackControlsRow.ThumbsDownAction : PlaybackControlsRow.ThumbsAction` An action displaying an icon for thumbs down.
`class PlaybackControlsRow.ThumbsUpAction : PlaybackControlsRow.ThumbsAction` An action displaying an icon for thumbs up.

Public constructors
`PlaybackControlsRow()` Constructor for a PlaybackControlsRow that has no item details.
`PlaybackControlsRow(item: Any!)` Constructor for a PlaybackControlsRow that displays some details from the given item.

Public functions
`Action!`	`getActionForKeyCode(keyCode: Int)` Returns the Action associated with the given keycode, or null if no associated action exists.
`Action!`	`getActionForKeyCode(adapter: ObjectAdapter!, keyCode: Int)` Returns the Action associated with the given keycode, or null if no associated action exists.
`Long`	`getBufferedPosition()` Returns the buffered progress of long type for the playback controls row.
`Int`	`getBufferedProgress()` This function is deprecated. Use `getBufferedPosition`
`Long`	`getBufferedProgressLong()` This function is deprecated. Use `getBufferedPosition`
`Long`	`getCurrentPosition()` Returns the current time in milliseconds of long type for playback controls row.
`Int`	`getCurrentTime()` This function is deprecated. Use `getCurrentPosition`
`Long`	`getCurrentTimeLong()` This function is deprecated. Use `getCurrentPosition`
`Long`	`getDuration()` Returns duration in milliseconds.
`Drawable!`	`getImageDrawable()` Returns the image `Drawable` of this row.
`Any!`	`getItem()` Returns the main item for the details page.
`ObjectAdapter!`	`getPrimaryActionsAdapter()` Returns the primary actions `ObjectAdapter`.
`ObjectAdapter!`	`getSecondaryActionsAdapter()` Returns the secondary actions `ObjectAdapter`.
`Int`	`getTotalTime()` This function is deprecated. use `getDuration`
`Long`	`getTotalTimeLong()` This function is deprecated. use `getDuration`
`Unit`	`setBufferedPosition(ms: Long)` Sets the buffered progress for the playback controls row.
`Unit`	`setBufferedProgress(ms: Int)` This function is deprecated. Use `setBufferedPosition`
`Unit`	`setBufferedProgressLong(ms: Long)` This function is deprecated. Use `setBufferedPosition`
`Unit`	`setCurrentPosition(ms: Long)` Sets the current time in milliseconds for the playback controls row.
`Unit`	`setCurrentTime(ms: Int)` This function is deprecated. use `setCurrentPosition`
`Unit`	`setCurrentTimeLong(ms: Long)` This function is deprecated. use `setCurrentPosition`
`Unit`	`setDuration(ms: Long)` Sets the total time in milliseconds (long type) for the playback controls row.
`Unit`	`setImageBitmap(context: Context!, bm: Bitmap!)` Sets a `Bitmap` for this row.
`Unit`	`setImageDrawable(drawable: Drawable!)` Sets a {link @Drawable} image for this row.
`Unit`	`setOnPlaybackProgressChangedListener( listener: PlaybackControlsRow.OnPlaybackProgressCallback! )` Sets a listener to be called when the playback state changes.
`Unit`	`setPrimaryActionsAdapter(adapter: ObjectAdapter!)` Sets the primary actions `ObjectAdapter`.
`Unit`	`setSecondaryActionsAdapter(adapter: ObjectAdapter!)` Sets the secondary actions `ObjectAdapter`.
`Unit`	`setTotalTime(ms: Int)` This function is deprecated. Use `setDuration`
`Unit`	`setTotalTimeLong(ms: Long)` This function is deprecated. Use `setDuration`

Inherited functions

From androidx.leanback.widget.Row

`HeaderItem!`	`getHeaderItem()` Returns the `HeaderItem` that represents metadata for the row.
`Long`	`getId()` Returns a unique identifier for this row.
`Boolean`	`isRenderedAsRowView()` Returns true if this Row can be rendered in a visible row view, false otherwise.
`Unit`	`setHeaderItem(headerItem: HeaderItem!)` Sets the `HeaderItem` that represents metadata for the row.
`Unit`	`setId(id: Long)` Sets the id for this row.

Public constructors

PlaybackControlsRow

Added in 1.1.0

PlaybackControlsRow()

Constructor for a PlaybackControlsRow that has no item details.

PlaybackControlsRow

Added in 1.1.0

PlaybackControlsRow(item: Any!)

Constructor for a PlaybackControlsRow that displays some details from the given item.

Parameters
`item: Any!`	The main item for the row.

Public functions

getActionForKeyCode

Added in 1.1.0

fun getActionForKeyCode(keyCode: Int): Action!

Returns the Action associated with the given keycode, or null if no associated action exists. Searches the primary adapter first, then the secondary adapter.

Added in 1.1.0

fun getActionForKeyCode(adapter: ObjectAdapter!, keyCode: Int): Action!

Returns the Action associated with the given keycode, or null if no associated action exists.

getBufferedPosition

Added in 1.1.0

fun getBufferedPosition(): Long

Returns the buffered progress of long type for the playback controls row.

getBufferedProgress

Added in 1.1.0

Deprecated in 1.1.0

fun getBufferedProgress(): Int

Returns the buffered progress for the playback controls row.

Throws
`java.lang.ArithmeticException`	If buffered progress in milliseconds overflows int.

getBufferedProgressLong

Added in 1.1.0

Deprecated in 1.1.0

fun getBufferedProgressLong(): Long

Returns the buffered progress of long type for the playback controls row.

getCurrentPosition

Added in 1.1.0

fun getCurrentPosition(): Long

Returns the current time in milliseconds of long type for playback controls row.

getCurrentTime

Added in 1.1.0

Deprecated in 1.1.0

fun getCurrentTime(): Int

Returns the current time in milliseconds for the playback controls row.

Throws
`java.lang.ArithmeticException`	If current time in milliseconds overflows int.

getCurrentTimeLong

Added in 1.1.0

Deprecated in 1.1.0

fun getCurrentTimeLong(): Long

Returns the current time in milliseconds of long type for playback controls row.

getDuration

Added in 1.1.0

fun getDuration(): Long

Returns duration in milliseconds.

Returns
`Long`	Duration in milliseconds.

getImageDrawable

Added in 1.1.0

fun getImageDrawable(): Drawable!

Returns the image Drawable of this row.

Returns
`Drawable!`	The overview's image drawable, or null if no drawable has been assigned.

getItem

Added in 1.1.0

fun getItem(): Any!

Returns the main item for the details page.

getPrimaryActionsAdapter

Added in 1.1.0

fun getPrimaryActionsAdapter(): ObjectAdapter!

Returns the primary actions ObjectAdapter.

getSecondaryActionsAdapter

Added in 1.1.0

fun getSecondaryActionsAdapter(): ObjectAdapter!

Returns the secondary actions ObjectAdapter.

getTotalTime

Added in 1.1.0

Deprecated in 1.1.0

fun getTotalTime(): Int

Returns the total time in milliseconds for the playback controls row.

Throws
`java.lang.ArithmeticException`	If total time in milliseconds overflows int.

getTotalTimeLong

Added in 1.1.0

Deprecated in 1.1.0

fun getTotalTimeLong(): Long

Returns the total time in milliseconds of long type for the playback controls row.

setBufferedPosition

Added in 1.1.0

fun setBufferedPosition(ms: Long): Unit

Sets the buffered progress for the playback controls row.

Parameters
`ms: Long`	Buffered progress in milliseconds of long type.

setBufferedProgress

Added in 1.1.0

Deprecated in 1.1.0

fun setBufferedProgress(ms: Int): Unit

Sets the buffered progress for the playback controls row. If this row is bound to a view, the view will automatically be updated to reflect the new value.

setBufferedProgressLong

Added in 1.1.0

Deprecated in 1.1.0

fun setBufferedProgressLong(ms: Long): Unit

Sets the buffered progress for the playback controls row.

Parameters
`ms: Long`	Buffered progress in milliseconds of long type.

setCurrentPosition

Added in 1.1.0

fun setCurrentPosition(ms: Long): Unit

Sets the current time in milliseconds for the playback controls row. If this row is bound to a view, the view will automatically be updated to reflect the new value.

Parameters
`ms: Long`	Current time in milliseconds of long type.

setCurrentTime

Added in 1.1.0

Deprecated in 1.1.0

fun setCurrentTime(ms: Int): Unit

Sets the current time in milliseconds for the playback controls row. If this row is bound to a view, the view will automatically be updated to reflect the new value.

setCurrentTimeLong

Added in 1.1.0

Deprecated in 1.1.0

fun setCurrentTimeLong(ms: Long): Unit

Sets the current time in milliseconds for playback controls row in long type.

Parameters
`ms: Long`	Current time in milliseconds of long type.

setDuration

Added in 1.1.0

fun setDuration(ms: Long): Unit

Sets the total time in milliseconds (long type) for the playback controls row. If this row is bound to a view, the view will automatically be updated to reflect the new value.

Parameters
`ms: Long`	Total time in milliseconds of long type.

setImageBitmap

Added in 1.1.0

fun setImageBitmap(context: Context!, bm: Bitmap!): Unit

Sets a Bitmap for this row.

If set after the row has been bound to a view, the adapter must be notified that this row has changed.

Parameters
`context: Context!`	The context to retrieve display metrics from.
`bm: Bitmap!`	The bitmap to set.

setImageDrawable

Added in 1.1.0

fun setImageDrawable(drawable: Drawable!): Unit

Sets a {link @Drawable} image for this row.

If set after the row has been bound to a view, the adapter must be notified that this row has changed.

Parameters
`drawable: Drawable!`	The drawable to set.

Added in 1.1.0

fun setOnPlaybackProgressChangedListener(
    listener: PlaybackControlsRow.OnPlaybackProgressCallback!
): Unit

Sets a listener to be called when the playback state changes.

Added in 1.1.0

fun setPrimaryActionsAdapter(adapter: ObjectAdapter!): Unit

Sets the primary actions ObjectAdapter.

If set after the row has been bound to a view, the adapter must be notified that this row has changed.

Added in 1.1.0

fun setSecondaryActionsAdapter(adapter: ObjectAdapter!): Unit

Sets the secondary actions ObjectAdapter.

If set after the row has been bound to a view, the adapter must be notified that this row has changed.

setTotalTime

Added in 1.1.0

Deprecated in 1.1.0

fun setTotalTime(ms: Int): Unit

Sets the total time in milliseconds for the playback controls row.

If set after the row has been bound to a view, the adapter must be notified that this row has changed.

setTotalTimeLong

Added in 1.1.0

Deprecated in 1.1.0

fun setTotalTimeLong(ms: Long): Unit

Sets the total time in milliseconds (long type) for the playback controls row.

Parameters
`ms: Long`	Total time in milliseconds of long type.

PlaybackControlsRow

Summary

Nested types

Public constructors

Public functions

Inherited functions

Public constructors

PlaybackControlsRow

PlaybackControlsRow

Public functions

getActionForKeyCode

getActionForKeyCode

getBufferedPosition

getBufferedProgress

getBufferedProgressLong

getCurrentPosition

getCurrentTime

getCurrentTimeLong

getDuration

getImageDrawable

getItem

getPrimaryActionsAdapter

getSecondaryActionsAdapter

getTotalTime

getTotalTimeLong

setBufferedPosition

setBufferedProgress

setBufferedProgressLong

setCurrentPosition

setCurrentTime

setCurrentTimeLong

setDuration

setImageBitmap

setImageDrawable

setOnPlaybackProgressChangedListener

setPrimaryActionsAdapter

setSecondaryActionsAdapter

setTotalTime

setTotalTimeLong