PushAvStreamTransportCommands

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

Known direct subclasses
PushAvStreamTransport

API for the PushAvStreamTransport trait.


Commands for the PushAvStreamTransport trait.

Summary

Public functions

suspend PushAvStreamTransportTrait.FindTransportCommand.Response

Get the transport configuration for the specified push transport or all allocated transports if no connectionID is specified.

BatchableCommand<PushAvStreamTransportTrait.FindTransportCommand.Response>

The batchable version of findTransport command.

suspend Unit

Set the transport status.

BatchableCommand<Unit>

The batchable version of setTransportStatus command.

Public functions

findTransport

suspend fun findTransport(optionalArgs: PushAvStreamTransportTrait.FindTransportCommand.OptionalArgs.() -> Unit = {}): PushAvStreamTransportTrait.FindTransportCommand.Response

Get the transport configuration for the specified push transport or all allocated transports if no connectionID is specified.

Parameters
optionalArgs: PushAvStreamTransportTrait.FindTransportCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

Returns
PushAvStreamTransportTrait.FindTransportCommand.Response

Contains the transport configuration.

findTransportBatchable

fun findTransportBatchable(optionalArgs: PushAvStreamTransportTrait.FindTransportCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<PushAvStreamTransportTrait.FindTransportCommand.Response>

The batchable version of findTransport command.

Get the transport configuration for the specified push transport or all allocated transports if no connectionID is specified.

Parameters
optionalArgs: PushAvStreamTransportTrait.FindTransportCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

setTransportStatus

suspend fun setTransportStatus(
    transportStatus: PushAvStreamTransportTrait.TransportStatusEnum,
    optionalArgs: PushAvStreamTransportTrait.SetTransportStatusCommand.OptionalArgs.() -> Unit = {}
): Unit

Set the transport status.

Parameters
transportStatus: PushAvStreamTransportTrait.TransportStatusEnum

The transport status to set. Valid values are defined in TransportStatusEnum.

optionalArgs: PushAvStreamTransportTrait.SetTransportStatusCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

setTransportStatusBatchable

fun setTransportStatusBatchable(
    transportStatus: PushAvStreamTransportTrait.TransportStatusEnum,
    optionalArgs: PushAvStreamTransportTrait.SetTransportStatusCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<Unit>

The batchable version of setTransportStatus command.

Set the transport status.

Parameters
transportStatus: PushAvStreamTransportTrait.TransportStatusEnum

The transport status to set. Valid values are defined in TransportStatusEnum.

optionalArgs: PushAvStreamTransportTrait.SetTransportStatusCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

Returns
BatchableCommand<Unit>

BatchableCommand