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="application interface to surface in ivi compositor"/>
  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 surface in ivi compositor has changed">
  36                 The new visibility state is provided in argument visibility.
  37                 If visibility is 0, the surface has become invisible.
  38                 If visibility is not 0, the surface has become visible.
  39             </description>
  40             <arg name="visibility" type="int"/>
  41         </event>
  42
  43     </interface>
  44
  45     <interface name="ivi_application" version="1">
  46         <description summary="interface for ivi applications to use ivi compositor features"/>
  47
  48         <request name="surface_create">
  49             <description summary="create surface in ivi compositor">
  50                 surface_create will create a new surface with surface_id in ivi compositor,
  51                 if it does not yet exists. If the surface with surface_id already exists in
  52                 ivi compositor, the application content provided in argument surface will
  53                 be used as surface content. If an other ivi application already registered
  54                 content for surface with surface_id, an error event will indicate the problem.
  55             </description>
  56             <arg name="id_surface" type="uint"/>
  57             <arg name="surface" type="object" interface="wl_surface"/>
  58             <arg name="id" type="new_id" interface="ivi_surface"/>
  59         </request>
  60
  61         <enum name="error_code">
  62             <description summary="possible error codes returned by ivi compositor">
  63                 These error codes define all possible error codes returned by ivi compositor
  64                 on server-side errors.
  65             </description>
  66             <entry name="unknown_error"   value="1" summary="unknown error encountered"/>
  67             <entry name="resource_in_use" value="2" summary="resource is in use and can not be shared"/>
  68         </enum>
  69
  70         <event name="error">
  71             <description summary="server-side error detected">
  72                 The ivi compositor encountered error while processing a request by this
  73                 application. The error is defined by argument error_code and optional
  74                 error_text.
  75                 If the application requires to associate this error event to a request,
  76                 it can
  77                     1. send request
  78                     2. force display roundtrip
  79                     3. check, if error event was received
  80                  but this restricts the application to have only one open request at a time.
  81             </description>
  82             <arg name="error_code" type="int"/>
  83             <arg name="error_text" type="string" allow-null="true"/>
  84         </event>
  85
  86         <event name="wl_shell_info">
  87             <arg name="pid" type="int"/>
  88             <arg name="title" type="string" allow-null="true"/>
  89         </event>
  90
  91     </interface>
  92
  93 </protocol>