PushAvStreamTransportTrait.CmafContainerOptionsStruct

class PushAvStreamTransportTrait.CmafContainerOptionsStruct : ClusterStruct


The container type and related options.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

CmafContainerOptionsStruct(
    cmafInterface: PushAvStreamTransportTrait.CmafInterfaceEnum,
    segmentDuration: UShort,
    chunkDuration: UShort,
    sessionGroup: UByte,
    trackName: String,
    cencKey: OptionalValue<ByteArray>,
    cencKeyId: OptionalValue<ByteArray>,
    metadataEnabled: OptionalValue<Boolean>
)

Creates the CMAFContainerOptionsStruct 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<ByteArray>

The common encryption key.

OptionalValue<ByteArray>

The common encryption key ID.

UShort

The chunk duration.

PushAvStreamTransportTrait.CmafInterfaceEnum

CMAF interface type (Interface1, Interface2DASH, Interface2HLS).

OptionalValue<Boolean>

Whether metadata is enabled.

UShort

The duration of each segment in the CMAF stream.

UByte

An identifier for grouping sessions.

String

The name of the media track.

Public constructors

CmafContainerOptionsStruct

CmafContainerOptionsStruct(
    cmafInterface: PushAvStreamTransportTrait.CmafInterfaceEnum = CmafInterfaceEnum.Interface1,
    segmentDuration: UShort,
    chunkDuration: UShort,
    sessionGroup: UByte,
    trackName: String = "",
    cencKey: OptionalValue<ByteArray> = OptionalValue.absent(),
    cencKeyId: OptionalValue<ByteArray> = OptionalValue.absent(),
    metadataEnabled: OptionalValue<Boolean> = OptionalValue.absent()
)

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

cencKey

val cencKeyOptionalValue<ByteArray>

The common encryption key.

cencKeyId

val cencKeyIdOptionalValue<ByteArray>

The common encryption key ID.

chunkDuration

val chunkDurationUShort

The chunk duration.

cmafInterface

val cmafInterfacePushAvStreamTransportTrait.CmafInterfaceEnum

CMAF interface type (Interface1, Interface2DASH, Interface2HLS).

metadataEnabled

val metadataEnabledOptionalValue<Boolean>

Whether metadata is enabled.

segmentDuration

val segmentDurationUShort

The duration of each segment in the CMAF stream.

sessionGroup

val sessionGroupUByte

An identifier for grouping sessions.

trackName

val trackNameString

The name of the media track.