src/app/zap-templates/zcl/audio-output-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>Audio Output</name>
  22     <code>0x050b</code>
  23     <define>AUDIO_OUTPUT_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 controlling the Output on a media device such as a TV.</description>
  27     <attribute side="server" code="0x0000" define="AUDIO_OUTPUT_LIST" type="OCTET_STRING" length="32" writable="false" optional="false">audio output list</attribute>
  28     <attribute side="server" code="0x0001" define="AUDIO_OUTPUT_CURRENT_OUTPUT" type="INT8U" min="0x00" max="0xFF" writable="false" default="0x00" optional="true">current audio output</attribute>
  29
  30     <command source="client" code="0x00" name="SelectOutput" optional="false">
  31       <description>Upon receipt, this SHALL change the output on the media device to the output at a specific index in the Output List.</description>
  32       <arg name="index" type="INT8U"/>
  33     </command>
  34
  35     <command source="client" code="0x01" name="RenameOutput" optional="false">
  36       <description>Upon receipt, this SHALL rename the output at a specific index in the Output List. Updates to the output name SHALL appear in the TV settings menus.</description>
  37       <arg name="index" type="INT8U"/>
  38       <arg name="name" type="CHAR_STRING"/>
  39     </command>
  40
  41   </cluster>
  42
  43   <struct name="AudioOutputInfo">
  44     <item name="Index" type="INT8U"/>
  45     <item name="OutputType" type="AudioOutputType"/>
  46     <item name="Name" type="CHAR_STRING"/>
  47   </struct>
  48
  49   <enum name="AudioOutputType" type="ENUM8">
  50     <item name="Hdmi" value="0x00"/>
  51     <item name="Bt" value="0x01"/>
  52     <item name="Optical" value="0x02"/>
  53     <item name="Headphone" value="0x03"/>
  54     <item name="Internal" value="0x04"/>
  55     <item name="Other" value="0x05"/>
  56   </enum>
  57
  58 </configurator>