34b7628c3be981301ef1d9187c4f5f13a638b544
[platform/core/uifw/wayland-extension.git] / protocol / tizen / tizen-launch.xml
1 <protocol name="tizen_launch">
2   <interface name="tizen_launch_effect" version="1">
3     <request name="create_splash_img">
4       <arg name="id" type="new_id" interface="tizen_launch_splash" summary="new tizen_launch_splash object"/>
5     </request>
6
7     <request name="type_set">
8       <arg name="effect_type" type="string" allow-null="true"/>
9       <arg name="pid" type="uint" />
10       <arg name="options" type="array" allow-null="true" summary="array of options"/>
11     </request>
12
13     <request name="type_unset">
14       <arg name="pid" type="uint" />
15     </request>
16
17     <request name="destroy" type="destructor">
18       <description summary="destroy tizen_launch_effect">
19         Destroy tizen_launch_effect.
20       </description>
21     </request>
22   </interface>
23
24   <interface name="tizen_launch_splash" version="1">
25     <!-- launch img -->
26     <enum name="file_type">
27       <entry name="img" value="0" summary="splash image file path"/>
28       <entry name="edj" value="1" summary="splash edj file path"/>
29     </enum>
30
31     <enum name="indicator">
32       <entry name="off" value="0" summary="splash hide indicator"/>
33       <entry name="on" value="1" summary="splash show indicator"/>
34     </enum>
35
36     <enum name="rotation">
37       <entry name="0" value="0" summary="rotation angle 0 degree"/>
38       <entry name="90" value="90" summary="rotation angle 90 degree"/>
39       <entry name="180" value="180" summary="rotation angle 180 degree"/>
40       <entry name="270" value="270" summary="rotation angle 270 degree"/>
41     </enum>
42
43     <request name="destroy" type="destructor"/>
44
45     <request name="launch">
46       <arg name="file" type="string"/>
47       <arg name="file_type" type="uint" />
48       <arg name="color_depth" type="uint" />
49       <arg name="rotation" type="uint" />
50       <arg name="indicator" type="uint" />
51       <arg name="effect_type" type="string" allow-null="true"/>
52       <arg name="theme_type" type="string" allow-null="true"/>
53       <arg name="options" type="array" allow-null="true" summary="array of options"/>
54     </request>
55
56     <request name="owner">
57       <arg name="pid" type="uint" />
58     </request>
59
60     <request name="launch_v2">
61       <arg name="file" type="string"/>
62       <arg name="file_type" type="uint" />
63       <arg name="color_depth" type="uint" />
64       <arg name="rotation" type="uint" />
65       <arg name="indicator" type="uint" />
66       <arg name="effect_type" type="string" allow-null="true"/>
67       <arg name="theme_type" type="string" allow-null="true"/>
68       <arg name="options" type="array" allow-null="true" summary="bundle data array to be delivered to interceptor"/>
69       <arg name="extra_config" type="array" allow-null="true" summary="additional config value string"/>
70     </request>
71   </interface>
72
73   <interface name="tizen_launch_appinfo" version="1">
74     <description summary="application information">
75       This interface allow to set the information of the application.
76     </description>
77
78     <request name="destroy" type="destructor">
79       <description summary="destroy tizen_launch_appinfo">
80         Destroy tizen_launch_appinfo.
81       </description>
82     </request>
83
84     <request name="register_pid">
85       <description summary="Register the pid of the application">
86         Request the registration of the pid to the server.
87       </description>
88       <arg name="pid" type="uint" />
89     </request>
90
91     <request name="deregister_pid">
92       <description summary="Deregister the pid of the application">
93         Request the deregistration of the pid to the server
94       </description>
95       <arg name="pid" type="uint" />
96     </request>
97
98     <request name="set_appid">
99       <description summary="Set the appid">
100         Set the appid associated with the pid.
101       </description>
102       <arg name="pid" type="uint" />
103       <arg name="appid" type="string" />
104     </request>
105
106     <request name="get_base_output_resolution">
107       <description summary="Get the base_output_resolution">
108         Request to get the base_output_resolution associated with the pid.
109        </description>
110       <arg name="pid" type="uint" />
111     </request>
112
113     <event name="base_output_resolution_done">
114       <description summary="Get the base_output_resolution">
115         Get the base_output_resolution of the pid.
116         The client can use the base_output_resolution as the resolution of the display outputs.
117       </description>
118       <arg name="pid" type="uint" />
119       <arg name="width" type="uint" />
120       <arg name="height" type="uint" />
121     </event>
122
123     <request name="register_appid">
124       <description summary="registers appid">
125         registers appid. Display server start to manage appinfo instance
126         based on not pid but appid with this request.
127       </description>
128       <arg name="appid" type="string" />
129     </request>
130
131     <request name="deregister_appid">
132       <description summary="deregisters appid">
133         deregister appid.
134       </description>
135       <arg name="appid" type="string" />
136     </request>
137
138     <request name="set_pid">
139       <description summary="set pid">
140         notifies pid corresponding appid.
141       </description>
142       <arg name="appid" type="string" />
143       <arg name="pid" type="uint" />
144     </request>
145
146     <request name="ready_metadata">
147       <description summary="notifies ready of metadata">
148          notifies ready of metadata. Display server can take valid metadata of
149          app matching "pid" and "appid" which delivered ad arguments, after
150          receiving this request.
151       </description>
152       <arg name="appid" type="string" />
153       <arg name="pid" type="uint" />
154     </request>
155
156   </interface>
157 </protocol>