1<?xml version="1.0" encoding="UTF-8"?>
2<protocol name="ext_transient_seat_v1">
3 <copyright>
4 Copyright © 2020 - 2023 Andri Yngvason
5
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
12
13 The above copyright notice and this permission notice (including the next
14 paragraph) shall be included in all copies or substantial portions of the
15 Software.
16
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23 DEALINGS IN THE SOFTWARE.
24 </copyright>
25
26 <description summary="protocol for creating temporary seats">
27 The transient seat protocol can be used by privileged clients to create
28 independent seats that will be removed from the compositor when the client
29 destroys its transient seat.
30
31 This protocol is intended for use with virtual input protocols such as
32 "virtual_keyboard_unstable_v1" or "wlr_virtual_pointer_unstable_v1", both
33 of which allow the user to select a seat.
34
35 The "wl_seat" global created by this protocol does not generate input events
36 on its own, or have any capabilities except those assigned to it by other
37 protocol extensions, such as the ones mentioned above.
38
39 For example, a remote desktop server can create a seat with virtual inputs
40 for each remote user by following these steps for each new connection:
41 * Create a transient seat
42 * Wait for the transient seat to be created
43 * Locate a "wl_seat" global with a matching name
44 * Create virtual inputs using the resulting "wl_seat" global
45 </description>
46
47 <interface name="ext_transient_seat_manager_v1" version="1">
48 <description summary="transient seat manager">
49 The transient seat manager creates short-lived seats.
50 </description>
51
52 <request name="create">
53 <description summary="create a transient seat">
54 Create a new seat that is removed when the client side transient seat
55 object is destroyed.
56
57 The actual seat may be removed sooner, in which case the transient seat
58 object shall become inert.
59 </description>
60 <arg name="seat" type="new_id" interface="ext_transient_seat_v1"/>
61 </request>
62
63 <request name="destroy" type="destructor">
64 <description summary="destroy the manager">
65 Destroy the manager.
66
67 All objects created by the manager will remain valid until they are
68 destroyed themselves.
69 </description>
70 </request>
71 </interface>
72
73 <interface name="ext_transient_seat_v1" version="1">
74 <description summary="transient seat handle">
75 When the transient seat handle is destroyed, the seat itself will also be
76 destroyed.
77 </description>
78
79 <event name="ready">
80 <description summary="transient seat is ready">
81 This event advertises the global name for the wl_seat to be used with
82 wl_registry_bind.
83
84 It is sent exactly once, immediately after the transient seat is created
85 and the new "wl_seat" global is advertised, if and only if the creation
86 of the transient seat was allowed.
87 </description>
88 <arg name="global_name" type="uint"/>
89 </event>
90
91 <event name="denied">
92 <description summary="transient seat creation denied">
93 The event informs the client that the compositor denied its request to
94 create a transient seat.
95
96 It is sent exactly once, immediately after the transient seat object is
97 created, if and only if the creation of the transient seat was denied.
98
99 After receiving this event, the client should destroy the object.
100 </description>
101 </event>
102
103 <request name="destroy" type="destructor">
104 <description summary="destroy transient seat">
105 When the transient seat object is destroyed by the client, the
106 associated seat created by the compositor is also destroyed.
107 </description>
108 </request>
109 </interface>
110</protocol>