mirror of
https://invent.kde.org/network/krfb
synced 2024-07-08 12:05:49 +00:00
c05707884c
Summary: Adds a new framebuffer implementation, which uses xdg-desktop-portal to support remote desktop on Wayland and uses PipeWire to deliver the screen content. So far only mouse support is implemented, because keyboard support is missing on KWin side. Reviewers: Kanedias, romangg Reviewed By: Kanedias Subscribers: asturmlechner, pino, ngraham, romangg Differential Revision: https://phabricator.kde.org/D20402
375 lines
17 KiB
XML
375 lines
17 KiB
XML
<?xml version="1.0"?>
|
|
<!--
|
|
Copyright (C) 2017-2018 Red Hat, Inc.
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|
-->
|
|
|
|
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
|
|
<!--
|
|
org.freedesktop.portal.RemoteDesktop:
|
|
@short_description: Remote desktop portal
|
|
The Remote desktop portal allows to create remote desktop sessions.
|
|
This documentation describes version 1 of this interface.
|
|
-->
|
|
<interface name="org.freedesktop.portal.RemoteDesktop">
|
|
<!--
|
|
CreateSession:
|
|
@options: Vardict with optional further information
|
|
@handle: Object path for the #org.freedesktop.portal.Request object representing this call
|
|
Create a remote desktop session.
|
|
A remote desktop session is used to allow remote controlling a desktop
|
|
session. It can also be used together with a screen cast session (see
|
|
org.freedesktop.portal.ScreenCast), but may only be started and stopped
|
|
with this interface.
|
|
To also get a screen content, call the
|
|
#org.freedesktop.ScreenCast.SelectSources with the
|
|
#org.freedesktop.Session object created with this method.
|
|
Supported keys in the @options vardict include:
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>handle_token s</term>
|
|
<listitem><para>
|
|
A string that will be used as the last element of the @handle. Must be a valid
|
|
object path element. See the #org.freedesktop.portal.Request documentation for
|
|
more information about the @handle.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>session_handle_token s</term>
|
|
<listitem><para>
|
|
A string that will be used as the last element of the session handle. Must be a valid
|
|
object path element. See the #org.freedesktop.portal.Session documentation for
|
|
more information about the session handle.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
The following results get returned via the #org.freedesktop.portal.Request::Response signal:
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>session_handle o</term>
|
|
<listitem><para>
|
|
The session handle. An object path for the
|
|
#org.freedesktop.portal.Session object representing the created
|
|
session.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
-->
|
|
<method name="CreateSession">
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
|
|
<arg type="o" name="handle" direction="out"/>
|
|
</method>
|
|
<!--
|
|
SelectDevices:
|
|
@session_handle: Object path for the #org.freedesktop.portal.Session object
|
|
@options: Vardict with optional further information
|
|
@handle: Object path for the #org.freedesktop.portal.Request object representing this call
|
|
Select input devices to remote control.
|
|
Supported keys in the @options vardict include:
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>handle_token s</term>
|
|
<listitem><para>
|
|
A string that will be used as the last element of the @handle. Must be a valid
|
|
object path element. See the #org.freedesktop.portal.Request documentation for
|
|
more information about the @handle.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>type u</term>
|
|
<listitem><para>
|
|
Bitmask of what device types to request remote controlling of.
|
|
Default is all.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
For available source types, see the AvailableDeviceTypes property.
|
|
-->
|
|
<method name="SelectDevices">
|
|
<arg type="o" name="session_handle" direction="in"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
|
|
<arg type="o" name="handle" direction="out"/>
|
|
</method>
|
|
<!--
|
|
Start:
|
|
@session_handle: Object path for the #org.freedesktop.portal.Session object
|
|
@parent_window: Identifier for the application window, see <link linkend="parent_window">Common Conventions</link>
|
|
@options: Vardict with optional further information
|
|
@handle: Object path for the #org.freedesktop.portal.Request object representing this call
|
|
Start the remote desktop session. This will typically result in the portal
|
|
presenting a dialog letting the user select what to share, including
|
|
devices and optionally screen content if screen cast sources was
|
|
selected.
|
|
Supported keys in the @options vardict include:
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>handle_token s</term>
|
|
<listitem><para>
|
|
A string that will be used as the last element of the @handle. Must be a valid
|
|
object path element. See the #org.freedesktop.portal.Request documentation for
|
|
more information about the @handle.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
The following results get returned via the
|
|
#org.freedesktop.portal.Request::Response signal:
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>devices u</term>
|
|
<listitem><para>
|
|
A bitmask of the devices selected by the user.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
If a screen cast source was selected, the results of the
|
|
#org.freedesktop.portal.ScreenCast.Start response signal may be
|
|
included.
|
|
-->
|
|
<method name="Start">
|
|
<arg type="o" name="session_handle" direction="in"/>
|
|
<arg type="s" name="parent_window" direction="in"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In2" value="QVariantMap"/>
|
|
<arg type="o" name="handle" direction="out"/>
|
|
</method>
|
|
<!--
|
|
NotifyPointerMotion:
|
|
@session_handle: Object path for the #org.freedesktop.portal.Session object
|
|
@options: Vardict with optional further information
|
|
@dx: Relative movement on the x axis
|
|
@dy: Relative movement on the y axis
|
|
Notify about a new relative pointer motion event. The (dx, dy) vector
|
|
represents the new pointer position in the streams logical coordinate
|
|
space.
|
|
-->
|
|
<method name="NotifyPointerMotion">
|
|
<arg type="o" name="session_handle" direction="in"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
|
|
<arg type="d" name="dx" direction="in"/>
|
|
<arg type="d" name="dy" direction="in"/>
|
|
</method>
|
|
<!--
|
|
NotifyPointerMotionAbsolute:
|
|
@session_handle: Object path for the #org.freedesktop.portal.Session object
|
|
@options: Vardict with optional further information
|
|
@stream: The PipeWire stream node the coordinate is relative to
|
|
@x: Pointer motion x coordinate
|
|
@y: Pointer motion y coordinate
|
|
Notify about a new absolute pointer motion event. The (x, y) position
|
|
represents the new pointer position in the streams logical coordinate
|
|
space (see the logical_size stream property in
|
|
#org.freedesktop.portal.ScreenCast).
|
|
-->
|
|
<method name="NotifyPointerMotionAbsolute">
|
|
<arg type="o" name="session_handle" direction="in"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
|
|
<arg type="u" name="stream" direction="in"/>
|
|
<arg type="d" name="x" direction="in"/>
|
|
<arg type="d" name="y" direction="in"/>
|
|
</method>
|
|
<!--
|
|
NotifyPointerButton:
|
|
@session_handle: Object path for the #org.freedesktop.portal.Session object
|
|
@options: Vardict with optional further information
|
|
@button: The pointer button was pressed or released
|
|
@state: The new state of the button
|
|
The pointer button is encoded according to Linux Evdev button codes.
|
|
May only be called if POINTER access was provided after starting the
|
|
session.
|
|
Available button states:
|
|
<simplelist>
|
|
<member>0: Released</member>
|
|
<member>1: Pressed</member>
|
|
</simplelist>
|
|
-->
|
|
<method name="NotifyPointerButton">
|
|
<arg type="o" name="session_handle" direction="in"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
|
|
<arg type="i" name="button" direction="in"/>
|
|
<arg type="u" name="state" direction="in"/>
|
|
</method>
|
|
<!--
|
|
NotifyPointerAxis:
|
|
@session_handle: Object path for the #org.freedesktop.portal.Session object
|
|
@options: Vardict with optional further information
|
|
@dx: Relative axis movement on the x axis
|
|
@dy: Relative axis movement on the y axis
|
|
The axis movement from a 'smooth scroll' device, such as a touchpad.
|
|
When applicable, the size of the motion delta should be equivalent to
|
|
the motion vector of a pointer motion done using the same advice.
|
|
May only be called if POINTER access was provided after starting the
|
|
session.
|
|
Supported keys in the @options vardict include:
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>finish b</term>
|
|
<listitem><para>
|
|
If set to true, this is the last axis event in a series, for
|
|
example as a result of the fingers being lifted from a touchpad
|
|
after a two-finger scroll. Default is false.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
-->
|
|
<method name="NotifyPointerAxis">
|
|
<arg type="o" name="session_handle" direction="in"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
|
|
<arg type="d" name="dx" direction="in"/>
|
|
<arg type="d" name="dy" direction="in"/>
|
|
</method>
|
|
<!--
|
|
NotifyPointerAxisDiscrete:
|
|
@session_handle: Object path for the #org.freedesktop.portal.Session object
|
|
@options: Vardict with optional further information
|
|
@axis: The axis that was scrolled
|
|
@steps: The number of steps scrolled
|
|
May only be called if POINTER access was provided after starting the
|
|
session.
|
|
Available axes:
|
|
<simplelist>
|
|
<member>0: Vertical scroll</member>
|
|
<member>1: Horizontal scroll</member>
|
|
</simplelist>
|
|
-->
|
|
<method name="NotifyPointerAxisDiscrete">
|
|
<arg type="o" name="session_handle" direction="in"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
|
|
<arg type="u" name="axis" direction="in"/>
|
|
<arg type="i" name="steps" direction="in"/>
|
|
</method>
|
|
<!--
|
|
NotifyKeyboardKeycode:
|
|
@session_handle: Object path for the #org.freedesktop.portal.Session object
|
|
@options: Vardict with optional further information
|
|
@keycode: Keyboard code that was pressed or released
|
|
@state: New state of keyboard keysym
|
|
May only be called if KEYBOARD access was provided after starting the
|
|
session.
|
|
Available keyboard keysym states:
|
|
<simplelist>
|
|
<member>0: Released</member>
|
|
<member>1: Pressed</member>
|
|
</simplelist>
|
|
-->
|
|
<method name="NotifyKeyboardKeycode">
|
|
<arg type="o" name="session_handle" direction="in"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
|
|
<arg type="i" name="keycode" direction="in"/>
|
|
<arg type="u" name="state" direction="in"/>
|
|
</method>
|
|
<!--
|
|
NotifyKeyboardKeysym:
|
|
@session_handle: Object path for the #org.freedesktop.portal.Session object
|
|
@options: Vardict with optional further information
|
|
@keysym: Keyboard symbol that was pressed or released
|
|
@state: New state of keyboard keysym
|
|
May only be called if KEYBOARD access was provided after starting the
|
|
session.
|
|
Available keyboard keysym states:
|
|
<simplelist>
|
|
<member>0: Released</member>
|
|
<member>1: Pressed</member>
|
|
</simplelist>
|
|
-->
|
|
<method name="NotifyKeyboardKeysym">
|
|
<arg type="o" name="session_handle" direction="in"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
|
|
<arg type="i" name="keysym" direction="in"/>
|
|
<arg type="u" name="state" direction="in"/>
|
|
</method>
|
|
<!--
|
|
NotifyTouchDown:
|
|
@session_handle: Object path for the #org.freedesktop.portal.Session object
|
|
@options: Vardict with optional further information
|
|
@stream: The PipeWire stream node the coordinate is relative to
|
|
@slot: Touch slot where touch point appeared
|
|
@x: Touch down x coordinate
|
|
@y: Touch down y coordinate
|
|
May only be called if TOUCHSCREEN access was provided after starting the
|
|
session.
|
|
Notify about a new touch down event. The (x, y) position
|
|
represents the new touch point position in the streams logical
|
|
coordinate space (see the logical_size stream property in
|
|
#org.freedesktop.portal.ScreenCast).
|
|
-->
|
|
<method name="NotifyTouchDown">
|
|
<arg type="o" name="session_handle" direction="in"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
|
|
<arg type="u" name="stream" direction="in"/>
|
|
<arg type="u" name="slot" direction="in"/>
|
|
<arg type="d" name="x" direction="in"/>
|
|
<arg type="d" name="y" direction="in"/>
|
|
</method>
|
|
<!--
|
|
NotifyTouchMotion:
|
|
@session_handle: Object path for the #org.freedesktop.portal.Session object
|
|
@options: Vardict with optional further information
|
|
@stream: The PipeWire stream node the coordinate is relative to
|
|
@slot: Touch slot where touch point appeared
|
|
@x: Touch motion x coordinate
|
|
@y: Touch motion y coordinate
|
|
May only be called if TOUCHSCREEN access was provided after starting the
|
|
session.
|
|
Notify about a new touch motion event. The (x, y) position
|
|
represents where the touch point position in the streams logical
|
|
coordinate space moved (see the logical_size stream property in
|
|
#org.freedesktop.portal.ScreenCast).
|
|
-->
|
|
<method name="NotifyTouchMotion">
|
|
<arg type="o" name="session_handle" direction="in"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
|
|
<arg type="u" name="stream" direction="in"/>
|
|
<arg type="u" name="slot" direction="in"/>
|
|
<arg type="d" name="x" direction="in"/>
|
|
<arg type="d" name="y" direction="in"/>
|
|
</method>
|
|
<!--
|
|
NotifyTouchUp:
|
|
@session_handle: Object path for the #org.freedesktop.portal.Session object
|
|
@options: Vardict with optional further information
|
|
@slot: Touch slot where touch point appeared
|
|
May only be called if TOUCHSCREEN access was provided after starting the
|
|
session.
|
|
Notify about a new touch up event.
|
|
-->
|
|
<method name="NotifyTouchUp">
|
|
<arg type="o" name="session_handle" direction="in"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
|
|
<arg type="u" name="slot" direction="in"/>
|
|
</method>
|
|
<!--
|
|
AvailableDeviceTypes:
|
|
A bitmask of available source types. Currently defined types are:
|
|
<simplelist>
|
|
<member>1: KEYBOARD</member>
|
|
<member>2: POINTER</member>
|
|
<member>4: TOUCHSCREEN</member>
|
|
</simplelist>
|
|
-->
|
|
<property name="AvailableDeviceTypes" type="u" access="read"/>
|
|
<property name="version" type="u" access="read"/>
|
|
</interface>
|
|
</node>
|