Matter Cluster 1365 — Push AV Stream Transport Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1365 values in the device shadow use this format:

endpoint_id / 1365 / attribute_id

Example:

{
  "1/1365/0": []
}

Cluster 1365 Features

The FeatureMap attribute (1/1365/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; 3 means every feature listed above is enabled.

Data Types

CMAFInterfaceEnum

This type indicates the exact mode of CMAF that is in use.

ContainerFormatEnum

IngestMethodsEnum

StatusCodeEnum

TransportStatusEnum

TransportTriggerTypeEnum

The Trigger Type determines the basic operation of the Push Transport and when it will actually transmit content.

TriggerActivationReasonEnum

AudioStreamStruct (struct)

This struct holds a video stream id and the symbolic stream name associated with it. For CMAF based transports, this becomes a CMAF Track.

CMAFContainerOptionsStruct (struct)

This struct encodes options for configuration of the CMAF container format.

ContainerOptionsStruct (struct)

This struct encodes the specific container type options struct

SupportedFormatStruct (struct)

This struct holds the combination of container format and ingest method which represents a valid combination for a transport.

TransportConfigurationStruct (struct) — fabric-scoped

This encodes the current configuration of an allocated transport.

TransportMotionTriggerTimeControlStruct (struct)

This struct is used to encode a set of values for controlling the lifecycle of a motion triggered transport.

TransportOptionsStruct (struct)

This encodes the options and configuration of a transport.

TransportTriggerOptionsStruct (struct)

This struct encodes the conditions and options that configures the trigger for the push transport. The transport only start transmitting AV Streams when its associated trigger is activated.

TransportZoneOptionsStruct (struct)

This struct encodes the options that configure the per Zone portion of a Trigger configuration.

VideoStreamStruct (struct)

This struct holds a video stream id and the symbolic stream name associated with it. For CMAF based transports, this becomes a CMAF Track.

Cluster 1365 Attributes

Cluster 1365 defines 2 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 — SupportedFormats

Path example:

1/1365/0

This attribute contains a list of Supported Container Format structs, which represents the combinations of Ingestion Method and Container Format that the Node supports. Nodes must support at least the combination CMAFIngest,CMAF.

Each entry is a SupportedFormatStruct (see Data Types).

Example:

{
  "1/1365/0": []
}

Attribute 1 / 0x0001 — CurrentConnections

Path example:

1/1365/1

This attribute is a list of TransportConfigurationStruct which represents all the allocated connections added via AllocatePushTransport. When this attribute is read over a non Large Message (See Large Message Quality in the Data Model section of MatterCore) capable transport, the TransportOptions field must NOT be included. To get the full details of the connections use the FindTransport command. The maximum size of this list is run-time dependent upon the resource constraints of the system as described in Resource Management and Stream Priorities and the currently used bandwidth of the total available specified by MaxNetworkBandwidth.

Each entry is a TransportConfigurationStruct (see Data Types).

Example:

{
  "1/1365/1": []
}

Cluster 1365 Commands

Cluster 1365 has 6 client-to-server commands and 2 responses.

AcceptedCommandList

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

endpoint_id / 1365 / 65529

{
  "1/1365/65529": [
    0,
    2,
    3,
    4,
    5,
    6
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

For Cluster 1365, always use "cluster_id": 1365. 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: AllocatePushTransport

Purpose

This command must allocate a transport and return a PushTransportConnectionID.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1365,
    "command_name": "AllocatePushTransport",
    "payload": {
      "transportOptions": {
        "streamUsage": 0,
        "videoStreamID": 0,
        "audioStreamID": 0,
        "tlsEndpointID": 0
      }
    }
  }
}

The device answers with AllocatePushTransportResponse (see below).

Command: AllocatePushTransportResponse

Purpose

This command is generated in response to a successful AllocatePushTransport command.

Command Identity

Response Fields

Command: DeallocatePushTransport

Purpose

This command is generated to request the Node deallocates the specified transport.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1365,
    "command_name": "DeallocatePushTransport",
    "payload": {
      "connectionID": 0
    }
  }
}

Command: ModifyPushTransport

Purpose

This command is used to request the Node modifies the configuration of the specified push transport.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1365,
    "command_name": "ModifyPushTransport",
    "payload": {
      "connectionID": 0,
      "transportOptions": {
        "streamUsage": 0,
        "videoStreamID": 0,
        "audioStreamID": 0,
        "tlsEndpointID": 0
      }
    }
  }
}

Command: SetTransportStatus

Purpose

This command is generated to request the Node modifies the Transport Status of a specified transport or all transports.

Command Identity

Payload Fields

TransportStatus values (TransportStatusEnum): 0 = Active, 1 = Inactive

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1365,
    "command_name": "SetTransportStatus",
    "payload": {
      "connectionID": 0,
      "transportStatus": 0
    }
  }
}

Command: ManuallyTriggerTransport

Purpose

This command is generated to request the Node to manually start the specified push transport.

Command Identity

Payload Fields

ActivationReason values (TriggerActivationReasonEnum): 0 = UserInitiated, 1 = Automation, 2 = Emergency, 3 = DoorbellPressed

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1365,
    "command_name": "ManuallyTriggerTransport",
    "payload": {
      "connectionID": 0,
      "activationReason": 0
    }
  }
}

Command: FindTransport

Purpose

This command returns the Transport Configuration for the specified push transport or all allocated transports for the fabric if null.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1365,
    "command_name": "FindTransport",
    "payload": {
      "connectionID": 0
    }
  }
}

The device answers with FindTransportResponse (see below).

Command: FindTransportResponse

Purpose

This command is generated in response to a successful FindTransport command.

Command Identity

Response Fields

Cluster 1365 Events

Event 0 — PushTransportBegin

This event indicates a push transport transmission has begun. With Motion and Continuous based triggers, this event is generated when each new recording starts uploading. With Command based triggers, this event is generated when uploading starts via the ManuallyTriggerTransport command.

Event 1 — PushTransportEnd

This event indicates a push transport upload of the indicated recording has completed. With Motion, Continuous, and Command based triggers, this event is generated when each new recording finishes uploading. The data on this event contains the following information.

SmartphoneKey Notes

• Cluster 1365 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/1365/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.