RecordingModeTrait.RecordingModeEnum

enum RecordingModeTrait.RecordingModeEnum : Enum, ClusterEnum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.home.google.RecordingModeTrait.RecordingModeEnum

Different types of recording modes supported by the device.

Summary

Enum Values
`Cvr`	Continuous video recording.
`Disabled`	Video recording is disabled, but the camera can still live stream, basic event detectors are still enabled, and images can be captured.
`Ebr`	Event-based recording that only records video when an event is detected by the camera's perception pipeline.
`Etr`	Event-triggered recording that only records a short video when an event is detected by the camera's perception pipeline.
`Images`	Records still images when an event is detected by the camera's perception pipeline.
`LiveView`	The camera supports live streaming, but all event detectors are off and no video or images are recorded.
`UnknownValue`	The enum value is out of range.

Public functions
`String`	`@HomeExperimentalGenericApi toDescription()`
`RecordingModeTrait.RecordingModeEnum`	`valueOf(value: String)` Returns the enum constant of this type with the specified name.
`Array<RecordingModeTrait.RecordingModeEnum>`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Public properties
`EnumEntries<RecordingModeTrait.RecordingModeEnum>`	`entries` Returns a representation of an immutable list of all enum entries, in the order they're declared.
`open String`	`traitId` Trait identifier of the Matter Cluster that defines the enum Data Type.
`open String`	`typeName` Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.
`open ULong`	`value` Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.

Enum Values

Cvr

val RecordingModeTrait.RecordingModeEnum.Cvr: RecordingModeTrait.RecordingModeEnum

Continuous video recording.

Disabled

val RecordingModeTrait.RecordingModeEnum.Disabled: RecordingModeTrait.RecordingModeEnum

Video recording is disabled, but the camera can still live stream, basic event detectors are still enabled, and images can be captured.

Ebr

val RecordingModeTrait.RecordingModeEnum.Ebr: RecordingModeTrait.RecordingModeEnum

Event-based recording that only records video when an event is detected by the camera's perception pipeline. For battery-powered cameras, the user can configure the maximum duration of a recorded clip.

Etr

val RecordingModeTrait.RecordingModeEnum.Etr: RecordingModeTrait.RecordingModeEnum

Event-triggered recording that only records a short video when an event is detected by the camera's perception pipeline. The user cannot configure the duration of the recorded clip.

Images

val RecordingModeTrait.RecordingModeEnum.Images: RecordingModeTrait.RecordingModeEnum

Records still images when an event is detected by the camera's perception pipeline.

LiveView

val RecordingModeTrait.RecordingModeEnum.LiveView: RecordingModeTrait.RecordingModeEnum

The camera supports live streaming, but all event detectors are off and no video or images are recorded.

UnknownValue

val RecordingModeTrait.RecordingModeEnum.UnknownValue: RecordingModeTrait.RecordingModeEnum

The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.

Public functions

toDescription

@HomeExperimentalGenericApi
fun toDescription(): String

valueOf

fun valueOf(value: String): RecordingModeTrait.RecordingModeEnum

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
`kotlin.IllegalArgumentException`	if this enum type has no constant with the specified name

values

fun values(): Array<RecordingModeTrait.RecordingModeEnum>

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

Public properties

entries

val entries: EnumEntries<RecordingModeTrait.RecordingModeEnum>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.

traitId

open val traitId: String

Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.

typeName

open val typeName: String

Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.

value

open val value: ULong

Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.