CameraAvStreamManagementTrait.VideoSensorParamsStruct

class CameraAvStreamManagementTrait.VideoSensorParamsStruct : ClusterStruct


Defines parameters related to the videoSensorParams attribute.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

VideoSensorParamsStruct(
    sensorWidth: UShort,
    sensorHeight: UShort,
    maxFps: UShort,
    maxHdrfps: OptionalValue<UShort>
)

Creates the VideoSensorParamsStruct 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 maximum frames per second that the video sensor can capture.

OptionalValue<UShort>

An optional field for the maximum frames per second that the video sensor can capture when High Dynamic Range (HDR) is enabled.

UShort

The height that the video sensor supports.

UShort

The width that the video sensor supports.

Public constructors

VideoSensorParamsStruct

VideoSensorParamsStruct(
    sensorWidth: UShort,
    sensorHeight: UShort,
    maxFps: UShort,
    maxHdrfps: OptionalValue<UShort> = OptionalValue.absent()
)

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

maxFps

val maxFpsUShort

The maximum frames per second that the video sensor can capture.

maxHdrfps

val maxHdrfpsOptionalValue<UShort>

An optional field for the maximum frames per second that the video sensor can capture when High Dynamic Range (HDR) is enabled.

sensorHeight

val sensorHeightUShort

The height that the video sensor supports.

sensorWidth

val sensorWidthUShort

The width that the video sensor supports.