protocol/ivi-application.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <protocol name="ivi_application">
   3
   4     <copyright>
   5     Copyright (C) 2013 DENSO CORPORATION
   6     Copyright (c) 2013 BMW Car IT GmbH
   7
   8     Permission is hereby granted, free of charge, to any person obtaining a copy
   9     of this software and associated documentation files (the "Software"), to deal
  10     in the Software without restriction, including without limitation the rights
  11     to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12     copies of the Software, and to permit persons to whom the Software is
  13     furnished to do so, subject to the following conditions:
  14
  15     The above copyright notice and this permission notice shall be included in
  16     all copies or substantial portions of the Software.
  17
  18     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21     AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24     THE SOFTWARE.
  25     </copyright>
  26
  27     <interface name="ivi_surface" version="1">
  28         <description summary="Tell property change of ivi_surface to application"/>
  29
  30         <request name="destroy" type="destructor">
  31             <description summary="destroy ivi_surface"/>
  32         </request>
  33
  34         <event name="visibility">
  35             <description summary="visibility of ivi_surface has changed"/>
  36             <arg name="visibility" type="int"/>
  37         </event>
  38     </interface>
  39
  40     <interface name="ivi_application" version="1">
  41         <description summary="creation of ivi_surface"/>
  42
  43         <request name="surface_create">
  44             <description summary="ilm_surfaceCreate"/>
  45             <arg name="id_surface" type="uint"/>
  46             <arg name="surface" type="object" interface="wl_surface"/>
  47             <arg name="id" type="new_id" interface="ivi_surface"/>
  48         </request>
  49
  50         <enum name="error_code">
  51             <description summary="possible error codes returned in error event"/>
  52             <entry name="unknown_error"   value="1" summary="unknown error encountered"/>
  53             <entry name="resource_in_use" value="2" summary="resource is in use and can not be shared"/>
  54         </enum>
  55
  56         <event name="error">
  57             <description summary="request resulted in server-side error"/>
  58             <arg name="error_code" type="int"/>
  59             <arg name="error_text" type="string" allow-null="true"/>
  60         </event>
  61
  62     </interface>
  63
  64 </protocol>
  65