SessionCommandGroup.Builder

Artifact: androidx.media2:media2-session

View Source

Added in 1.0.0

Deprecated in 1.3.0

---

Kotlin |Java

class SessionCommandGroup.Builder

---

This class is deprecated.

androidx.media2 is deprecated. Please migrate to androidx.media3.

Builds a SessionCommandGroup object.

Summary

Public constructors
Builder()
Builder(commandGroup: SessionCommandGroup) Creates a new builder for SessionCommandGroup with commands copied from another SessionCommandGroup object.

Public functions
SessionCommandGroup.Builder	addAllPredefinedCommands(version: Int) Adds all predefined session commands except for the commands added after the specified version without default implementation.
SessionCommandGroup.Builder	addCommand(command: SessionCommand) Adds a command to this command group.
SessionCommandGroup	build() Builds a SessionCommandGroup.
SessionCommandGroup.Builder	removeCommand(command: SessionCommand) Removes a command from this group which matches given command.

Public constructors

Builder

Added in 1.0.0

Deprecated in 1.3.0

Builder()

Builder

Added in 1.0.0

Deprecated in 1.3.0

Builder(commandGroup: SessionCommandGroup)

Creates a new builder for SessionCommandGroup with commands copied from another SessionCommandGroup object.

Parameters
commandGroup: SessionCommandGroup

Public functions

addAllPredefinedCommands

Added in 1.0.0

Deprecated in 1.3.0

fun addAllPredefinedCommands(version: Int): SessionCommandGroup.Builder

Adds all predefined session commands except for the commands added after the specified version without default implementation. This provides convenient way to add commands with implementation.

When you update support library version, it's recommended to take a look SessionCommand to double check whether this only adds commands that you want. You may increase the version here.

Parameters
version: Int	command version

See also
COMMAND_VERSION_1
COMMAND_VERSION_2
onConnect

addCommand

Added in 1.0.0

Deprecated in 1.3.0

fun addCommand(command: SessionCommand): SessionCommandGroup.Builder

Adds a command to this command group.

Parameters
command: SessionCommand	A command to add. Shouldn't be null.

build

Added in 1.0.0

Deprecated in 1.3.0

fun build(): SessionCommandGroup

Builds a SessionCommandGroup.

Returns
SessionCommandGroup	a new SessionCommandGroup

removeCommand

Added in 1.0.0

Deprecated in 1.3.0

fun removeCommand(command: SessionCommand): SessionCommandGroup.Builder

Removes a command from this group which matches given command.

Parameters
command: SessionCommand	A command to find. Shouldn't be null.