Matter Cluster 1290 — Content Launcher Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 1290 values in the device shadow use this format:

endpoint_id / 1290 / attribute_id

Example:

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

Cluster 1290 Features

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

Data Types

MetricTypeEnum

ParameterEnum

StatusEnum

SupportedProtocolsBitmap (bitmap)

AdditionalInfoStruct (struct)

This object defines additional name=value pairs that can be used for identifying content.

BrandingInformationStruct (struct)

This object defines Branding Information which can be provided by the client in order to customize the skin of the Video Player during playback.

ContentSearchStruct (struct)

This object defines inputs to a search for content for display or playback.

DimensionStruct (struct)

This object defines dimension which can be used for defining Size of background images.

ParameterStruct (struct)

This object defines inputs to a search for content for display or playback.

PlaybackPreferencesStruct (struct)

PlaybackPreferencesStruct defines the preferences sent by the client to the receiver in the ContentLauncher LaunchURL or LaunchContent commands.

StyleInformationStruct (struct)

This object defines style information which can be used by content providers to change the Media Player's style related properties.

TrackPreferenceStruct (struct)

This structure defines Text/Audio Track preferences.

Cluster 1290 Attributes

Cluster 1290 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 — AcceptHeader

Path example:

1/1290/0

This attribute provides a list of content types supported by the Video Player or Content App in the form of entries in the HTTP "Accept" request header.

Example:

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

Attribute 1 / 0x0001 — SupportedStreamingProtocols

Path example:

1/1290/1

This attribute provides information about supported streaming protocols.

Bits (SupportedProtocolsBitmap):

Example:

{
  "1/1290/1": 0
}

Cluster 1290 Commands

Cluster 1290 has 2 client-to-server commands and 1 response.

AcceptedCommandList

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

endpoint_id / 1290 / 65529

{
  "1/1290/65529": [
    0,
    1
  ]
}

Bridge Command Payload Format

The bridge accepts Matter commands in this structure:

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

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

Purpose

On receipt, this must launch the specified content with optional search criteria. This command returns a Launch Response.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1290,
    "command_name": "LaunchContent",
    "payload": {
      "search": {
        "parameterList": []
      },
      "autoPlay": true
    }
  }
}

The device answers with LauncherResponse (see below).

Command: LaunchURL

Purpose

LaunchURL is a client-to-server command of the Content Launcher cluster.

Command Identity

Payload Fields

Bridge Command Example

{
  "message_id": "1",
  "command": "device_command",
  "args": {
    "endpoint_id": 1,
    "cluster_id": 1290,
    "command_name": "LaunchURL",
    "payload": {
      "contentURL": "example"
    }
  }
}

The device answers with LauncherResponse (see below).

Command: LauncherResponse

Purpose

This command is generated in response to LaunchContent and LaunchURL commands.

Command Identity

Response Fields

Status values (StatusEnum): 0 = Success, 1 = URLNotAvailable, 2 = AuthFailed, 3 = TextTrackNotAvailable, 4 = AudioTrackNotAvailable

Cluster 1290 Events

Cluster 1290 defines no events.

SmartphoneKey Notes

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