PushAvStreamTransportTrait.TransportConfigurationStruct

class PushAvStreamTransportTrait.TransportConfigurationStruct : ClusterStruct


The transport configuration.

Summary

Public constructors

TransportConfigurationStruct(
    connectionId: UShort,
    transportStatus: PushAvStreamTransportTrait.TransportStatusEnum,
    transportOptions: OptionalValue<PushAvStreamTransportTrait.TransportOptionsStruct>,
    fabricIndex: UByte
)

Creates the TransportConfigurationStruct class.

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.

UByte

The fabric index ID of the transport.

OptionalValue<PushAvStreamTransportTrait.TransportOptionsStruct>

Detailed configuration options for the transport, such as stream usage, URLs, and trigger settings.

PushAvStreamTransportTrait.TransportStatusEnum

The transport status.

Public constructors

TransportConfigurationStruct

TransportConfigurationStruct(
    connectionId: UShort,
    transportStatus: PushAvStreamTransportTrait.TransportStatusEnum = TransportStatusEnum.Active,
    transportOptions: OptionalValue<PushAvStreamTransportTrait.TransportOptionsStruct> = OptionalValue.absent(),
    fabricIndex: UByte
)

Creates the TransportConfigurationStruct class.

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.

fabricIndex

val fabricIndexUByte

The fabric index ID of the transport.

transportOptions

val transportOptionsOptionalValue<PushAvStreamTransportTrait.TransportOptionsStruct>

Detailed configuration options for the transport, such as stream usage, URLs, and trigger settings.

transportStatus

val transportStatusPushAvStreamTransportTrait.TransportStatusEnum

The transport status.