CameraAvStreamManagementTrait.VideoStreamStruct

class CameraAvStreamManagementTrait.VideoStreamStruct : ClusterStruct


Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

VideoStreamStruct(
    videoStreamId: UShort,
    streamUsage: CameraAvStreamManagementTrait.StreamUsageEnum,
    videoCodec: CameraAvStreamManagementTrait.VideoCodecEnum,
    minFrameRate: UShort,
    maxFrameRate: UShort,
    minResolution: CameraAvStreamManagementTrait.VideoResolutionStruct,
    maxResolution: CameraAvStreamManagementTrait.VideoResolutionStruct,
    minBitRate: UInt,
    maxBitRate: UInt,
    keyFrameInterval: UShort,
    watermarkEnabled: OptionalValue<Boolean>,
    osdEnabled: OptionalValue<Boolean>,
    referenceCount: UByte
)

Public functions

open StructDescriptor

Returns the descriptor for the struct.

open Any?

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

Public constructors

VideoStreamStruct

VideoStreamStruct(
    videoStreamId: UShort,
    streamUsage: CameraAvStreamManagementTrait.StreamUsageEnum = StreamUsageEnum.Internal,
    videoCodec: CameraAvStreamManagementTrait.VideoCodecEnum = VideoCodecEnum.H264,
    minFrameRate: UShort,
    maxFrameRate: UShort,
    minResolution: CameraAvStreamManagementTrait.VideoResolutionStruct = VideoResolutionStruct(),
    maxResolution: CameraAvStreamManagementTrait.VideoResolutionStruct = VideoResolutionStruct(),
    minBitRate: UInt,
    maxBitRate: UInt,
    keyFrameInterval: UShort,
    watermarkEnabled: OptionalValue<Boolean> = OptionalValue.absent(),
    osdEnabled: OptionalValue<Boolean> = OptionalValue.absent(),
    referenceCount: UByte
)

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

keyFrameInterval

val keyFrameIntervalUShort

maxBitRate

val maxBitRateUInt

maxFrameRate

val maxFrameRateUShort

minBitRate

val minBitRateUInt

minFrameRate

val minFrameRateUShort

osdEnabled

val osdEnabledOptionalValue<Boolean>

referenceCount

val referenceCountUByte

videoStreamId

val videoStreamIdUShort

watermarkEnabled

val watermarkEnabledOptionalValue<Boolean>