</arg>
</method>
</interface>
+
+ <!--
+ org.qemu.Display1.Clipboard:
+
+ This interface must be implemented by both the client and the server on
+ ``/org/qemu/Display1/Clipboard`` to support clipboard sharing between
+ the client and the guest.
+
+ Once :dbus:meth:`Register`'ed, method calls may be sent and received in both
+ directions. Unregistered callers will get error replies.
+
+ .. _dbus-clipboard-selection:
+
+ **Selection values**::
+
+ Clipboard = 0
+ Primary = 1
+ Secondary = 2
+
+ .. _dbus-clipboard-serial:
+
+ **Serial counter**
+
+ To solve potential clipboard races, clipboard grabs have an associated
+ serial counter. It is set to 0 on registration, and incremented by 1 for
+ each grab. The peer with the highest serial is the clipboard grab owner.
+
+ When a grab with a lower serial is received, it should be discarded.
+
+ When a grab is attempted with the same serial number as the current grab,
+ the one coming from the client should have higher priority, and the client
+ should gain clipboard grab ownership.
+ -->
+ <interface name="org.qemu.Display1.Clipboard">
+ <!--
+ Register:
+
+ Register a clipboard session and reinitialize the serial counter.
+
+ The client must register itself, and is granted an exclusive
+ access for handling the clipboard.
+
+ The server can reinitialize the session as well (to reset the counter).
+ -->
+ <method name="Register"/>
+
+ <!--
+ Unregister:
+
+ Unregister the clipboard session.
+ -->
+ <method name="Unregister"/>
+ <!--
+ Grab:
+ @selection: a :ref:`selection value<dbus-clipboard-selection>`.
+ @serial: the current grab :ref:`serial<dbus-clipboard-serial>`.
+ @mimes: the list of available content MIME types.
+
+ Grab the clipboard, claiming current clipboard content.
+ -->
+ <method name="Grab">
+ <arg type="u" name="selection"/>
+ <arg type="u" name="serial"/>
+ <arg type="as" name="mimes"/>
+ </method>
+
+ <!--
+ Release:
+ @selection: a :ref:`selection value<dbus-clipboard-selection>`.
+
+ Release the clipboard (does nothing if not the current owner).
+ -->
+ <method name="Release">
+ <arg type="u" name="selection"/>
+ </method>
+
+ <!--
+ Request:
+ @selection: a :ref:`selection value<dbus-clipboard-selection>`
+ @mimes: requested MIME types (by order of preference).
+ @reply_mime: the returned data MIME type.
+ @data: the clipboard data.
+
+ Request the clipboard content.
+
+ Return an error if the clipboard is empty, or the requested MIME types
+ are unavailable.
+ -->
+ <method name="Request">
+ <arg type="u" name="selection"/>
+ <arg type="as" name="mimes"/>
+ <arg type="s" name="reply_mime" direction="out"/>
+ <arg type="ay" name="data" direction="out">
+ <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
+ </arg>
+ </method>
+ </interface>
+
+ <!--
+ org.qemu.Display1.Audio:
+
+ Audio backend may be available on ``/org/qemu/Display1/Audio``.
+ -->
+ <interface name="org.qemu.Display1.Audio">
+ <!--
+ RegisterOutListener:
+ @listener: a Unix socket FD, for peer-to-peer D-Bus communication.
+
+ Register an audio backend playback handler.
+
+ Multiple listeners may be registered simultaneously.
+
+ The listener is expected to implement the
+ :dbus:iface:`org.qemu.Display1.AudioOutListener` interface.
+ -->
+ <method name="RegisterOutListener">
+ <arg type="h" name="listener" direction="in"/>
+ </method>
+
+ <!--
+ RegisterInListener:
+ @listener: a Unix socket FD, for peer-to-peer D-Bus communication.
+
+ Register an audio backend record handler.
+
+ Multiple listeners may be registered simultaneously.
+
+ The listener is expected to implement the
+ :dbus:iface:`org.qemu.Display1.AudioInListener` interface.
+ -->
+ <method name="RegisterInListener">
+ <arg type="h" name="listener" direction="in"/>
+ </method>
+ </interface>
+
+ <!--
+ org.qemu.Display1.AudioOutListener:
+
+ This client-side interface must be available on
+ ``/org/qemu/Display1/AudioOutListener`` when registering the peer-to-peer
+ connection with :dbus:meth:`~org.qemu.Display1.Audio.RegisterOutListener`.
+ -->
+ <interface name="org.qemu.Display1.AudioOutListener">
+ <!--
+ Init:
+ @id: the stream ID.
+ @bits: PCM bits per sample.
+ @is_signed: whether the PCM data is signed.
+ @is_float: PCM floating point format.
+ @freq: the PCM frequency in Hz.
+ @nchannels: the number of channels.
+ @bytes_per_frame: the bytes per frame.
+ @bytes_per_second: the bytes per second.
+ @be: whether using big-endian format.
+
+ Initializes a PCM playback stream.
+ -->
+ <method name="Init">
+ <arg name="id" type="t" direction="in"/>
+ <arg name="bits" type="y" direction="in"/>
+ <arg name="is_signed" type="b" direction="in"/>
+ <arg name="is_float" type="b" direction="in"/>
+ <arg name="freq" type="u" direction="in"/>
+ <arg name="nchannels" type="y" direction="in"/>
+ <arg name="bytes_per_frame" type="u" direction="in"/>
+ <arg name="bytes_per_second" type="u" direction="in"/>
+ <arg name="be" type="b" direction="in"/>
+ </method>
+
+ <!--
+ Fini:
+ @id: the stream ID.
+
+ Finish & close a playback stream.
+ -->
+ <method name="Fini">
+ <arg name="id" type="t" direction="in"/>
+ </method>
+
+ <!--
+ SetEnabled:
+ @id: the stream ID.
+
+ Resume or suspend the playback stream.
+ -->
+ <method name="SetEnabled">
+ <arg name="id" type="t" direction="in"/>
+ <arg name="enabled" type="b" direction="in"/>
+ </method>
+
+ <!--
+ SetVolume:
+ @id: the stream ID.
+ @mute: whether the stream is muted.
+ @volume: the volume per-channel.
+
+ Set the stream volume and mute state (volume without unit, 0-255).
+ -->
+ <method name="SetVolume">
+ <arg name="id" type="t" direction="in"/>
+ <arg name="mute" type="b" direction="in"/>
+ <arg name="volume" type="ay" direction="in">
+ <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
+ </arg>
+ </method>
+
+ <!--
+ Write:
+ @id: the stream ID.
+ @data: the PCM data.
+
+ PCM stream to play.
+ -->
+ <method name="Write">
+ <arg name="id" type="t" direction="in"/>
+ <arg type="ay" name="data" direction="in">
+ <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
+ </arg>
+ </method>
+ </interface>
+
+ <!--
+ org.qemu.Display1.AudioInListener:
+
+ This client-side interface must be available on
+ ``/org/qemu/Display1/AudioInListener`` when registering the peer-to-peer
+ connection with :dbus:meth:`~org.qemu.Display1.Audio.RegisterInListener`.
+ -->
+ <interface name="org.qemu.Display1.AudioInListener">
+ <!--
+ Init:
+ @id: the stream ID.
+ @bits: PCM bits per sample.
+ @is_signed: whether the PCM data is signed.
+ @is_float: PCM floating point format.
+ @freq: the PCM frequency in Hz.
+ @nchannels: the number of channels.
+ @bytes_per_frame: the bytes per frame.
+ @bytes_per_second: the bytes per second.
+ @be: whether using big-endian format.
+
+ Initializes a PCM record stream.
+ -->
+ <method name="Init">
+ <arg name="id" type="t" direction="in"/>
+ <arg name="bits" type="y" direction="in"/>
+ <arg name="is_signed" type="b" direction="in"/>
+ <arg name="is_float" type="b" direction="in"/>
+ <arg name="freq" type="u" direction="in"/>
+ <arg name="nchannels" type="y" direction="in"/>
+ <arg name="bytes_per_frame" type="u" direction="in"/>
+ <arg name="bytes_per_second" type="u" direction="in"/>
+ <arg name="be" type="b" direction="in"/>
+ </method>
+
+ <!--
+ Fini:
+ @id: the stream ID.
+
+ Finish & close a record stream.
+ -->
+ <method name="Fini">
+ <arg name="id" type="t" direction="in"/>
+ </method>
+
+ <!--
+ SetEnabled:
+ @id: the stream ID.
+
+ Resume or suspend the record stream.
+ -->
+ <method name="SetEnabled">
+ <arg name="id" type="t" direction="in"/>
+ <arg name="enabled" type="b" direction="in"/>
+ </method>
+
+ <!--
+ SetVolume:
+ @id: the stream ID.
+ @mute: whether the stream is muted.
+ @volume: the volume per-channel.
+
+ Set the stream volume and mute state (volume without unit, 0-255).
+ -->
+ <method name="SetVolume">
+ <arg name="id" type="t" direction="in"/>
+ <arg name="mute" type="b" direction="in"/>
+ <arg name="volume" type="ay" direction="in">
+ <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
+ </arg>
+ </method>
+
+ <!--
+ Read:
+ @id: the stream ID.
+ @size: the amount to read, in bytes.
+ @data: the recorded data (which may be less than requested).
+
+ Read "size" bytes from the record stream.
+ -->
+ <method name="Read">
+ <arg name="id" type="t" direction="in"/>
+ <arg name="size" type="t" direction="in"/>
+ <arg type="ay" name="data" direction="out">
+ <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
+ </arg>
+ </method>
+ </interface>
+
+ <!--
+ org.qemu.Display1.Chardev:
+
+ Character devices may be available on ``/org/qemu/Display1/Chardev_$id``.
+
+ They may be used for different kind of streams, which are identified via
+ their FQDN :dbus:prop:`Name`.
+
+ .. _dbus-chardev-fqdn:
+
+ Here are some known reserved kind names (the ``org.qemu`` prefix is
+ reserved by QEMU):
+
+ org.qemu.console.serial.0
+ A serial console stream.
+
+ org.qemu.monitor.hmp.0
+ A QEMU HMP human monitor.
+
+ org.qemu.monitor.qmp.0
+ A QEMU QMP monitor.
+
+ org.qemu.usbredir
+ A usbredir stream.
+ -->
+ <interface name="org.qemu.Display1.Chardev">
+ <!--
+ Register:
+ @stream: a Unix FD to redirect the stream to.
+
+ Register a file-descriptor for the stream handling.
+
+ The current handler, if any, will be replaced.
+ -->
+ <method name="Register">
+ <arg type="h" name="stream" direction="in"/>
+ </method>
+
+ <!--
+ SendBreak:
+
+ Send a break event to the character device.
+ -->
+ <method name="SendBreak"/>
+
+ <!--
+ Name:
+
+ The FQDN name to identify the kind of stream. See :ref:`reserved
+ names<dbus-chardev-fqdn>`.
+ -->
+ <property name="Name" type="s" access="read"/>
+
+ <!--
+ FEOpened:
+
+ Whether the front-end side is opened.
+ -->
+ <property name="FEOpened" type="b" access="read"/>
+
+ <!--
+ Echo:
+
+ Whether the input should be echo'ed (for serial streams).
+ -->
+ <property name="Echo" type="b" access="read"/>
+
+ <!--
+ Owner:
+
+ The D-Bus unique name of the registered handler.
+ -->
+ <property name="Owner" type="s" access="read"/>
+ </interface>
</node>
projects / mirror_qemu.git / blobdiff