CameraAvStreamManagementTrait.SnapshotStreamStruct

class CameraAvStreamManagementTrait.SnapshotStreamStruct : ClusterStruct


Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

SnapshotStreamStruct(
    snapshotStreamId: UShort,
    imageCodec: CameraAvStreamManagementTrait.ImageCodecEnum,
    frameRate: UShort,
    minResolution: CameraAvStreamManagementTrait.VideoResolutionStruct,
    maxResolution: CameraAvStreamManagementTrait.VideoResolutionStruct,
    quality: UByte,
    referenceCount: UByte,
    encodedPixels: Boolean,
    hardwareEncoder: Boolean,
    watermarkEnabled: OptionalValue<Boolean>,
    osdEnabled: OptionalValue<Boolean>
)

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

SnapshotStreamStruct

SnapshotStreamStruct(
    snapshotStreamId: UShort,
    imageCodec: CameraAvStreamManagementTrait.ImageCodecEnum = ImageCodecEnum.JPEG,
    frameRate: UShort,
    minResolution: CameraAvStreamManagementTrait.VideoResolutionStruct = VideoResolutionStruct(),
    maxResolution: CameraAvStreamManagementTrait.VideoResolutionStruct = VideoResolutionStruct(),
    quality: UByte,
    referenceCount: UByte,
    encodedPixels: Boolean = false,
    hardwareEncoder: Boolean = false,
    watermarkEnabled: OptionalValue<Boolean> = OptionalValue.absent(),
    osdEnabled: OptionalValue<Boolean> = OptionalValue.absent()
)

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

encodedPixels

val encodedPixelsBoolean

frameRate

val frameRateUShort

hardwareEncoder

val hardwareEncoderBoolean

osdEnabled

val osdEnabledOptionalValue<Boolean>

quality

val qualityUByte

referenceCount

val referenceCountUByte

snapshotStreamId

val snapshotStreamIdUShort

watermarkEnabled

val watermarkEnabledOptionalValue<Boolean>