CameraTimelineTrait.EventType

enum CameraTimelineTrait.EventType : Enum, ClusterEnum


The type of event that the camera recorded.

Summary

Enum Values

Animal

Animal detected.

COAlarm

CO alarm detected.

DogBark

Dog bark detected.

Doorbell

Doorbell pressed.

FamiliarFace

A familiar face was detected.

GarageDoorClosed

Garage door closed.

GarageDoorOpened

Garage door opened.

GlassBreak

Glass break detected.

Motion

Motion detected.

PackageDelivered

Package delivered.

PackageInTransit

Package in transit.

PackageRetrieved

Package retrieved.

Person

Person detected.

PersonTalking

Person talking detected.

RecordingCOAlarm

Recording of a CO alarm.

RecordingSmokeAlarm

Recording of a smoke alarm.

SecurityAlarm

Security alarm detected.

SmokeAlarm

Smoke alarm detected.

Sound

Sound detected.

UnfamiliarFace

An unfamiliar face was detected.

Unknown

Unknown event.

UnknownValue

The enum value is out of range.

Vehicle

Vehicle detected.

Public functions

String
CameraTimelineTrait.EventType
valueOf(value: String)

Returns the enum constant of this type with the specified name.

Array<CameraTimelineTrait.EventType>

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

Public properties

EnumEntries<CameraTimelineTrait.EventType>

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

open String

Trait identifier of the Matter Cluster that defines the enum Data Type.

open String

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

open ULong

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

Enum Values

FamiliarFace

val CameraTimelineTrait.EventType.FamiliarFaceCameraTimelineTrait.EventType

A familiar face was detected.

PersonTalking

val CameraTimelineTrait.EventType.PersonTalkingCameraTimelineTrait.EventType

Person talking detected.

RecordingCOAlarm

val CameraTimelineTrait.EventType.RecordingCOAlarmCameraTimelineTrait.EventType

Recording of a CO alarm.

RecordingSmokeAlarm

val CameraTimelineTrait.EventType.RecordingSmokeAlarmCameraTimelineTrait.EventType

Recording of a smoke alarm.

SecurityAlarm

val CameraTimelineTrait.EventType.SecurityAlarmCameraTimelineTrait.EventType

Security alarm detected.

UnfamiliarFace

val CameraTimelineTrait.EventType.UnfamiliarFaceCameraTimelineTrait.EventType

An unfamiliar face was detected.

UnknownValue

val CameraTimelineTrait.EventType.UnknownValueCameraTimelineTrait.EventType

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

valueOf

fun valueOf(value: String): CameraTimelineTrait.EventType

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<CameraTimelineTrait.EventType>

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 entriesEnumEntries<CameraTimelineTrait.EventType>

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 traitIdString

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

typeName

open val typeNameString

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

value

open val valueULong

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