PushAvStreamTransportCommands

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

Known direct subclasses

PushAvStreamTransport

PushAvStreamTransport

API for the PushAvStreamTransport trait.

Commands for the PushAvStreamTransport trait.

Summary

Public functions
`suspend PushAvStreamTransportTrait.AllocatePushTransportCommand.Response`	`allocatePushTransport( transportOptions: PushAvStreamTransportTrait.TransportOptionsStruct )` Allocate a push transport.
`BatchableCommand<PushAvStreamTransportTrait.AllocatePushTransportCommand.Response>`	`allocatePushTransportBatchable( transportOptions: PushAvStreamTransportTrait.TransportOptionsStruct )` The batchable version of `allocatePushTransport` command.
`suspend Unit`	`deallocatePushTransport(connectionId: UShort)` Deallocate a push transport.
`BatchableCommand<Unit>`	`deallocatePushTransportBatchable(connectionId: UShort)` The batchable version of `deallocatePushTransport` command.
`suspend PushAvStreamTransportTrait.FindTransportCommand.Response`	`findTransport(connectionId: UShort?)` Get the transport configuration for the specified push transport or all allocated transports if no `connectionId` is specified.
`BatchableCommand<PushAvStreamTransportTrait.FindTransportCommand.Response>`	`findTransportBatchable(connectionId: UShort?)` The batchable version of `findTransport` command.
`suspend Unit`	`manuallyTriggerTransport( connectionId: UShort, activationReason: PushAvStreamTransportTrait.TriggerActivationReasonEnum, optionalArgs: PushAvStreamTransportTrait.ManuallyTriggerTransportCommand.OptionalArgs.() -> Unit )` Manually trigger a transport.
`BatchableCommand<Unit>`	`manuallyTriggerTransportBatchable( connectionId: UShort, activationReason: PushAvStreamTransportTrait.TriggerActivationReasonEnum, optionalArgs: PushAvStreamTransportTrait.ManuallyTriggerTransportCommand.OptionalArgs.() -> Unit )` The batchable version of `manuallyTriggerTransport` command.
`suspend Unit`	`modifyPushTransport( connectionId: UShort, transportOptions: PushAvStreamTransportTrait.TransportOptionsStruct )` Modify the transport status.
`BatchableCommand<Unit>`	`modifyPushTransportBatchable( connectionId: UShort, transportOptions: PushAvStreamTransportTrait.TransportOptionsStruct )` The batchable version of `modifyPushTransport` command.
`suspend Unit`	`setTransportStatus( connectionId: UShort?, transportStatus: PushAvStreamTransportTrait.TransportStatusEnum )` Set the transport status.
`BatchableCommand<Unit>`	`setTransportStatusBatchable( connectionId: UShort?, transportStatus: PushAvStreamTransportTrait.TransportStatusEnum )` The batchable version of `setTransportStatus` command.

Public functions

allocatePushTransport

suspend fun allocatePushTransport(
    transportOptions: PushAvStreamTransportTrait.TransportOptionsStruct
): PushAvStreamTransportTrait.AllocatePushTransportCommand.Response

Allocate a push transport.

Parameters
`transportOptions: PushAvStreamTransportTrait.TransportOptionsStruct`	The transport options to allocate.

Returns
`PushAvStreamTransportTrait.AllocatePushTransportCommand.Response`	Contains the allocated transport.

allocatePushTransportBatchable

fun allocatePushTransportBatchable(
    transportOptions: PushAvStreamTransportTrait.TransportOptionsStruct
): BatchableCommand<PushAvStreamTransportTrait.AllocatePushTransportCommand.Response>

The batchable version of allocatePushTransport command.

Allocate a push transport.

Parameters
`transportOptions: PushAvStreamTransportTrait.TransportOptionsStruct`	The transport options to allocate.

Returns
`BatchableCommand<PushAvStreamTransportTrait.AllocatePushTransportCommand.Response>`	BatchableCommand

deallocatePushTransport

suspend fun deallocatePushTransport(connectionId: UShort): Unit

Deallocate a push transport.

deallocatePushTransportBatchable

fun deallocatePushTransportBatchable(connectionId: UShort): BatchableCommand<Unit>

The batchable version of deallocatePushTransport command.

Deallocate a push transport.

Returns
`BatchableCommand<Unit>`	BatchableCommand

findTransport

suspend fun findTransport(connectionId: UShort?): PushAvStreamTransportTrait.FindTransportCommand.Response

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

Returns
`PushAvStreamTransportTrait.FindTransportCommand.Response`	Contains the transport configuration.

findTransportBatchable

fun findTransportBatchable(connectionId: UShort?): 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.

Returns
`BatchableCommand<PushAvStreamTransportTrait.FindTransportCommand.Response>`	BatchableCommand

manuallyTriggerTransport

suspend fun manuallyTriggerTransport(
    connectionId: UShort,
    activationReason: PushAvStreamTransportTrait.TriggerActivationReasonEnum,
    optionalArgs: PushAvStreamTransportTrait.ManuallyTriggerTransportCommand.OptionalArgs.() -> Unit = {}
): Unit

Manually trigger a transport.

Parameters
`activationReason: PushAvStreamTransportTrait.TriggerActivationReasonEnum`	The reason for transport trigger activation. Valid values are defined in `TriggerActivationReasonEnum`.
`optionalArgs: PushAvStreamTransportTrait.ManuallyTriggerTransportCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`Unit`	Contains the transport configuration.

manuallyTriggerTransportBatchable

fun manuallyTriggerTransportBatchable(
    connectionId: UShort,
    activationReason: PushAvStreamTransportTrait.TriggerActivationReasonEnum,
    optionalArgs: PushAvStreamTransportTrait.ManuallyTriggerTransportCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<Unit>

The batchable version of manuallyTriggerTransport command.

Manually trigger a transport.

Parameters
`activationReason: PushAvStreamTransportTrait.TriggerActivationReasonEnum`	The reason for transport trigger activation. Valid values are defined in `TriggerActivationReasonEnum`.
`optionalArgs: PushAvStreamTransportTrait.ManuallyTriggerTransportCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`BatchableCommand<Unit>`	BatchableCommand

modifyPushTransport

suspend fun modifyPushTransport(
    connectionId: UShort,
    transportOptions: PushAvStreamTransportTrait.TransportOptionsStruct
): Unit

Modify the transport status.

Parameters
`transportOptions: PushAvStreamTransportTrait.TransportOptionsStruct`	The transport option to set for a connection. Valid values are defined in `TransportOptionsStruct`.

modifyPushTransportBatchable

fun modifyPushTransportBatchable(
    connectionId: UShort,
    transportOptions: PushAvStreamTransportTrait.TransportOptionsStruct
): BatchableCommand<Unit>

The batchable version of modifyPushTransport command.

Modify the transport status.

Parameters
`transportOptions: PushAvStreamTransportTrait.TransportOptionsStruct`	The transport option to set for a connection. Valid values are defined in `TransportOptionsStruct`.

Returns
`BatchableCommand<Unit>`	BatchableCommand

setTransportStatus

suspend fun setTransportStatus(
    connectionId: UShort?,
    transportStatus: PushAvStreamTransportTrait.TransportStatusEnum
): Unit

Set the transport status.

Parameters
`transportStatus: PushAvStreamTransportTrait.TransportStatusEnum`	The transport status to set. Valid values are defined in `TransportStatusEnum`.

setTransportStatusBatchable

fun setTransportStatusBatchable(
    connectionId: UShort?,
    transportStatus: PushAvStreamTransportTrait.TransportStatusEnum
): 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`.

Returns
`BatchableCommand<Unit>`	BatchableCommand