PushAvStreamTransportTrait.TransportOptionsStruct

class PushAvStreamTransportTrait.TransportOptionsStruct : ClusterStruct


The transport options.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

TransportOptionsStruct(
    streamUsage: PushAvStreamTransportTrait.StreamUsageEnum,
    videoStreamId: OptionalValue<UShort?>,
    audioStreamId: OptionalValue<UShort?>,
    tlsEndpointId: UShort,
    url: String,
    triggerOptions: PushAvStreamTransportTrait.TransportTriggerOptionsStruct,
    ingestMethod: PushAvStreamTransportTrait.IngestMethodsEnum,
    containerOptions: PushAvStreamTransportTrait.ContainerOptionsStruct,
    expiryTime: OptionalValue<UInt>
)

Creates the TransportOptionsStruct 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

OptionalValue<UShort?>

The ID of the audio stream.

PushAvStreamTransportTrait.ContainerOptionsStruct

The container type and related options.

OptionalValue<UInt>

The time of stream expiration, in seconds from the UNIX epoch.

PushAvStreamTransportTrait.IngestMethodsEnum

The ingest method.

PushAvStreamTransportTrait.StreamUsageEnum

The type of the camera stream.

UShort

The ID of the TLS endpoint.

PushAvStreamTransportTrait.TransportTriggerOptionsStruct

Settings related to triggering events.

String

The URL of the camera stream.

OptionalValue<UShort?>

The ID of the video stream.

Public constructors

TransportOptionsStruct

TransportOptionsStruct(
    streamUsage: PushAvStreamTransportTrait.StreamUsageEnum = StreamUsageEnum.Internal,
    videoStreamId: OptionalValue<UShort?> = OptionalValue.absent(),
    audioStreamId: OptionalValue<UShort?> = OptionalValue.absent(),
    tlsEndpointId: UShort,
    url: String = "",
    triggerOptions: PushAvStreamTransportTrait.TransportTriggerOptionsStruct = TransportTriggerOptionsStruct(),
    ingestMethod: PushAvStreamTransportTrait.IngestMethodsEnum = IngestMethodsEnum.CMAFIngest,
    containerOptions: PushAvStreamTransportTrait.ContainerOptionsStruct = ContainerOptionsStruct(),
    expiryTime: OptionalValue<UInt> = OptionalValue.absent()
)

Creates the TransportOptionsStruct 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

audioStreamId

val audioStreamIdOptionalValue<UShort?>

The ID of the audio stream.

containerOptions

val containerOptionsPushAvStreamTransportTrait.ContainerOptionsStruct

The container type and related options.

expiryTime

val expiryTimeOptionalValue<UInt>

The time of stream expiration, in seconds from the UNIX epoch.

ingestMethod

val ingestMethodPushAvStreamTransportTrait.IngestMethodsEnum

The ingest method.

streamUsage

val streamUsagePushAvStreamTransportTrait.StreamUsageEnum

The type of the camera stream.

tlsEndpointId

val tlsEndpointIdUShort

The ID of the TLS endpoint.

triggerOptions

val triggerOptionsPushAvStreamTransportTrait.TransportTriggerOptionsStruct

Settings related to triggering events.

url

val urlString

The URL of the camera stream.

videoStreamId

val videoStreamIdOptionalValue<UShort?>

The ID of the video stream.