Matter Cluster 1361 — Camera AV Stream Management Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1361 values in the device shadow use this format:

endpoint_id / 1361 / attribute_id

Example:

{
  "1/1361/6": 1
}

Cluster 1361 Features

The FeatureMap attribute (1/1361/65532) is a bitmap. Each bit set means the device implements that feature and the attributes and commands that depend on it.

Example: FeatureMap = 0 means no optional feature is enabled; 2047 means every feature listed above is enabled.

Data Types

AudioCodecEnum

This data type provides an enumeration of the audio codecs supported by the camera.

ImageCodecEnum

This data type provides an enumeration of the image codecs supported by the camera.

TriStateAutoEnum

This data type is derived from enum8 and is used for tri-state settings on a device, where a setting can be in one of three states, i.e., On, Off, or Automatic.

TwoWayTalkSupportTypeEnum

This data type provides an enumeration of the different modes of bi-directional audio communication that are supported by the camera.

VideoCodecEnum

This data type provides an enumeration of the video codecs supported by the camera.

AVMetadataStruct (struct)

This struct is used to encode the metadata generated by the device and is included by the various transports that handle audio and video streams. When encoded in TLV binary format and placed inside other standards, this is represented using the RFC8141 compliant string urn:csa:matter:av-metadata.

AudioCapabilitiesStruct (struct)

This struct is used to express the audio capabilities of the camera.

AudioStreamStruct (struct)

This struct is used to capture all constituent parameters of an audio stream in order to fully characterize it.

RateDistortionTradeOffPointsStruct (struct)

This struct is used to define a set of parameters of the hardware video encoder that alter the rate distortion trade-off points. The points are expressed as the minimum bitrate and resolution for each supported codec type.

SnapshotCapabilitiesStruct (struct)

This struct is used to define the set of parameters that characterize a snapshot image that is used to build a snapshot stream.

SnapshotStreamStruct (struct)

This struct is used to capture all constituent parameters of a snapshot stream in order to fully characterize it.

VideoResolutionStruct (struct)

This object defines the resolution parameters in pixels which can be used for defining the resolutions of different video streams.

VideoSensorParamsStruct (struct)

This struct is used to define a video sensor and its characteristics.

VideoStreamStruct (struct)

This struct is used to capture all constituent parameters of a video stream in order to fully characterize it.

Cluster 1361 Attributes

Cluster 1361 defines 42 attributes plus the global attributes. Conformance: M mandatory, O optional, a feature code means "mandatory when that feature is present", square brackets mean "optional when …".

Global attributes

Attribute Details

Attribute 0 / 0x0000 — MaxConcurrentEncoders

Path example:

1/1361/0

Indicates the maximum number of concurrent encoders supported by the camera.

Example:

{
  "1/1361/0": 1
}

Attribute 1 / 0x0001 — MaxEncodedPixelRate

Path example:

1/1361/1

Indicates the maximum data rate in encoded pixels per second that the camera can produce given the hardware encoder resources it has. This value is manufacturer specified. If the camera supports Snapshots and requires hardware encoder resources to produce those Snapshots, then this attribute is present, and a manufacturer specific value is present in each SnapshotCapabilities MaxFrameRate entry that requires hardware resources to produce.

Example:

{
  "1/1361/1": 1
}

Attribute 2 / 0x0002 — VideoSensorParams

Path example:

1/1361/2

Indicates the set of video sensor parameters for the camera. These include the video sensor dimensions, its frame rate and HDR capabilities.

Value is a VideoSensorParamsStruct struct (see Data Types).

Example:

{
  "1/1361/2": {
    "sensorWidth": 64,
    "sensorHeight": 64,
    "maxFPS": 1,
    "maxHDRFPS": 1
  }
}

Attribute 3 / 0x0003 — NightVisionUsesInfrared

Path example:

1/1361/3

Indicates if the night vision mode is infrared based or not. A value of TRUE indicates infrared mode with a cut filter being used. A value of FALSE indicates color is used. When infrared is active and the resulting content is in black and white, the BlackAndWhiteActive field inside any produced AVMetadataStruct is TRUE.

Example:

{
  "1/1361/3": true
}

Attribute 4 / 0x0004 — MinViewportResolution

Path example:

1/1361/4

Indicates the minimum resolution (width and height) in pixels that the camera allows for its viewport. The choice of the minimum viewport width and height is, typically, directed towards maintaining the best image quality (reduced distortion) for a given size of the video sensor, for different camera functions, e.g., digital zoom. Furthermore, the minimum viewport size and the video sensor size also dictate the upscaling capabilities and requirements of the image processor.

Value is a VideoResolutionStruct struct (see Data Types).

Example:

{
  "1/1361/4": {
    "width": 1,
    "height": 1
  }
}

Attribute 5 / 0x0005 — RateDistortionTradeOffPoints

Path example:

1/1361/5

This attribute lists the set of rate distortion trade-off points between resolution, frame rate and bitrate for each supported hardware encoder.

Each entry is a RateDistortionTradeOffPointsStruct (see Data Types).

Example:

{
  "1/1361/5": []
}

Attribute 6 / 0x0006 — MaxContentBufferSize

Path example:

1/1361/6

Indicates the maximum size of the content buffer in bytes. This buffer holds the compressed and/or raw content for audio/video pre-roll, queued transmissions, the current frame for each snapshot stream, and the metadata context for recording events. For devices which support more than one encoder, the device must evenly allocate this buffer space amongst all streams that utilize pre-roll content such as the Push AV Stream Transport Cluster.

Example:

{
  "1/1361/6": 1
}

Attribute 7 / 0x0007 — MicrophoneCapabilities

Path example:

1/1361/7

Indicates the audio capabilities of the microphone in terms of the codec used, supported sample rates and the number of channels.

Value is a AudioCapabilitiesStruct struct (see Data Types).

Example:

{
  "1/1361/7": {
    "maxNumberOfChannels": 1,
    "supportedCodecs": [],
    "supportedSampleRates": [],
    "supportedBitDepths": []
  }
}

Attribute 8 / 0x0008 — SpeakerCapabilities

Path example:

1/1361/8

Indicates the audio capabilities of the speaker in terms of the supported codecs, sample rates, and the number of channels when a speaker is present.

Value is a AudioCapabilitiesStruct struct (see Data Types).

Example:

{
  "1/1361/8": {
    "maxNumberOfChannels": 1,
    "supportedCodecs": [],
    "supportedSampleRates": [],
    "supportedBitDepths": []
  }
}

Attribute 9 / 0x0009 — TwoWayTalkSupport

Path example:

1/1361/9

Indicates the type of two-way talk support the device has, e.g., NotSupported, HalfDuplex, or FullDuplex.

Values (TwoWayTalkSupportTypeEnum):

Example:

{
  "1/1361/9": 0
}

Attribute 10 / 0x000A — SnapshotCapabilities

Path example:

1/1361/10

Indicates the list of supported snapshot capabilities the device has. This list is a set of entries for image codec, resolution, maximum frame rate, hardware encoder, and encoded pixels.

Each entry is a SnapshotCapabilitiesStruct (see Data Types).

Example:

{
  "1/1361/10": []
}

Attribute 11 / 0x000B — MaxNetworkBandwidth

Path example:

1/1361/11

Indicates the maximum network bandwidth in bits per second that the device would consume for the transmission of its media streams.

Example:

{
  "1/1361/11": 1
}

Attribute 12 / 0x000C — CurrentFrameRate

Path example:

1/1361/12

Indicates the current logical frame rate of the sensor in frames per second.

Example:

{
  "1/1361/12": 1
}

Attribute 13 / 0x000D — HDRModeEnabled

Path example:

1/1361/13

No condensed specification text is available for HDRModeEnabled; use the type, conformance and constraint below together with the cluster description above.

Example:

{
  "1/1361/13": true
}

Attribute 14 / 0x000E — SupportedStreamUsages

Path example:

1/1361/14

Indicates the list of Stream Usages that are supported by the camera. Manufacturers provides a usages list that is appropriate to their product. If a usage is found in this list, then it can be used in the StreamUsagePriorities attribute. The ordering and values of this list must match the values found in StreamUsagePriorities after a factory reset.

Example:

{
  "1/1361/14": []
}

Attribute 15 / 0x000F — AllocatedVideoStreams

Path example:

1/1361/15

Indicates the list of allocated video streams on the device.

Each entry is a VideoStreamStruct (see Data Types).

Example:

{
  "1/1361/15": []
}

Attribute 16 / 0x0010 — AllocatedAudioStreams

Path example:

1/1361/16

Indicates the list of allocated audio streams on the device.

Each entry is a AudioStreamStruct (see Data Types).

Example:

{
  "1/1361/16": []
}

Attribute 17 / 0x0011 — AllocatedSnapshotStreams

Path example:

1/1361/17

Indicates the list of allocated snapshot streams on the device.

Each entry is a SnapshotStreamStruct (see Data Types).

Example:

{
  "1/1361/17": []
}

Attribute 18 / 0x0012 — StreamUsagePriorities

Path example:

1/1361/18

Indicates a list of the video stream usages represented in a ranked order of their priorities, starting with Index 0 having the stream usage type with the highest priority. See Resource Management and Stream Priorities for further details. Only usages found in the SupportedStreamUsages attribute can be included. To change the contents, use the SetStreamPriorities command.

Example:

{
  "1/1361/18": []
}

Attribute 19 / 0x0013 — SoftRecordingPrivacyModeEnabled

Path example:

1/1361/19

This attribute indicates the current value of the soft privacy mode for transports using the Stream Usage types Recording and Analysis. A value of TRUE indicates that delivery of video frames and audio samples from any streams to these transports is skipped. A value of TRUE also indicates that no new transports using these stream usage values can be created or started. When FALSE, these transports can be resumed or started, and have video frames and audio samples delivered.

Example:

{
  "1/1361/19": true
}

Attribute 20 / 0x0014 — SoftLivestreamPrivacyModeEnabled

Path example:

1/1361/20

This attribute indicates the current value of the soft privacy mode for transports using the Stream Usage type LiveView. A value of TRUE indicates that delivery of video frames and audio samples from any streams to these transports is skipped. A value of TRUE also indicates that no new transports using this stream usage type can be created or started. When FALSE, these transports can be resumed or started, and have video frames and audio samples delivered.

Example:

{
  "1/1361/20": true
}

Attribute 21 / 0x0015 — HardPrivacyModeOn

Path example:

1/1361/21

This attribute indicates the current value of the hard privacy mode for all streams. This is controlled via a physical button or switch, potentially. A value of TRUE indicates that all streams are currently paused. When FALSE, the streams may resume if they are not already paused by their corresponding soft privacy mode.

Example:

{
  "1/1361/21": true
}

Attribute 22 / 0x0016 — NightVision

Path example:

1/1361/22

This attribute indicates the currently selected Night Vision mode. A value of Off means the device will never activate its Night Vision mode of operation. A value of On means the Night Vision mode of operation is always active. A value of Auto means the device will automatically move between active and inactive based on the light level it detects.

Values (TriStateAutoEnum):

Example:

{
  "1/1361/22": 0
}

Attribute 23 / 0x0017 — NightVisionIllum

Path example:

1/1361/23

This attribute indicates the currently selected the Night Vision Illumination mode. A value of Off means the device will never activate its built-in Night Vision Illumination. A value of On means the built-in Night Vision Illumination is always active. A value of Auto means the device will automatically enable its built-in Night Vision Illumination based on the light level it detects.

Values (TriStateAutoEnum):

Example:

{
  "1/1361/23": 0
}

Attribute 24 / 0x0018 — Viewport

Path example:

1/1361/24

This attribute is a ViewportStruct representing the viewport to apply to all streams. The coordinate values represent the upper left corner and lower right corner coordinates of the source rectangle on the sensor. The coordinate values are within the two-dimensional Cartesian plane of size SensorWidth and SensorHeight (See VideoSensorParamsStruct in the VideoSensorParams) with the origin (0,0) being the upper left corner, positive X and Y values moving right and down across the Cartesian plane respectively, and (SensorWidth, SensorHeight) being the lower right corner.

Example:

{
  "1/1361/24": 0
}

Attribute 25 / 0x0019 — SpeakerMuted

Path example:

1/1361/25

This attribute indicates whether the speaker is currently muted or not. A value of TRUE indicates that the speaker has been muted and must not play anything. A value of FALSE indicates that the Speaker is enabled.

Example:

{
  "1/1361/25": true
}

Attribute 26 / 0x001A — SpeakerVolumeLevel

Path example:

1/1361/26

This attribute indicates the current volume level of the speaker.

Example:

{
  "1/1361/26": 100
}

Attribute 27 / 0x001B — SpeakerMaxLevel

Path example:

1/1361/27

This attribute indicates the maximum value of the SpeakerVolumeLevel that can be assigned.

Example:

{
  "1/1361/27": 100
}

Attribute 28 / 0x001C — SpeakerMinLevel

Path example:

1/1361/28

This attribute indicates the minimum value of the SpeakerVolumeLevel that can be assigned.

Example:

{
  "1/1361/28": 100
}

Attribute 29 / 0x001D — MicrophoneMuted

Path example:

1/1361/29

This attribute indicates whether the microphone is currently muted or not. A value of TRUE indicates that the microphone has been muted. In this state, the microphone data is replaced with all 0 bits, representing silence. A value of FALSE indicates that the microphone is On and is capable of transmitting audio.

Example:

{
  "1/1361/29": true
}

Attribute 30 / 0x001E — MicrophoneVolumeLevel

Path example:

1/1361/30

This attribute indicates the current gain or volume level of the microphone.

Example:

{
  "1/1361/30": 100
}

Attribute 31 / 0x001F — MicrophoneMaxLevel

Path example:

1/1361/31

This attribute indicates the maximum value of the MicrophoneVolumeLevel that can be assigned.

Example:

{
  "1/1361/31": 100
}

Attribute 32 / 0x0020 — MicrophoneMinLevel

Path example:

1/1361/32

This attribute indicates the minimum value of the MicrophoneVolumeLevel that can be assigned.

Example:

{
  "1/1361/32": 100
}

Attribute 33 / 0x0021 — MicrophoneAGCEnabled

Path example:

1/1361/33

No condensed specification text is available for MicrophoneAGCEnabled; use the type, conformance and constraint below together with the cluster description above.

Example:

{
  "1/1361/33": true
}

Attribute 34 / 0x0022 — ImageRotation

Path example:

1/1361/34

This attribute indicates the amount of clockwise rotation in degrees that the image has been subjected to. This attribute may be present if the underlying hardware allows for arbitrary angle rotation within the full 360 degree range. If this attribute is not present, then discrete angle rotation may be supported via the ImageRotationDiscreteAngles. A value of 0 means no rotation has been applied.

Example:

{
  "1/1361/34": 1
}

Attribute 35 / 0x0023 — ImageFlipHorizontal

Path example:

1/1361/35

This attribute indicates whether the image has been flipped horizontally or not. A value of TRUE indicates that the image has been flipped horizontally.

Example:

{
  "1/1361/35": true
}

Attribute 36 / 0x0024 — ImageFlipVertical

Path example:

1/1361/36

This attribute indicates whether the image has been flipped vertically or not. A value of TRUE indicates that the image has been flipped vertically.

Example:

{
  "1/1361/36": true
}

Attribute 37 / 0x0025 — LocalVideoRecordingEnabled

Path example:

1/1361/37

This attribute indicates whether local storage based video recording is enabled. A value of TRUE indicates that local storage based video recording has been enabled.

Example:

{
  "1/1361/37": true
}

Attribute 38 / 0x0026 — LocalSnapshotRecordingEnabled

Path example:

1/1361/38

This attribute indicates whether local storage based snapshot recording is enabled. A value of TRUE indicates that local storage based snapshot recording has been enabled.

Example:

{
  "1/1361/38": true
}

Attribute 39 / 0x0027 — StatusLightEnabled

Path example:

1/1361/39

This attribute indicates whether the status light has been enabled or not. A value of TRUE indicates the status light has been enabled. When enabled, the camera may use it for visual signaling purposes to indicate various states of the camera.

Example:

{
  "1/1361/39": true
}

Attribute 40 / 0x0028 — StatusLightBrightness

Path example:

1/1361/40

This attribute indicates the brightness level of the status light.

Example:

{
  "1/1361/40": 0
}

Attribute 41 / 0x0029 — ImageRotationDiscreteAngles

Path example:

1/1361/41

This attribute indicates the amount of clockwise rotation in specific angles of 0, 90, 180, and 270 degrees. This attribute is used by cameras that do not have the capability of full arbitrary rotation angles that can be set via the ImageRotation attribute. Note that the ImageFlipHorizontal and the ImageFlipVertical attributes only allow for a lateral inversion or mirror reflection of the image along the horizontal and/or vertical axes. A value of 0 means no rotation has been applied.

Example:

{
  "1/1361/41": 1
}

Cluster 1361 Commands

Cluster 1361 has 10 client-to-server commands and 4 responses.

AcceptedCommandList

The AcceptedCommandList attribute lists the command IDs the endpoint actually implements:

endpoint_id / 1361 / 65529

{
  "1/1361/65529": [
    0,
    2,
    3,
    5,
    6,
    7,
    9,
    10,
    11,
    12
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1361,
    "command_name": "AudioStreamAllocate",
    "payload": {},
    "timed_request_timeout_ms": 1000
  }
}

For Cluster 1361, always use "cluster_id": 1361. Payload keys are the command field names in lowerCamelCase. Octet-string fields are base64-encoded. timed_request_timeout_ms is required for timed commands and ignored otherwise.

Command: AudioStreamAllocate

Purpose

This command must allocate an audio stream on the camera and return an allocated audio stream identifier.

Command Identity

Payload Fields

AudioCodec values (AudioCodecEnum): 0 = OPUS, 1 = AAC-LC

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1361,
    "command_name": "AudioStreamAllocate",
    "payload": {
      "streamUsage": 0,
      "audioCodec": 0,
      "channelCount": 1,
      "sampleRate": 1,
      "bitRate": 1,
      "bitDepth": 1
    }
  }
}

The device answers with AudioStreamAllocateResponse (see below).

Command: AudioStreamAllocateResponse

Purpose

This command is sent by the camera in response to the AudioStreamAllocate command, carrying the newly allocated or re-used audio stream identifier.

Command Identity

Response Fields

Command: AudioStreamDeallocate

Purpose

This command must deallocate an audio stream on the camera, corresponding to the given audio stream identifier.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1361,
    "command_name": "AudioStreamDeallocate",
    "payload": {
      "audioStreamID": 0
    }
  }
}

Command: VideoStreamAllocate

Purpose

This command must allocate a video stream on the camera and return an allocated video stream identifier.

Command Identity

Payload Fields

VideoCodec values (VideoCodecEnum): 0 = H264, 1 = HEVC, 2 = VVC, 3 = AV1

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1361,
    "command_name": "VideoStreamAllocate",
    "payload": {
      "streamUsage": 0,
      "videoCodec": 0,
      "minFrameRate": 1,
      "maxFrameRate": 1,
      "minResolution": {
        "width": 1,
        "height": 1
      },
      "maxResolution": {
        "width": 1,
        "height": 1
      },
      "minBitRate": 1,
      "maxBitRate": 1,
      "keyFrameInterval": 0
    }
  }
}

The device answers with VideoStreamAllocateResponse (see below).

Command: VideoStreamAllocateResponse

Purpose

This command is sent by the camera in response to the VideoStreamAllocate command, carrying the newly allocated or re-used video stream identifier.

Command Identity

Response Fields

Command: VideoStreamModify

Purpose

This command is used to modify a stream specified by the VideoStreamID.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1361,
    "command_name": "VideoStreamModify",
    "payload": {
      "videoStreamID": 0
    }
  }
}

Command: VideoStreamDeallocate

Purpose

This command must deallocate a video stream on the camera, corresponding to the given video stream identifier.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1361,
    "command_name": "VideoStreamDeallocate",
    "payload": {
      "videoStreamID": 0
    }
  }
}

Command: SnapshotStreamAllocate

Purpose

This command must allocate a snapshot stream on the device and return an allocated snapshot stream identifier.

Command Identity

Payload Fields

ImageCodec values (ImageCodecEnum): 0 = JPEG, 1 = HEIC

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1361,
    "command_name": "SnapshotStreamAllocate",
    "payload": {
      "imageCodec": 0,
      "maxFrameRate": 1,
      "minResolution": {
        "width": 1,
        "height": 1
      },
      "maxResolution": {
        "width": 1,
        "height": 1
      },
      "quality": 1
    }
  }
}

The device answers with SnapshotStreamAllocateResponse (see below).

Command: SnapshotStreamAllocateResponse

Purpose

This command is sent by the device in response to the SnapshotStreamAllocate command, carrying the newly allocated or re-used snapshot stream identifier.

Command Identity

Response Fields

Command: SnapshotStreamModify

Purpose

This command is used to modify a stream specified by the VideoStreamID.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1361,
    "command_name": "SnapshotStreamModify",
    "payload": {
      "snapshotStreamID": 0
    }
  }
}

Command: SnapshotStreamDeallocate

Purpose

This command must deallocate an snapshot stream on the camera, corresponding to the given snapshot stream identifier.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1361,
    "command_name": "SnapshotStreamDeallocate",
    "payload": {
      "snapshotStreamID": 0
    }
  }
}

Command: SetStreamPriorities

Purpose

This command must set the relative priorities of the various stream usages on the camera. The camera then bases its allocation of resources for each stream allocation based on the order of these stream priorities. In order to avoid the complexity of dynamically changing the configurations of currently active streams, this command must NOT be invoked when there are allocated streams. If changes are required while streams are allocated, all existing streams would need to be deallocated before invoking this command.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1361,
    "command_name": "SetStreamPriorities",
    "payload": {
      "streamPriorities": []
    }
  }
}

Command: CaptureSnapshot

Purpose

This command returns a Snapshot from the camera.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1361,
    "command_name": "CaptureSnapshot",
    "payload": {
      "snapshotStreamID": 0,
      "requestedResolution": {
        "width": 1,
        "height": 1
      }
    }
  }
}

The device answers with CaptureSnapshotResponse (see below).

Command: CaptureSnapshotResponse

Purpose

This command is sent by the device in response to the CaptureSnapshot command, carrying the requested snapshot.

Command Identity

Response Fields

ImageCodec values (ImageCodecEnum): 0 = JPEG, 1 = HEIC

Cluster 1361 Events

Cluster 1361 defines no events.

SmartphoneKey Notes

• Cluster 1361 is not currently exposed by SmartphoneKey devices. This page documents the Matter 1.6.1 specification so that future devices can be interpreted without changes to the backend.
• Shadow paths follow endpoint/1361/attribute; attribute values that the device reports as unreadable are written as n/a.
• Attribute IDs, command IDs and enum values on this page come from the CSA Matter 1.6.1 data model; descriptions are condensed from the specification text.