AvStreamAnalysisTrait.EventTriggerTypeEnum

enum AvStreamAnalysisTrait.EventTriggerTypeEnum : Enum, ClusterEnum


All possible event triggers that could be supported.

Summary

Enum Values

AnimalDetected

An animal was detected.

CoAlarm

Carbon monoxide alarm sound detected.

DogBark

A dog bark was detected.

Face

Used for face identification.

GarageDoor

An event related to a garage door, for example, open or close.

GlassBreak

Glass breaking sound detected.

Motion

Motion detected.

PackageDelivered

A package was delivered.

PackageDetected

A package was detected.

PackageRetrieved

A package was retrieved.

PersonDetected

A person was detected.

PersonTalking

A person is talking.

SmokeAlarm

Smoke alarm sound detected.

Sound

Sound detected.

UnknownValue

The enum value is out of range.

VehicleDetected

A vehicle was detected.

VideoAnalysisDescription

Used for generating a description of the video.

Public functions

String
AvStreamAnalysisTrait.EventTriggerTypeEnum
valueOf(value: String)

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

Array<AvStreamAnalysisTrait.EventTriggerTypeEnum>

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

Public properties

EnumEntries<AvStreamAnalysisTrait.EventTriggerTypeEnum>

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

GarageDoor

val AvStreamAnalysisTrait.EventTriggerTypeEnum.GarageDoorAvStreamAnalysisTrait.EventTriggerTypeEnum

An event related to a garage door, for example, open or close.

UnknownValue

val AvStreamAnalysisTrait.EventTriggerTypeEnum.UnknownValueAvStreamAnalysisTrait.EventTriggerTypeEnum

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.

VideoAnalysisDescription

val AvStreamAnalysisTrait.EventTriggerTypeEnum.VideoAnalysisDescriptionAvStreamAnalysisTrait.EventTriggerTypeEnum

Used for generating a description of the video.

Public functions

valueOf

fun valueOf(value: String): AvStreamAnalysisTrait.EventTriggerTypeEnum

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<AvStreamAnalysisTrait.EventTriggerTypeEnum>

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<AvStreamAnalysisTrait.EventTriggerTypeEnum>

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.