WebRtcLiveViewTrait.QualityHint

enum WebRtcLiveViewTrait.QualityHint : Enum, ClusterEnum


The quality hint (or preference) for a live view session.

Summary

Enum Values

Fhd

Full High Definition, typically 1080p.

Hd

High Definition, typically 720p.

Qhd

Quad High Definition, typically 1440p.

Sd

Standard Definition, typically one of 240p, 360p, 480p.

Uhd

Ultra High Definition, typically 2160p.

UnknownValue

The enum value is out of range.

Unspecified

Unspecified.

Public functions

String
WebRtcLiveViewTrait.QualityHint
valueOf(value: String)

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

Array<WebRtcLiveViewTrait.QualityHint>

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

Public properties

EnumEntries<WebRtcLiveViewTrait.QualityHint>

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

Fhd

val WebRtcLiveViewTrait.QualityHint.FhdWebRtcLiveViewTrait.QualityHint

Full High Definition, typically 1080p.

Hd

val WebRtcLiveViewTrait.QualityHint.HdWebRtcLiveViewTrait.QualityHint

High Definition, typically 720p.

Qhd

val WebRtcLiveViewTrait.QualityHint.QhdWebRtcLiveViewTrait.QualityHint

Quad High Definition, typically 1440p.

Sd

val WebRtcLiveViewTrait.QualityHint.SdWebRtcLiveViewTrait.QualityHint

Standard Definition, typically one of 240p, 360p, 480p.

Uhd

val WebRtcLiveViewTrait.QualityHint.UhdWebRtcLiveViewTrait.QualityHint

Ultra High Definition, typically 2160p.

UnknownValue

val WebRtcLiveViewTrait.QualityHint.UnknownValueWebRtcLiveViewTrait.QualityHint

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): WebRtcLiveViewTrait.QualityHint

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<WebRtcLiveViewTrait.QualityHint>

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<WebRtcLiveViewTrait.QualityHint>

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.