[xdg-desktop-portal-gnome] data: Sync mutter screen cast API file
- From: Georges Basile Stavracas Neto <gbsneto src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [xdg-desktop-portal-gnome] data: Sync mutter screen cast API file
- Date: Wed, 10 Nov 2021 18:18:10 +0000 (UTC)
commit f17c87ae5dea6baf92a87bfe1aabcdeda5c050f1
Author: Jonas Ã…dahl <jadahl gmail com>
Date: Thu Jun 17 09:53:14 2021 +0200
data: Sync mutter screen cast API file
data/org.gnome.Mutter.ScreenCast.xml | 96 ++++++++++++++++++++++++++++++++++--
1 file changed, 93 insertions(+), 3 deletions(-)
---
diff --git a/data/org.gnome.Mutter.ScreenCast.xml b/data/org.gnome.Mutter.ScreenCast.xml
index 6134556..d9f1f44 100644
--- a/data/org.gnome.Mutter.ScreenCast.xml
+++ b/data/org.gnome.Mutter.ScreenCast.xml
@@ -22,6 +22,10 @@
Remote desktop driven screen casts
are started and stopped by the remote
desktop session.
+ * "disable-animations" (b): Set to "true" if the screen cast application
+ would prefer animations to be globally
+ disabled, while the session is running. Default
+ is "false". Available since version 3.
-->
<method name="CreateSession">
<arg name="properties" type="a{sv}" direction="in" />
@@ -71,7 +75,19 @@
Record a single monitor.
- Available @properties include: (none)
+ Available @properties include:
+
+ * "cursor-mode" (u): Cursor mode. Default: 'hidden' (see below)
+ Available since API version 2.
+ * "is-recording" (b): Whether this is a screen recording. May be
+ be used for choosing appropriate visual feedback.
+ Default: false. Available since API version 4.
+
+ Available cursor mode values:
+
+ 0: hidden - cursor is not included in the stream
+ 1: embedded - cursor is included in the framebuffer
+ 2: metadata - cursor is included as metadata in the PipeWire stream
-->
<method name="RecordMonitor">
<arg name="connector" type="s" direction="in" />
@@ -84,14 +100,88 @@
@properties: Properties used determining what window to select
@stream_path: Path to the new stream object
- Record a single window.
+ Supported since API version 2.
+
+ Record a single window. The cursor will not be included.
+
+ Available @properties include:
+
+ * "window-id" (t): Id of the window to record.
+ * "cursor-mode" (u): Cursor mode. Default: 'hidden' (see RecordMonitor).
+ * "is-recording" (b): Whether this is a screen recording. May be
+ be used for choosing panel icon.
+ Default: false. Available since API version 4.
- Available @properties include: (none)
-->
<method name="RecordWindow">
<arg name="properties" type="a{sv}" direction="in" />
<arg name="stream_path" type="o" direction="out" />
</method>
+
+ <!--
+ RecordArea:
+ @x: X position of the recorded area
+ @y: Y position of the recorded area
+ @width: width of the recorded area
+ @height: height of the recorded area
+ @properties: Properties
+ @stream_path: Path to the new stream object
+
+ Record an area of the stage. The coordinates are in stage coordinates.
+ The size of the stream does not necessarily match the size of the
+ recorded area, and will depend on DPI scale of the affected monitors.
+
+ Available @properties include:
+
+ * "cursor-mode" (u): Cursor mode. Default: 'hidden' (see below)
+ Available since API version 2.
+ * "is-recording" (b): Whether this is a screen recording. May be
+ be used for choosing panel icon.
+ Default: false. Available since API version 4.
+
+ Available cursor mode values:
+
+ 0: hidden - cursor is not included in the stream
+ 1: embedded - cursor is included in the framebuffer
+ 2: metadata - cursor is included as metadata in the PipeWire stream
+ -->
+ <method name="RecordArea">
+ <arg name="x" type="i" direction="in" />
+ <arg name="y" type="i" direction="in" />
+ <arg name="width" type="i" direction="in" />
+ <arg name="height" type="i" direction="in" />
+ <arg name="properties" type="a{sv}" direction="in" />
+ <arg name="stream_path" type="o" direction="out" />
+ </method>
+
+ <!--
+ RecordVirtual:
+ @properties: Properties
+ @stream_path: Path to the new stream object
+
+ Record a virtual area that will be represented as a virtual monitor. The
+ width and height corresponds to the non-scaled intended stream size.
+
+ Available @properties include:
+
+ * "cursor-mode" (u): Cursor mode. Default: 'hidden' (see below)
+ Available since API version 2.
+ * "is-platform" (b): Whether this virtual output should be considered
+ part of the platform, meaning it will not be
+ interpreted as if the screen is shared, but more
+ transparently as if it was a real monitor.
+ Available since API version 3. Default: FALSE.
+
+ Available cursor mode values:
+
+ 0: hidden - cursor is not included in the stream
+ 1: embedded - cursor is included in the framebuffer
+ 2: metadata - cursor is included as metadata in the PipeWire stream
+ -->
+ <method name="RecordVirtual">
+ <arg name="properties" type="a{sv}" direction="in" />
+ <arg name="stream_path" type="o" direction="out" />
+ </method>
</interface>
<!--
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]