RecordingModeTrait.RecordingModeStruct

class RecordingModeTrait.RecordingModeStruct : ClusterStruct


Contains information about a specific recording mode.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

RecordingModeStruct(
    recordingMode: RecordingModeTrait.RecordingModeEnum,
    maxDuration: UInt,
    expiryDurationSeconds: UInt
)

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

UInt

The time to live of the recorded clip in seconds.

UInt

The maximum duration of a recorded clip in seconds.

RecordingModeTrait.RecordingModeEnum

An instance of RecordingModeEnum that specifies the type of recording mode.

Public constructors

RecordingModeStruct

RecordingModeStruct(
    recordingMode: RecordingModeTrait.RecordingModeEnum = RecordingModeEnum.Disabled,
    maxDuration: UInt,
    expiryDurationSeconds: UInt
)

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

expiryDurationSeconds

val expiryDurationSecondsUInt

The time to live of the recorded clip in seconds.

maxDuration

val maxDurationUInt

The maximum duration of a recorded clip in seconds.

recordingMode

val recordingModeRecordingModeTrait.RecordingModeEnum

An instance of RecordingModeEnum that specifies the type of recording mode.