screencast: Unify codestyle in API
The code style in the screencast API is currently a mess. While, the overall code style in mutter and gnome-remote-desktop is to use spaces as tabulator, the remote-desktop API is mixed with both spaces as tabulators and actual tabulators. In addition to that, the code style in the XDG desktop portal APIs uses spaces as tabulators as well. To unify the code style, replace all actual tabulators with spaces. Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/2255>
This commit is contained in:
Pascal Nowack
Marge Bot
parent
6bd72264a7
commit
cff95d4932
1 changed files with 95 additions and 94 deletions
|
|
@ -14,18 +14,19 @@
|
||||||
<interface name="org.gnome.Mutter.ScreenCast">
|
<interface name="org.gnome.Mutter.ScreenCast">
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
CreateSession:
|
CreateSession:
|
||||||
@properties: Properties
|
@properties: Properties
|
||||||
@session_path: Path to the new session object
|
@session_path: Path to the new session object
|
||||||
|
|
||||||
* "remote-desktop-session-id" (s): The ID of a remote desktop session.
|
* "remote-desktop-session-id" (s): The ID of a remote desktop session.
|
||||||
Remote desktop driven screen casts
|
Remote desktop driven screen casts
|
||||||
are started and stopped by the remote
|
are started and stopped by the remote
|
||||||
desktop session.
|
desktop session.
|
||||||
* "disable-animations" (b): Set to "true" if the screen cast application
|
* "disable-animations" (b): Set to "true" if the screen cast application
|
||||||
would prefer animations to be globally
|
would prefer animations to be globally
|
||||||
disabled, while the session is running. Default
|
disabled, while the session is running.
|
||||||
is "false". Available since version 3.
|
Default is "false".
|
||||||
|
Available since version 3.
|
||||||
-->
|
-->
|
||||||
<method name="CreateSession">
|
<method name="CreateSession">
|
||||||
<arg name="properties" type="a{sv}" direction="in" />
|
<arg name="properties" type="a{sv}" direction="in" />
|
||||||
|
|
@ -47,47 +48,47 @@
|
||||||
<interface name="org.gnome.Mutter.ScreenCast.Session">
|
<interface name="org.gnome.Mutter.ScreenCast.Session">
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Start:
|
Start:
|
||||||
|
|
||||||
Start the screen cast session
|
Start the screen cast session
|
||||||
-->
|
-->
|
||||||
<method name="Start" />
|
<method name="Start" />
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Stop:
|
Stop:
|
||||||
|
|
||||||
Stop the screen cast session
|
Stop the screen cast session
|
||||||
-->
|
-->
|
||||||
<method name="Stop" />
|
<method name="Stop" />
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Closed:
|
Closed:
|
||||||
|
|
||||||
The session has closed.
|
The session has closed.
|
||||||
-->
|
-->
|
||||||
<signal name="Closed" />
|
<signal name="Closed" />
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
RecordMonitor:
|
RecordMonitor:
|
||||||
@connector: Connector of the monitor to record
|
@connector: Connector of the monitor to record
|
||||||
@properties: Properties
|
@properties: Properties
|
||||||
@stream_path: Path to the new stream object
|
@stream_path: Path to the new stream object
|
||||||
|
|
||||||
Record a single monitor.
|
Record a single monitor.
|
||||||
|
|
||||||
Available @properties include:
|
Available @properties include:
|
||||||
|
|
||||||
* "cursor-mode" (u): Cursor mode. Default: 'hidden' (see below)
|
* "cursor-mode" (u): Cursor mode. Default: 'hidden' (see below)
|
||||||
Available since API version 2.
|
Available since API version 2.
|
||||||
* "is-recording" (b): Whether this is a screen recording. May be
|
* "is-recording" (b): Whether this is a screen recording. May be
|
||||||
be used for choosing appropriate visual feedback.
|
be used for choosing appropriate visual feedback.
|
||||||
Default: false. Available since API version 4.
|
Default: false. Available since API version 4.
|
||||||
|
|
||||||
Available cursor mode values:
|
Available cursor mode values:
|
||||||
|
|
||||||
0: hidden - cursor is not included in the stream
|
0: hidden - cursor is not included in the stream
|
||||||
1: embedded - cursor is included in the framebuffer
|
1: embedded - cursor is included in the framebuffer
|
||||||
2: metadata - cursor is included as metadata in the PipeWire stream
|
2: metadata - cursor is included as metadata in the PipeWire stream
|
||||||
-->
|
-->
|
||||||
<method name="RecordMonitor">
|
<method name="RecordMonitor">
|
||||||
<arg name="connector" type="s" direction="in" />
|
<arg name="connector" type="s" direction="in" />
|
||||||
|
|
@ -96,21 +97,21 @@
|
||||||
</method>
|
</method>
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
RecordWindow:
|
RecordWindow:
|
||||||
@properties: Properties used determining what window to select
|
@properties: Properties used determining what window to select
|
||||||
@stream_path: Path to the new stream object
|
@stream_path: Path to the new stream object
|
||||||
|
|
||||||
Supported since API version 2.
|
Supported since API version 2.
|
||||||
|
|
||||||
Record a single window. The cursor will not be included.
|
Record a single window. The cursor will not be included.
|
||||||
|
|
||||||
Available @properties include:
|
Available @properties include:
|
||||||
|
|
||||||
* "window-id" (t): Id of the window to record.
|
* "window-id" (t): Id of the window to record.
|
||||||
* "cursor-mode" (u): Cursor mode. Default: 'hidden' (see RecordMonitor).
|
* "cursor-mode" (u): Cursor mode. Default: 'hidden' (see RecordMonitor).
|
||||||
* "is-recording" (b): Whether this is a screen recording. May be
|
* "is-recording" (b): Whether this is a screen recording. May be
|
||||||
be used for choosing panel icon.
|
be used for choosing panel icon.
|
||||||
Default: false. Available since API version 4.
|
Default: false. Available since API version 4.
|
||||||
|
|
||||||
-->
|
-->
|
||||||
<method name="RecordWindow">
|
<method name="RecordWindow">
|
||||||
|
|
@ -119,31 +120,31 @@
|
||||||
</method>
|
</method>
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
RecordArea:
|
RecordArea:
|
||||||
@x: X position of the recorded area
|
@x: X position of the recorded area
|
||||||
@y: Y position of the recorded area
|
@y: Y position of the recorded area
|
||||||
@width: width of the recorded area
|
@width: width of the recorded area
|
||||||
@height: height of the recorded area
|
@height: height of the recorded area
|
||||||
@properties: Properties
|
@properties: Properties
|
||||||
@stream_path: Path to the new stream object
|
@stream_path: Path to the new stream object
|
||||||
|
|
||||||
Record an area of the stage. The coordinates are in stage coordinates.
|
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
|
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.
|
recorded area, and will depend on DPI scale of the affected monitors.
|
||||||
|
|
||||||
Available @properties include:
|
Available @properties include:
|
||||||
|
|
||||||
* "cursor-mode" (u): Cursor mode. Default: 'hidden' (see below)
|
* "cursor-mode" (u): Cursor mode. Default: 'hidden' (see below)
|
||||||
Available since API version 2.
|
Available since API version 2.
|
||||||
* "is-recording" (b): Whether this is a screen recording. May be
|
* "is-recording" (b): Whether this is a screen recording. May be
|
||||||
be used for choosing panel icon.
|
be used for choosing panel icon.
|
||||||
Default: false. Available since API version 4.
|
Default: false. Available since API version 4.
|
||||||
|
|
||||||
Available cursor mode values:
|
Available cursor mode values:
|
||||||
|
|
||||||
0: hidden - cursor is not included in the stream
|
0: hidden - cursor is not included in the stream
|
||||||
1: embedded - cursor is included in the framebuffer
|
1: embedded - cursor is included in the framebuffer
|
||||||
2: metadata - cursor is included as metadata in the PipeWire stream
|
2: metadata - cursor is included as metadata in the PipeWire stream
|
||||||
-->
|
-->
|
||||||
<method name="RecordArea">
|
<method name="RecordArea">
|
||||||
<arg name="x" type="i" direction="in" />
|
<arg name="x" type="i" direction="in" />
|
||||||
|
|
@ -155,28 +156,28 @@
|
||||||
</method>
|
</method>
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
RecordVirtual:
|
RecordVirtual:
|
||||||
@properties: Properties
|
@properties: Properties
|
||||||
@stream_path: Path to the new stream object
|
@stream_path: Path to the new stream object
|
||||||
|
|
||||||
Record a virtual area that will be represented as a virtual monitor. The
|
Record a virtual area that will be represented as a virtual monitor. The
|
||||||
width and height corresponds to the non-scaled intended stream size.
|
width and height corresponds to the non-scaled intended stream size.
|
||||||
|
|
||||||
Available @properties include:
|
Available @properties include:
|
||||||
|
|
||||||
* "cursor-mode" (u): Cursor mode. Default: 'hidden' (see below)
|
* "cursor-mode" (u): Cursor mode. Default: 'hidden' (see below)
|
||||||
Available since API version 2.
|
Available since API version 2.
|
||||||
* "is-platform" (b): Whether this virtual output should be considered
|
* "is-platform" (b): Whether this virtual output should be considered
|
||||||
part of the platform, meaning it will not be
|
part of the platform, meaning it will not be
|
||||||
interpreted as if the screen is shared, but more
|
interpreted as if the screen is shared, but more
|
||||||
transparently as if it was a real monitor.
|
transparently as if it was a real monitor.
|
||||||
Available since API version 3. Default: FALSE.
|
Available since API version 3. Default: FALSE.
|
||||||
|
|
||||||
Available cursor mode values:
|
Available cursor mode values:
|
||||||
|
|
||||||
0: hidden - cursor is not included in the stream
|
0: hidden - cursor is not included in the stream
|
||||||
1: embedded - cursor is included in the framebuffer
|
1: embedded - cursor is included in the framebuffer
|
||||||
2: metadata - cursor is included as metadata in the PipeWire stream
|
2: metadata - cursor is included as metadata in the PipeWire stream
|
||||||
-->
|
-->
|
||||||
<method name="RecordVirtual">
|
<method name="RecordVirtual">
|
||||||
<arg name="properties" type="a{sv}" direction="in" />
|
<arg name="properties" type="a{sv}" direction="in" />
|
||||||
|
|
@ -191,19 +192,19 @@
|
||||||
<interface name="org.gnome.Mutter.ScreenCast.Stream">
|
<interface name="org.gnome.Mutter.ScreenCast.Stream">
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Start:
|
Start:
|
||||||
@short_description: Start new stream
|
@short_description: Start new stream
|
||||||
|
|
||||||
Start a stream of an already started session.
|
Start a stream of an already started session.
|
||||||
-->
|
-->
|
||||||
<method name="Start"/>
|
<method name="Start"/>
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
PipeWireStreamAdded:
|
PipeWireStreamAdded:
|
||||||
@short_description: Pipewire stream added
|
@short_description: Pipewire stream added
|
||||||
|
|
||||||
A signal emitted when PipeWire stream for the screen cast stream has
|
A signal emitted when PipeWire stream for the screen cast stream has
|
||||||
been created. The @node_id corresponds to the PipeWire stream node.
|
been created. The @node_id corresponds to the PipeWire stream node.
|
||||||
-->
|
-->
|
||||||
<signal name="PipeWireStreamAdded">
|
<signal name="PipeWireStreamAdded">
|
||||||
<annotation name="org.gtk.GDBus.C.Name" value="pipewire-stream-added"/>
|
<annotation name="org.gtk.GDBus.C.Name" value="pipewire-stream-added"/>
|
||||||
|
|
@ -211,15 +212,15 @@
|
||||||
</signal>
|
</signal>
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Parameters:
|
Parameters:
|
||||||
@short_description: Optional stream parameters
|
@short_description: Optional stream parameters
|
||||||
|
|
||||||
Available parameters include:
|
Available parameters include:
|
||||||
|
|
||||||
* "position" (ii): Position of the source of the stream in the
|
* "position" (ii): Position of the source of the stream in the
|
||||||
compositor coordinate space.
|
compositor coordinate space.
|
||||||
* "size" (ii): Size of the source of the stream in the compositor
|
* "size" (ii): Size of the source of the stream in the compositor
|
||||||
coordinate space.
|
coordinate space.
|
||||||
-->
|
-->
|
||||||
<property name="Parameters" type="a{sv}" access="read" />
|
<property name="Parameters" type="a{sv}" access="read" />
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue