CommandButton.Builder

Builder()

[will be deprecated] Use Builder instead to define the Icon for this button. A separate resource id via setIconResId is no longer required unless for ICON_UNDEFINED.

@UnstableApi
Builder(@CommandButton.Icon icon: Int)

Creates a builder.

fun build(): CommandButton!

Builds a CommandButton.

@UnstableApi
@CanIgnoreReturnValue
fun setCustomIconResId(resId: @DrawableRes Int): CommandButton.Builder!

Sets the resource id of an icon that is used when the predefined Icon is not available or set to ICON_UNDEFINED.

@CanIgnoreReturnValue
fun setDisplayName(displayName: CharSequence!): CommandButton.Builder!

Sets a display name of this button.

@CanIgnoreReturnValue
fun setEnabled(enabled: Boolean): CommandButton.Builder!

Sets whether the button is enabled.

Note that this value will be set to false for MediaController instances if the corresponding command is not available to this controller (see setPlayerCommand and setSessionCommand).

The default value is true.

@CanIgnoreReturnValue
fun setExtras(extras: Bundle!): CommandButton.Builder!

Sets an extra Bundle of this button.

@CanIgnoreReturnValue
fun setIconResId(resId: @DrawableRes Int): CommandButton.Builder!

[will be deprecated] The icon should be defined with the constructor Icon parameter in Builder instead. Only in case the existing list of icons is not sufficient, use ICON_UNDEFINED and set a separate resource id with setCustomIconResId.

@UnstableApi
@CanIgnoreReturnValue
fun setIconUri(uri: Uri!): CommandButton.Builder!

Sets a content or resourceUri for the icon of this button.

Note that this Uri may be used when the predefined Icon is not available or set to ICON_UNDEFINED. It can be used in addition to setCustomIconResId for consumers that are capable of loading the content or resource Uri.

@CanIgnoreReturnValue
fun setPlayerCommand(@Player.Command playerCommand: Int): CommandButton.Builder!

Sets the Player.Command that is required to be available when the button is clicked.

Cannot set this if a session command is already set via setSessionCommand.

@CanIgnoreReturnValue
fun setSessionCommand(sessionCommand: SessionCommand!): CommandButton.Builder!

Sets the SessionCommand that is required to be available when the button is clicked.

Cannot set this if a player command is already set via setPlayerCommand.

@UnstableApi
@CanIgnoreReturnValue
fun setSlots(@CommandButton.Slot slots: IntArray!): CommandButton.Builder!

Sets the allowed Slot positions for this button.

The button is only allowed in the defined slots. If none of the slots can display the button, either because the slots do not exist, are already occupied or the UI surface does not allow the specific type of button in these slots, the button will not be displayed at all.

When multiple slots are provided, they define a preference order. The button will be placed in the first slot in the list that exists, isn't already occupied and that allows this type of button.

When not specified, the default value depends on the associated player command and the Icon set in the constructor:

• COMMAND_PLAY_PAUSE and/or ICON_PLAY, ICON_PAUSE: SLOT_CENTRAL
• COMMAND_SEEK_TO_PREVIOUS, COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM, COMMAND_SEEK_BACK and/or ICON_PREVIOUS, ICON_SKIP_BACK, ICON_REWIND: SLOT_BACK
• COMMAND_SEEK_TO_NEXT, COMMAND_SEEK_TO_NEXT_MEDIA_ITEM, COMMAND_SEEK_FORWARD and/or ICON_NEXT, ICON_SKIP_FORWARD, ICON_FAST_FORWARD: SLOT_FORWARD
• Anything else: SLOT_OVERFLOW