CameraHistoryTrait.Caption

class CameraHistoryTrait.Caption : ClusterStruct


Information about a caption that was detected by the camera.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

Caption(
    captionType: CameraHistoryTrait.CaptionType,
    captionText: String,
    captionLanguage: String
)

Creates the Caption class.

Public functions

open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

Public properties

String
String

The text of the caption.

CameraHistoryTrait.CaptionType

The type of caption that was detected by the camera, where the value comes from CaptionType.

Public constructors

Caption

Caption(
    captionType: CameraHistoryTrait.CaptionType = CaptionType.Unknown,
    captionText: String = "",
    captionLanguage: String = ""
)

Creates the Caption class.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

captionLanguage

val captionLanguage: String

captionText

val captionText: String

The text of the caption.

captionType

val captionType: CameraHistoryTrait.CaptionType

The type of caption that was detected by the camera, where the value comes from CaptionType.