PushAvStreamTransportTrait.SetTransportStatusCommand.Request

class PushAvStreamTransportTrait.SetTransportStatusCommand.Request : ClusterStruct


The request payload for the SetTransportStatus command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Request(
    connectionId: UShort?,
    transportStatus: PushAvStreamTransportTrait.TransportStatusEnum
)

Creates a request payload for the SetTransportStatus command.

Public functions

open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

Public properties

UShort?

The connection ID of the transport to set.

PushAvStreamTransportTrait.TransportStatusEnum

The transport status to set.

Public constructors

Request

Request(
    connectionId: UShort? = null,
    transportStatus: PushAvStreamTransportTrait.TransportStatusEnum = TransportStatusEnum.Active
)

Creates a request payload for the SetTransportStatus command.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

connectionId

val connectionIdUShort?

The connection ID of the transport to set.

transportStatus

val transportStatusPushAvStreamTransportTrait.TransportStatusEnum

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