src/app/zap-templates/zcl/content-launch-cluster.xml

<?xml version="1.0"?>
<!--
Copyright (c) 2021 Project CHIP Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<configurator>
  <domain name="CHIP"/>
  <cluster>
    <domain>Media</domain>
    <name>Content Launcher</name>
    <code>0x050a</code>
    <define>CONTENT_LAUNCH_CLUSTER</define>
    <client init="false" tick="false">true</client>
    <server init="false" tick="false">true</server>
    <!-- TODO: Add feature map once it is supported -->
    <description>This cluster provides an interface for launching content on a media player device such as a TV or Speaker.</description>

    <attribute side="server" code="0x0000" define="CONTENT_LAUNCHER_ACCEPTS_HEADER" type="ARRAY" entryType="OCTET_STRING" length="254" writable="false" optional="false">accepts header list</attribute>
    <attribute side="server" code="0x0001" define="CONTENT_LAUNCHER_SUPPORTED_STREAMING_TYPES" type="ARRAY" entryType="ContentLaunchStreamingType" length="254" writable="false" optional="false">supported streaming types</attribute>

    <command source="client" code="0x00" name="LaunchContent" optional="false">
      <description>Upon receipt, this SHALL launch the specified content with optional search criteria.</description>
      <arg name="autoPlay" type="BOOLEAN"/>
      <arg name="data" type="CHAR_STRING"/>
      <!-- TODO: Update argument ContentSearch it is supported -->
    </command>

    <command source="client" code="0x01" name="LaunchURL" optional="false">
      <description>Upon receipt, this SHALL launch content from the specified URL.</description>
      <arg name="contentURL" type="CHAR_STRING"/>
      <arg name="displayString" type="CHAR_STRING"/>
      <!-- TODO: Update argument BrandingInformation it is supported -->
    </command>

    <command source="server" code="0x00" name="LaunchContentResponse" optional="false" disableDefaultResponse="true">
      <description>This command SHALL be generated in response to LaunchContent command.</description>
      <arg name="data" type="CHAR_STRING"/>
      <arg name="contentLaunchStatus" type="ContentLaunchStatus"/>
    </command>

    <command source="server" code="0x01" name="LaunchURLResponse" optional="false" disableDefaultResponse="true">
      <description>This command SHALL be generated in response to LaunchURL command.</description>
      <arg name="data" type="CHAR_STRING"/>
      <arg name="contentLaunchStatus" type="ContentLaunchStatus"/>
    </command>

  </cluster>

  <struct name="ContentLaunchAdditionalInfo">
    <item name="name" type="CHAR_STRING"/>
    <item name="value" type="CHAR_STRING"/>
  </struct>

  <enum name="ContentLaunchMetricType" type="ENUM8">
    <item name="PIXELS" value="0x00"/>
    <item name="PERCENTAGE" value="0x01"/>
  </enum>

  <struct name="ContentLaunchDimension">
    <!-- TODO: Convert to double once it is supported -->
    <item name="width" type="CHAR_STRING"/>
    <!-- TODO: Convert to double once it is supported -->
    <item name="height" type="CHAR_STRING"/>
    <item name="metric" type="ContentLaunchMetricType"/>
  </struct>

  <struct name="ContentLaunchStyleInformation">
    <item name="imageUrl" type="CHAR_STRING"/>
    <item name="color" type="CHAR_STRING"/>
    <!-- TODO: Convert to struct ContentLaunchDimension once is supported -->
    <item name="size" type="INT8U"/>
  </struct>

  <struct name="ContentLaunchBrandingInformation">
    <item name="providerName" type="CHAR_STRING"/>
    <!-- TODO: Convert to struct ContentLaunchStyleInformation once is supported -->
    <item name="background" type="INT8U"/>
    <!-- TODO: Convert to struct ContentLaunchStyleInformation once is supported -->
    <item name="logo" type="INT8U"/>
    <!-- TODO: Convert to struct ContentLaunchStyleInformation once is supported -->
    <item name="progressBar" type="INT8U"/>
    <!-- TODO: Convert to struct ContentLaunchStyleInformation once is supported -->
    <item name="splash" type="INT8U"/>
    <!-- TODO: Convert to struct ContentLaunchStyleInformation once is supported -->
    <item name="waterMark" type="INT8U"/>
  </struct>


  <enum name="ContentLaunchParameterEnum" type="ENUM8">
    <item name="Actor" value="0x00"/>
    <item name="Channel" value="0x01"/>
    <item name="Character" value="0x02"/>
    <item name="Event" value="0x03"/>
    <item name="Franchise" value="0x04"/>
    <item name="Genre" value="0x05"/>
    <item name="League" value="0x06"/>
    <item name="Popularity" value="0x07"/>
    <item name="Sport" value="0x08"/>
    <item name="SportsTeam" value="0x009"/>
    <item name="Video" value="0x0A"/>
  </enum>

  <enum name="ContentLaunchStreamingType" type="ENUM8">
    <item name="DASH" value="0x00"/>
    <item name="HLS" value="0x01"/>
  </enum>

  <enum name="ContentLaunchStatus" type="ENUM8">
    <item name="Success" value="0x00"/>
    <item name="UrlNotAvailable" value="0x01"/>
    <item name="AuthFailed" value="0x02"/>
  </enum>

  <struct name="ContentLaunchParamater">
    <item name="Type" type="ContentLaunchParameterEnum"/>
    <item name="Value" type="CHAR_STRING"/>
    <item name="ExternalIDList" type="ARRAY" entryType="ContentLaunchAdditionalInfo" length="254"/>
  </struct>
</configurator>