MediaPlaybackCommands

@Generated(value = ["GoogleHomePlatformCodegen"])
interface MediaPlaybackCommands

Known direct subclasses

MediaPlayback

MediaPlayback

API for the MediaPlayback trait.

Summary

Public functions
`suspend Unit`	`activateAudioTrack(trackId: String, audioOutputIndex: UByte)`
`BatchableCommand<Unit>`	`activateAudioTrackBatchable(trackId: String, audioOutputIndex: UByte)`
`suspend Unit`	`activateTextTrack(trackId: String)`
`BatchableCommand<Unit>`	`activateTextTrackBatchable(trackId: String)`
`suspend Unit`	`deactivateTextTrack()`
`BatchableCommand<Unit>`	`deactivateTextTrackBatchable()`
`suspend MediaPlaybackTrait.FastForwardCommand.Response`	`fastForward(optionalArgs: MediaPlaybackTrait.FastForwardCommand.OptionalArgs.() -> Unit)` Fast forward the current media.
`BatchableCommand<MediaPlaybackTrait.FastForwardCommand.Response>`	`fastForwardBatchable(optionalArgs: MediaPlaybackTrait.FastForwardCommand.OptionalArgs.() -> Unit)` The batchable version of `fastForward` command.
`suspend MediaPlaybackTrait.NextCommand.Response`	`next()` Move to the next item in the media.
`BatchableCommand<MediaPlaybackTrait.NextCommand.Response>`	`nextBatchable()` The batchable version of `next` command.
`suspend MediaPlaybackTrait.PauseCommand.Response`	`pause()` Pause the current media.
`BatchableCommand<MediaPlaybackTrait.PauseCommand.Response>`	`pauseBatchable()` The batchable version of `pause` command.
`suspend MediaPlaybackTrait.PlayCommand.Response`	`play()` Play the current media.
`BatchableCommand<MediaPlaybackTrait.PlayCommand.Response>`	`playBatchable()` The batchable version of `play` command.
`suspend MediaPlaybackTrait.PreviousCommand.Response`	`previous()` Move to the previous item in the current media.
`BatchableCommand<MediaPlaybackTrait.PreviousCommand.Response>`	`previousBatchable()` The batchable version of `previous` command.
`suspend MediaPlaybackTrait.RewindCommand.Response`	`rewind(optionalArgs: MediaPlaybackTrait.RewindCommand.OptionalArgs.() -> Unit)` Rewind the current media.
`BatchableCommand<MediaPlaybackTrait.RewindCommand.Response>`	`rewindBatchable(optionalArgs: MediaPlaybackTrait.RewindCommand.OptionalArgs.() -> Unit)` The batchable version of `rewind` command.
`suspend MediaPlaybackTrait.SeekCommand.Response`	`seek(position: ULong)` Change the playback position in the current media to the specified position.
`BatchableCommand<MediaPlaybackTrait.SeekCommand.Response>`	`seekBatchable(position: ULong)` The batchable version of `seek` command.
`suspend MediaPlaybackTrait.SkipBackwardCommand.Response`	`skipBackward(deltaPositionMilliseconds: ULong)` Skip backward by a specified amount of time within the current media.
`BatchableCommand<MediaPlaybackTrait.SkipBackwardCommand.Response>`	`skipBackwardBatchable(deltaPositionMilliseconds: ULong)` The batchable version of `skipBackward` command.
`suspend MediaPlaybackTrait.SkipForwardCommand.Response`	`skipForward(deltaPositionMilliseconds: ULong)` Skip forward by a specified amount of time within the current media.
`BatchableCommand<MediaPlaybackTrait.SkipForwardCommand.Response>`	`skipForwardBatchable(deltaPositionMilliseconds: ULong)` The batchable version of `skipForward` command.
`suspend MediaPlaybackTrait.StartOverCommand.Response`	`startOver()` Start over from the beginning of the current media.
`BatchableCommand<MediaPlaybackTrait.StartOverCommand.Response>`	`startOverBatchable()` The batchable version of `startOver` command.
`suspend MediaPlaybackTrait.StopCommand.Response`	`stop()` Stop playing the current media.
`BatchableCommand<MediaPlaybackTrait.StopCommand.Response>`	`stopBatchable()` The batchable version of `stop` command.

Public functions

activateAudioTrack

suspend fun activateAudioTrack(trackId: String, audioOutputIndex: UByte): Unit

activateAudioTrackBatchable

fun activateAudioTrackBatchable(trackId: String, audioOutputIndex: UByte): BatchableCommand<Unit>

activateTextTrack

suspend fun activateTextTrack(trackId: String): Unit

activateTextTrackBatchable

fun activateTextTrackBatchable(trackId: String): BatchableCommand<Unit>

deactivateTextTrack

suspend fun deactivateTextTrack(): Unit

deactivateTextTrackBatchable

fun deactivateTextTrackBatchable(): BatchableCommand<Unit>

fastForward

suspend fun fastForward(optionalArgs: MediaPlaybackTrait.FastForwardCommand.OptionalArgs.() -> Unit = {}): MediaPlaybackTrait.FastForwardCommand.Response

Fast forward the current media.

Parameters
`optionalArgs: MediaPlaybackTrait.FastForwardCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`MediaPlaybackTrait.FastForwardCommand.Response`	The outcome of the `FastForward` command.

fastForwardBatchable

fun fastForwardBatchable(optionalArgs: MediaPlaybackTrait.FastForwardCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<MediaPlaybackTrait.FastForwardCommand.Response>

The batchable version of fastForward command.

Fast forward the current media.

Parameters
`optionalArgs: MediaPlaybackTrait.FastForwardCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`BatchableCommand<MediaPlaybackTrait.FastForwardCommand.Response>`	BatchableCommand

suspend fun next(): MediaPlaybackTrait.NextCommand.Response

Move to the next item in the media.

Returns
`MediaPlaybackTrait.NextCommand.Response`	The outcome of the `Next` command.

nextBatchable

fun nextBatchable(): BatchableCommand<MediaPlaybackTrait.NextCommand.Response>

The batchable version of next command.

Move to the next item in the media.

Returns
`BatchableCommand<MediaPlaybackTrait.NextCommand.Response>`	BatchableCommand

pause

suspend fun pause(): MediaPlaybackTrait.PauseCommand.Response

Pause the current media.

Returns
`MediaPlaybackTrait.PauseCommand.Response`	The outcome of the `Pause` command.

pauseBatchable

fun pauseBatchable(): BatchableCommand<MediaPlaybackTrait.PauseCommand.Response>

The batchable version of pause command.

Pause the current media.

Returns
`BatchableCommand<MediaPlaybackTrait.PauseCommand.Response>`	BatchableCommand

play

suspend fun play(): MediaPlaybackTrait.PlayCommand.Response

Play the current media.

Returns
`MediaPlaybackTrait.PlayCommand.Response`	The outcome of the `Play` command.

playBatchable

fun playBatchable(): BatchableCommand<MediaPlaybackTrait.PlayCommand.Response>

The batchable version of play command.

Play the current media.

Returns
`BatchableCommand<MediaPlaybackTrait.PlayCommand.Response>`	BatchableCommand

suspend fun previous(): MediaPlaybackTrait.PreviousCommand.Response

Move to the previous item in the current media.

Returns
`MediaPlaybackTrait.PreviousCommand.Response`	The outcome of the `Previous` command.

previousBatchable

fun previousBatchable(): BatchableCommand<MediaPlaybackTrait.PreviousCommand.Response>

The batchable version of previous command.

Move to the previous item in the current media.

Returns
`BatchableCommand<MediaPlaybackTrait.PreviousCommand.Response>`	BatchableCommand

rewind

suspend fun rewind(optionalArgs: MediaPlaybackTrait.RewindCommand.OptionalArgs.() -> Unit = {}): MediaPlaybackTrait.RewindCommand.Response

Rewind the current media.

Parameters
`optionalArgs: MediaPlaybackTrait.RewindCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`MediaPlaybackTrait.RewindCommand.Response`	The outcome of the `Rewind` command.

rewindBatchable

fun rewindBatchable(optionalArgs: MediaPlaybackTrait.RewindCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<MediaPlaybackTrait.RewindCommand.Response>

The batchable version of rewind command.

Rewind the current media.

Parameters
`optionalArgs: MediaPlaybackTrait.RewindCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`BatchableCommand<MediaPlaybackTrait.RewindCommand.Response>`	BatchableCommand

seek

suspend fun seek(position: ULong): MediaPlaybackTrait.SeekCommand.Response

Change the playback position in the current media to the specified position.

Parameters
`position: ULong`	The position to seek to, relative to the start of the media, in milliseconds.

Returns
`MediaPlaybackTrait.SeekCommand.Response`	The outcome of the `Seek` command.

seekBatchable

fun seekBatchable(position: ULong): BatchableCommand<MediaPlaybackTrait.SeekCommand.Response>

The batchable version of seek command.

Change the playback position in the current media to the specified position.

Parameters
`position: ULong`	The position to seek to, relative to the start of the media, in milliseconds.

Returns
`BatchableCommand<MediaPlaybackTrait.SeekCommand.Response>`	BatchableCommand

skipBackward

suspend fun skipBackward(deltaPositionMilliseconds: ULong): MediaPlaybackTrait.SkipBackwardCommand.Response

Skip backward by a specified amount of time within the current media.

Parameters
`deltaPositionMilliseconds: ULong`	The duration of the time span to skip backward in the media, in milliseconds.

Returns
`MediaPlaybackTrait.SkipBackwardCommand.Response`	The outcome of the `SkipBackward` command.

skipBackwardBatchable

fun skipBackwardBatchable(deltaPositionMilliseconds: ULong): BatchableCommand<MediaPlaybackTrait.SkipBackwardCommand.Response>

The batchable version of skipBackward command.

Skip backward by a specified amount of time within the current media.

Parameters
`deltaPositionMilliseconds: ULong`	The duration of the time span to skip backward in the media, in milliseconds.

Returns
`BatchableCommand<MediaPlaybackTrait.SkipBackwardCommand.Response>`	BatchableCommand

skipForward

suspend fun skipForward(deltaPositionMilliseconds: ULong): MediaPlaybackTrait.SkipForwardCommand.Response

Skip forward by a specified amount of time within the current media.

Parameters
`deltaPositionMilliseconds: ULong`	The duration of the time span to skip forward in the media, in milliseconds.

Returns
`MediaPlaybackTrait.SkipForwardCommand.Response`	The outcome of the `SkipForward` command.

skipForwardBatchable

fun skipForwardBatchable(deltaPositionMilliseconds: ULong): BatchableCommand<MediaPlaybackTrait.SkipForwardCommand.Response>

The batchable version of skipForward command.

Skip forward by a specified amount of time within the current media.

Parameters
`deltaPositionMilliseconds: ULong`	The duration of the time span to skip forward in the media, in milliseconds.

Returns
`BatchableCommand<MediaPlaybackTrait.SkipForwardCommand.Response>`	BatchableCommand

startOver

suspend fun startOver(): MediaPlaybackTrait.StartOverCommand.Response

Start over from the beginning of the current media.

Returns
`MediaPlaybackTrait.StartOverCommand.Response`	The outcome of the `StartOver` command.

startOverBatchable

fun startOverBatchable(): BatchableCommand<MediaPlaybackTrait.StartOverCommand.Response>

The batchable version of startOver command.

Start over from the beginning of the current media.

Returns
`BatchableCommand<MediaPlaybackTrait.StartOverCommand.Response>`	BatchableCommand

stop

suspend fun stop(): MediaPlaybackTrait.StopCommand.Response

Stop playing the current media.

Returns
`MediaPlaybackTrait.StopCommand.Response`	The outcome of the `Stop` command.

stopBatchable

fun stopBatchable(): BatchableCommand<MediaPlaybackTrait.StopCommand.Response>

The batchable version of stop command.

Stop playing the current media.

Returns
`BatchableCommand<MediaPlaybackTrait.StopCommand.Response>`	BatchableCommand