CameraAvStreamManagement

@Generated(value = ["GoogleHomePlatformCodegen"])
interface CameraAvStreamManagement : CameraAvStreamManagementTrait.Attributes, MatterTrait, Updatable, CameraAvStreamManagementCommands

API for the CameraAvStreamManagement trait. This trait provides an interface for managing active audio and video streams on a camera device. This is a minimalistic custom version of the CameraAvStreamManagement standard Matter cluster, and provides functionality for some of the camera settings.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<CameraAvStreamManagement>

Inherited functions
From com.google.home.matter.standard.CameraAvStreamManagementCommands
suspend CameraAvStreamManagementTrait.AudioStreamAllocateCommand.Response
audioStreamAllocate(
    streamUsage: CameraAvStreamManagementTrait.StreamUsageEnum,
    audioCodec: CameraAvStreamManagementTrait.AudioCodecEnum,
    channelCount: UByte,
    sampleRate: UInt,
    bitRate: UInt,
    bitDepth: UByte
)
BatchableCommand<CameraAvStreamManagementTrait.AudioStreamAllocateCommand.Response>
audioStreamAllocateBatchable(
    streamUsage: CameraAvStreamManagementTrait.StreamUsageEnum,
    audioCodec: CameraAvStreamManagementTrait.AudioCodecEnum,
    channelCount: UByte,
    sampleRate: UInt,
    bitRate: UInt,
    bitDepth: UByte
)
suspend Unit
audioStreamDeallocate(audioStreamId: UShort)
BatchableCommand<Unit>
suspend CameraAvStreamManagementTrait.CaptureSnapshotCommand.Response
captureSnapshot(
    snapshotStreamId: UShort?,
    requestedResolution: CameraAvStreamManagementTrait.VideoResolutionStruct
)
BatchableCommand<CameraAvStreamManagementTrait.CaptureSnapshotCommand.Response>
captureSnapshotBatchable(
    snapshotStreamId: UShort?,
    requestedResolution: CameraAvStreamManagementTrait.VideoResolutionStruct
)
suspend Unit
BatchableCommand<Unit>
suspend CameraAvStreamManagementTrait.SnapshotStreamAllocateCommand.Response
BatchableCommand<CameraAvStreamManagementTrait.SnapshotStreamAllocateCommand.Response>
suspend Unit
snapshotStreamDeallocate(snapshotStreamId: UShort)
BatchableCommand<Unit>
suspend Unit
BatchableCommand<Unit>
suspend CameraAvStreamManagementTrait.VideoStreamAllocateCommand.Response
videoStreamAllocate(
    streamUsage: CameraAvStreamManagementTrait.StreamUsageEnum,
    videoCodec: CameraAvStreamManagementTrait.VideoCodecEnum,
    minFrameRate: UShort,
    maxFrameRate: UShort,
    minResolution: CameraAvStreamManagementTrait.VideoResolutionStruct,
    maxResolution: CameraAvStreamManagementTrait.VideoResolutionStruct,
    minBitRate: UInt,
    maxBitRate: UInt,
    keyFrameInterval: UShort,
    optionalArgs: CameraAvStreamManagementTrait.VideoStreamAllocateCommand.OptionalArgs.() -> Unit
)
BatchableCommand<CameraAvStreamManagementTrait.VideoStreamAllocateCommand.Response>
videoStreamAllocateBatchable(
    streamUsage: CameraAvStreamManagementTrait.StreamUsageEnum,
    videoCodec: CameraAvStreamManagementTrait.VideoCodecEnum,
    minFrameRate: UShort,
    maxFrameRate: UShort,
    minResolution: CameraAvStreamManagementTrait.VideoResolutionStruct,
    maxResolution: CameraAvStreamManagementTrait.VideoResolutionStruct,
    minBitRate: UInt,
    maxBitRate: UInt,
    keyFrameInterval: UShort,
    optionalArgs: CameraAvStreamManagementTrait.VideoStreamAllocateCommand.OptionalArgs.() -> Unit
)
suspend Unit
videoStreamDeallocate(videoStreamId: UShort)
BatchableCommand<Unit>
suspend Unit
BatchableCommand<Unit>
From com.google.home.matter.standard.CameraAvStreamManagementTrait.Attributes
open StructDescriptor

Returns the descriptor for the struct.
open Any?

Returns the value of the field for the given tag ID.
From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.Updatable
suspend CameraAvStreamManagement
update(
    optimisticReturn: (CameraAvStreamManagement) -> Unit,
    init: CameraAvStreamManagementTrait.MutableAttributes.() -> Unit
)

Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state.

Inherited properties
From com.google.home.matter.standard.CameraAvStreamManagementTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.
List<CameraAvStreamManagementTrait.AudioStreamStruct>?
List<CameraAvStreamManagementTrait.SnapshotStreamStruct>?
List<CameraAvStreamManagementTrait.VideoStreamStruct>?
List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.
UShort

The revision of the server cluster specification supported by the cluster instance.
UShort?
CameraAvStreamManagementTrait.Feature

Whether the server supports zero or more optional cluster features.
List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.
Boolean?
Boolean?
Boolean?
Boolean?
UShort?

The amount of clockwise rotation in degrees that the image has been subjected to, with 0 and 180 being the only supported values.
Boolean?
Boolean?
UByte?
UInt?
UInt?
UInt?
Boolean?
CameraAvStreamManagementTrait.AudioCapabilitiesStruct?
UByte?
UByte?
Boolean?

Indicates whether the microphone is muted.
UByte?
CameraAvStreamManagementTrait.VideoResolutionStruct?

The minimum resolution (width and height) in pixels that the camera allows for its viewport.
CameraAvStreamManagementTrait.TriStateAutoEnum?

The currently selected Night Vision mode.
CameraAvStreamManagementTrait.TriStateAutoEnum?
Boolean?
List<CameraAvStreamManagementTrait.RateDistortionTradeOffPointsStruct>?
List<CameraAvStreamManagementTrait.SnapshotCapabilitiesStruct>?
Boolean?
Boolean?
CameraAvStreamManagementTrait.AudioCapabilitiesStruct?
UByte?

The maximum volume level that can be assigned to the speaker.
UByte?

The minimum volume level that can be assigned to the speaker.
Boolean?
UByte?

The current volume level of the speaker.
CameraAvStreamManagementTrait.ThreeLevelAutoEnum?

The current brightness of the status light.
Boolean?
List<CameraAvStreamManagementTrait.StreamUsageEnum>?
List<CameraAvStreamManagementTrait.StreamUsageEnum>?
CameraAvStreamManagementTrait.TwoWayTalkSupportTypeEnum?
CameraAvStreamManagementTrait.VideoSensorParamsStruct?

The parameters for the video sensor.
CameraAvStreamManagementTrait.ViewportStruct?

The viewport to apply to all streams.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: CameraAvStreamManagement.Attribute): Boolean

supports

fun supports(command: CameraAvStreamManagement.Command): Boolean

Public properties

factory

open val factory: TraitFactory<CameraAvStreamManagement>