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

   1 <?xml version="1.0"?>
   2 <!--
   3 Copyright (c) 2021 Project CHIP Authors
   4
   5 Licensed under the Apache License, Version 2.0 (the "License");
   6 you may not use this file except in compliance with the License.
   7 You may obtain a copy of the License at
   8
   9     http://www.apache.org/licenses/LICENSE-2.0
  10
  11 Unless required by applicable law or agreed to in writing, software
  12 distributed under the License is distributed on an "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 See the License for the specific language governing permissions and
  15 limitations under the License.
  16 -->
  17 <configurator>
  18   <domain name="CHIP"/>
  19   <cluster>
  20     <domain>General</domain>
  21     <name>Content Launch</name>
  22     <code>0x050a</code>
  23     <define>CONTENT_LAUNCH_CLUSTER</define>
  24     <client init="false" tick="false">true</client>
  25     <server init="false" tick="false">true</server>
  26     <description>This cluster provides an interface for launching content on a media player device such as a TV or Speaker.</description>
  27
  28     <command source="client" code="0x00" name="LaunchContent" optional="false">
  29       <description>Upon receipt, this SHALL launch the specified content with optional search criteria.</description>
  30     </command>
  31
  32     <command source="client" code="0x01" name="LaunchURL" optional="false">
  33       <description>Upon receipt, this SHALL launch content from the specified URL.</description>
  34     </command>
  35
  36     <command source="server" code="0x00" name="LaunchContentResponse" optional="false" disableDefaultResponse="true">
  37       <description>This command SHALL be generated in response to LaunchContent command.</description>
  38       <arg name="contentLaunchStatus" type="ContentLaunchStatus"/>
  39     </command>
  40
  41     <command source="server" code="0x01" name="LaunchURLResponse" optional="false" disableDefaultResponse="true">
  42       <description>This command SHALL be generated in response to LaunchURL command.</description>
  43       <arg name="contentLaunchStatus" type="ContentLaunchStatus"/>
  44     </command>
  45
  46   </cluster>
  47
  48   <enum name="ContentLaunchStatus" type="ENUM8">
  49     <item name="Success" value="0x00"/>
  50     <item name="UrlNotAvailable" value="0x01"/>
  51     <item name="AuthFailed" value="0x02"/>
  52   </enum>
  53
  54   <struct name="ContentLaunchSearch">
  55     <item name="EntitiesList" type="INT8U"/>
  56     <item name="searchWindowStart" type="OCTET_STRING"/>
  57     <item name="searchWindowEnd" type="OCTET_STRING"/>
  58   </struct>
  59
  60   <struct name="ContentLaunchAdditionalInfo">
  61     <item name="Name" type="OCTET_STRING"/>
  62     <item name="Value" type="OCTET_STRING"/>
  63   </struct>
  64
  65   <struct name="ContentLaunchAdditionalInfo">
  66     <item name="Type" type="ContentLaunchType"/>
  67     <item name="Value" type="OCTET_STRING"/>
  68     <item name="ExternalIDList" type="INT8U"/>
  69   </struct>
  70
  71   <enum name="ContentLaunchType" type="ENUM8">
  72     <item name="Actor" value="0x00"/>
  73     <item name="Channel" value="0x01"/>
  74     <item name="Character" value="0x02"/>
  75     <item name="Event" value="0x03"/>
  76     <item name="Franchise" value="0x04"/>
  77     <item name="Genre" value="0x05"/>
  78     <item name="League" value="0x06"/>
  79     <item name="Popularity" value="0x07"/>
  80     <item name="Sport" value="0x08"/>
  81     <item name="SportsTeam" value="0x009"/>
  82     <item name="Video" value="0x0A"/>
  83   </enum>
  84 </configurator>