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                 This removes link from surface_id to wl_surface and destroys ivi_surface.
  33             </description>
  34         </request>
  35
  36         <event name="visibility">
  37             <description summary="visibility of surface in ivi compositor has changed">
  38                 The new visibility state is provided in argument visibility.
  39                 If visibility is 0, the surface has become invisible.
  40                 If visibility is not 0, the surface has become visible.
  41             </description>
  42             <arg name="visibility" type="int"/>
  43         </event>
  44
  45         <enum name="warning_code">
  46             <description summary="possible warning codes returned by ivi compositor">
  47                 These warning codes define all possible warning codes returned by ivi compositor
  48                 on server-side warnings.
  49                 invalid_wl_surface: invalid wl_surface is set. This happens if wl_surface is destroyed before this.
  50                 surface_id_in_use: surface_id is already assigned by another application.
  51             </description>
  52             <entry name="invalid_wl_surface" value="1" summary="wl_surface is invalid"/>
  53             <entry name="surface_id_in_use" value="2" summary="surface_id is in use and can not be shared"/>
  54         </enum>
  55
  56         <event name="warning">
  57             <description summary="server-side warning detected">
  58                 The ivi compositor encountered warning while processing a request by this
  59                 application. The warning is defined by argument warning_code and optional
  60                 warning_text. If the warning is detected, client shall destroy the ivi_surface
  61                 object.
  62
  63                 When ivi compositor encounters warnings, a request is canceled and there is no
  64                 mapping from id_surface/wl_surface to this ivi_surface. Even if there is no
  65                 mapping but destroying this ivi_surface is recommended.
  66             </description>
  67             <arg name="warning_code" type="int"/>
  68             <arg name="warning_text" type="string" allow-null="true"/>
  69         </event>
  70
  71     </interface>
  72
  73     <interface name="ivi_application" version="1">
  74         <description summary="interface for ivi applications to use ivi compositor features"/>
  75
  76         <request name="surface_create">
  77             <description summary="create ivi_surface with numeric ID in ivi compositor">
  78                 surface_create will create a interface:ivi_surface with numeric ID; surface_id in
  79                 ivi compositor. These surface_ids are defined as unique in the system to identify
  80                 it inside of ivi compositor. The ivi compositor implements business logic how to
  81                 set properties of the surface with surface_id according to status of the system.
  82                 E.g. a unique ID for Car Navigation application is used for implementing special
  83                 logic of the application about where it shall be located.
  84
  85                 Created ivi_surface notifies warnings when following situation happens,
  86                 - Invalid wl_surface is set. This happen if wl_surface is destroy before this.
  87                 - surface_id is already assigned by another application.
  88                 If a client sets a wl_surface to multiple id_surfaces, no warning is issued. Property
  89                 of the surface can be controlled by multiple ivi_surface. However this case shall
  90                 be avoided by a client.
  91             </description>
  92             <arg name="id_surface" type="uint"/>
  93             <arg name="surface" type="object" interface="wl_surface"/>
  94             <arg name="id" type="new_id" interface="ivi_surface"/>
  95         </request>
  96
  97         <event name="wl_shell_info">
  98             <arg name="pid" type="int"/>
  99             <arg name="title" type="string" allow-null="true"/>
 100         </event>
 101
 102     </interface>
 103
 104 </protocol>