Media1296 — Content App Observer

Matter Cluster 1296 — Content App Observer

Matter Cluster 1296 (0x0510) Content App Observer: attributes, commands, events, data types, shadow paths and bridge payload examples.

Matter Cluster 1296 — Content App Observer Cluster

Matter Cluster 1296, also written as 0x0510, is the Content App Observer Cluster. This cluster provides an interface for sending targeted commands to an Observer of a Content App on a Video Player device such as a Streaming Media Player, Smart TV or Smart Screen. The cluster server for Content App Observer is implemented by an endpoint that communicates with a Content App, such as a Casting Video Client. The cluster client for Content App Observer is implemented by a Content App endpoint.

Cluster Identity

FieldValue
Cluster ID decimal1296
Cluster ID hex0x0510
Cluster nameContent App Observer
Cluster revision (Matter 1.6.1)1
Roleapplication
ScopeEndpoint
PICS codeAPPOBSERVER
Typical endpoint1

Revision history

RevisionChange
1Initial revision

Shadow Path Format

Cluster 1296 values in the device shadow use this format:

endpoint_id / 1296 / attribute_id

Data Types

StatusEnum

ValueNameConformanceMeaning
0SuccessMCommand succeeded
1UnexpectedDataMData field in command was not understood by the Observer

Cluster 1296 Attributes

Cluster 1296 defines no cluster-specific attributes; only the global attributes are present.

Global attributes

IDHexAttributeMeaning
655280xFFF8GeneratedCommandListResponse command IDs this server generates.
655290xFFF9AcceptedCommandListCommand IDs this server accepts.
655310xFFFBAttributeListAttribute IDs implemented.
655320xFFFCFeatureMapImplemented optional features (see above).
655330xFFFDClusterRevisionCluster revision implemented; 1 for a Matter 1.6.1 device.

Cluster 1296 Commands

Cluster 1296 has 1 client-to-server command and 1 response.

IDHexCommandDirectionConformanceResponseDescription
00x00ContentAppMessageclient → serverMContentAppMessageResponseOn receipt, the data field may be parsed and interpreted.
10x01ContentAppMessageResponseserver → clientM—This command is generated in response to ContentAppMessage command.

AcceptedCommandList

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

endpoint_id / 1296 / 65529
{
  "1/1296/65529": [
    0
  ]
}

Before sending a Cluster 1296 command, check that the command ID exists in endpoint/1296/65529. Optional commands are only present when the matching feature is set in FeatureMap.


Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

On receipt, the data field may be parsed and interpreted. Message encoding is specific to the Content App. A Content App may when possible read attributes from the Basic Information Cluster on the Observer and use this to determine the Message encoding. This command returns a ContentAppMessage Response.

Command Identity

FieldValue
Command ID0
Command hex0x00
Command nameContentAppMessage
Directionclient → server
ConformanceM
ResponseContentAppMessageResponse
Access(invoke: operate)

Payload Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0DatadatastringMmax length 500Indicates content app-specific data.
1EncodingHintencodingHintstringOmax length 100This optional field indicates a content app-specific hint to the encoding of the data.

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1296,
    "command_name": "ContentAppMessage",
    "payload": {
      "data": "example"
    }
  }
}

The device answers with ContentAppMessageResponse (see below).


Command: ContentAppMessageResponse

Purpose

This command is generated in response to ContentAppMessage command.

Command Identity

FieldValue
Command ID1
Command hex0x01
Command nameContentAppMessageResponse
Directionserver → client (response)
ConformanceM

Response Fields

IDFieldPayload keyTypeConformanceConstraintMeaning
0StatusstatusStatusEnumM—Indicates the status of the command which resulted in this response.
1DatadatastringOmax length 500This optional field indicates content app-specific data.
2EncodingHintencodingHintstringOmax length 100This optional field indicates a content app-specific hint to the encoding of the data.

Status values (StatusEnum): 0 = Success, 1 = UnexpectedData


Cluster 1296 Events

Cluster 1296 defines no events.


SmartphoneKey Notes

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