Matter Cluster 1363 — WebRTC Transport Provider Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1363 values in the device shadow use this format:

endpoint_id / 1363 / attribute_id

Example:

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

Cluster 1363 Features

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

Cluster 1363 Attributes

Cluster 1363 defines 1 attribute 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 — CurrentSessions

Path example:

1/1363/0

This attribute is a list of WebRTCSessionStruct, which represents all the active WebRTC Sessions.

Example:

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

Cluster 1363 Commands

Cluster 1363 has 5 client-to-server commands and 2 responses.

AcceptedCommandList

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

endpoint_id / 1363 / 65529

{
  "1/1363/65529": [
    0,
    2,
    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": 1363,
    "command_name": "SolicitOffer",
    "payload": {},
    "timed_request_timeout_ms": 1000
  }
}

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

Purpose

Requests that the Provider initiates a new session with the Offer / Answer flow in a way that allows for options to be passed and work with devices needing the standby flow.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1363,
    "command_name": "SolicitOffer",
    "payload": {
      "streamUsage": 0,
      "originatingEndpointID": 1
    }
  }
}

The device answers with SolicitOfferResponse (see below).

Command: SolicitOfferResponse

Purpose

This command is generated in response to a SolicitOffer command. This response contains information about the session and streams created and/or if a deferred offer will take place. Upon receipt, the client must create a new WebRTCSessionStruct populated with the values from this command, along with the accessing Peer Node ID and Local Fabric Index entries stored in the Secure Session Context as the PeerNodeID and FabricIndex values, and store it in the WebRTC Transport Requestor cluster's CurrentSessions attribute. The session establishment is considered failed unless a Offer command is received by the Requestor from the PeerEndpointID / FabricIndex within 30 seconds.

Command Identity

Response Fields

Command: ProvideOffer

Purpose

This command allows an SDP Offer to be set and start a new session. This command can also be used in the re-offer flow of an existing session to change the details of the SDP (e.g. to enable/disable two-way talk).

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1363,
    "command_name": "ProvideOffer",
    "payload": {
      "webRTCSessionID": 0,
      "sdp": "example"
    }
  }
}

The device answers with ProvideOfferResponse (see below).

Command: ProvideOfferResponse

Purpose

This command contains information about the session and streams created as a response to the requestor's offer. Upon receipt, the client must create a new WebRTCSessionStruct populated with the values from this command, along with the accessing Peer Node ID and Local Fabric Index entries stored in the Secure Session Context as the PeerNodeID and FabricIndex values, and store it in the WebRTC Transport Requestor cluster's CurrentSessions attribute.

Command Identity

Response Fields

Command: ProvideAnswer

Purpose

This command is initiated from a Node in response to an Offer that was previously received from a remote peer. It has the following data fields: This command must respond with a response status of NOT_FOUND if the WebRTCSessionID does not match an entry in CurrentSessions, or if the matching entry's associated fabric and PeerNodeID do not match the accessing fabric and the Peer Node ID entry stored in the Secure Session Context of the session this command was received on.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1363,
    "command_name": "ProvideAnswer",
    "payload": {
      "webRTCSessionID": 0,
      "sdp": "example"
    }
  }
}

Command: ProvideICECandidates

Purpose

ProvideICECandidates is a client-to-server command of the WebRTC Transport Provider cluster.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1363,
    "command_name": "ProvideICECandidates",
    "payload": {
      "webRTCSessionID": 0,
      "iceCandidates": []
    }
  }
}

Command: EndSession

Purpose

This command instructs the stream provider to end the WebRTC session.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1363,
    "command_name": "EndSession",
    "payload": {
      "webRTCSessionID": 0,
      "reason": 0
    }
  }
}

Cluster 1363 Events

Cluster 1363 defines no events.

SmartphoneKey Notes

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