CameraTimelineTrait.VideoUnavailableReason

enum CameraTimelineTrait.VideoUnavailableReason : Enum, ClusterEnum

kotlin.Any
   ↳ kotlin.Enum
     ↳ com.google.home.google.CameraTimelineTrait.VideoUnavailableReason

The reason why the video is unavailable.

Summary

Enum Values
BatteryFault

The device has a battery fault.
BatteryOverride

The battery override has disabled the video.
Charging

The camera is charging.
DeviceUpdating

The device is updating.
EtrMode

The device is in Event-Triggered Recording (ETR) mode, so only a limited amount of video is available.
NoEvents

There are no events to show.
NotConnected

The device is not connected.
Occupancy

The occupancy has disabled the video.
PrivacySwitch

The privacy switch has disabled the video.
Schedule

The schedule has disabled the video.
StillImageOnly

The device is still image only.
ThermalOverride

The thermal override has disabled the video.
UnknownValue

The enum value is out of range.
Unmounted

The device is unmounted.
Unspecified

Unspecified reason.
UsedByDuo

Deprecated
User

The user has disabled the video.

Public functions
String
CameraTimelineTrait.VideoUnavailableReason
valueOf(value: String)

Returns the enum constant of this type with the specified name.
Array<CameraTimelineTrait.VideoUnavailableReason>

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

Public properties
EnumEntries<CameraTimelineTrait.VideoUnavailableReason>

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

BatteryFault

val CameraTimelineTrait.VideoUnavailableReason.BatteryFault: CameraTimelineTrait.VideoUnavailableReason

The device has a battery fault.

BatteryOverride

val CameraTimelineTrait.VideoUnavailableReason.BatteryOverride: CameraTimelineTrait.VideoUnavailableReason

The battery override has disabled the video.

Charging

val CameraTimelineTrait.VideoUnavailableReason.Charging: CameraTimelineTrait.VideoUnavailableReason

The camera is charging.

DeviceUpdating

val CameraTimelineTrait.VideoUnavailableReason.DeviceUpdating: CameraTimelineTrait.VideoUnavailableReason

The device is updating.

EtrMode

val CameraTimelineTrait.VideoUnavailableReason.EtrMode: CameraTimelineTrait.VideoUnavailableReason

The device is in Event-Triggered Recording (ETR) mode, so only a limited amount of video is available.

NoEvents

val CameraTimelineTrait.VideoUnavailableReason.NoEvents: CameraTimelineTrait.VideoUnavailableReason

There are no events to show.

NotConnected

val CameraTimelineTrait.VideoUnavailableReason.NotConnected: CameraTimelineTrait.VideoUnavailableReason

The device is not connected.

Occupancy

val CameraTimelineTrait.VideoUnavailableReason.Occupancy: CameraTimelineTrait.VideoUnavailableReason

The occupancy has disabled the video.

PrivacySwitch

val CameraTimelineTrait.VideoUnavailableReason.PrivacySwitch: CameraTimelineTrait.VideoUnavailableReason

The privacy switch has disabled the video.

Schedule

val CameraTimelineTrait.VideoUnavailableReason.Schedule: CameraTimelineTrait.VideoUnavailableReason

The schedule has disabled the video.

StillImageOnly

val CameraTimelineTrait.VideoUnavailableReason.StillImageOnly: CameraTimelineTrait.VideoUnavailableReason

The device is still image only.

ThermalOverride

val CameraTimelineTrait.VideoUnavailableReason.ThermalOverride: CameraTimelineTrait.VideoUnavailableReason

The thermal override has disabled the video.

UnknownValue

val CameraTimelineTrait.VideoUnavailableReason.UnknownValue: CameraTimelineTrait.VideoUnavailableReason

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.

Unmounted

val CameraTimelineTrait.VideoUnavailableReason.Unmounted: CameraTimelineTrait.VideoUnavailableReason

The device is unmounted.

Unspecified

val CameraTimelineTrait.VideoUnavailableReason.Unspecified: CameraTimelineTrait.VideoUnavailableReason

Unspecified reason.

UsedByDuo

val CameraTimelineTrait.VideoUnavailableReason.UsedByDuo: CameraTimelineTrait.VideoUnavailableReason

Deprecated

User

val CameraTimelineTrait.VideoUnavailableReason.User: CameraTimelineTrait.VideoUnavailableReason

The user has disabled the video.

Public functions

toDescription

@HomeExperimentalGenericApi
fun toDescription(): String

valueOf

fun valueOf(value: String): CameraTimelineTrait.VideoUnavailableReason

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.VideoUnavailableReason>

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

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.