KDE screencast
zkde_screencast_unstable_v1
version 6
Protocol for managing PipeWire feeds of the different displays and windows
Warning! The protocol described in this file is a desktop environment implementation detail. Regular clients must not use this protocol. Backward incompatible changes may be added without bumping the major version of the extension.
stream_output(stream: new_id<zkde_screencast_stream_unstable_v1>, output: object<wl_output>, pointer: uint)
Argument | Type | Description |
|---|---|---|
| stream | new_id<zkde_screencast_stream_unstable_v1> | |
| output | object<wl_output> | |
| pointer | uint | Requested pointer mode |
requests a feed from a given source
stream_window(stream: new_id<zkde_screencast_stream_unstable_v1>, window_uuid: string, pointer: uint)
Argument | Type | Description |
|---|---|---|
| stream | new_id<zkde_screencast_stream_unstable_v1> | |
| window_uuid | string | window Identifier |
| pointer | uint | Requested pointer mode |
requests a feed from a given source
zkde_screencast_unstable_v1::destroy
Type: destructor
destroy()
Destroy the zkde_screencast_unstable_v1
Destroy the zkde_screencast_unstable_v1 object.
stream_virtual_output(stream: new_id<zkde_screencast_stream_unstable_v1>, name: string, width: int, height: int, scale: fixed, pointer: uint)
Argument | Type | Description |
|---|---|---|
| stream | new_id<zkde_screencast_stream_unstable_v1> | |
| name | string | name of the created output |
| width | int | Logical width resolution |
| height | int | Logical height resolution |
| scale | fixed | Scaling factor of the display where it's to be displayed |
| pointer | uint | Requested pointer mode |
requests a feed from a new virtual output
stream_region(stream: new_id<zkde_screencast_stream_unstable_v1>, x: int, y: int, width: uint, height: uint, scale: fixed, pointer: uint)
Argument | Type | Description |
|---|---|---|
| stream | new_id<zkde_screencast_stream_unstable_v1> | |
| x | int | Logical left position |
| y | int | Logical top position |
| width | uint | Logical width resolution |
| height | uint | Logical height resolution |
| scale | fixed | Scaling factor of the output recording |
| pointer | uint | Requested pointer mode |
requests a feed from region in the workspace
Since version 5, the compositor will choose the highest scale factor for the region if the given scale is 0.0.
stream_virtual_output_with_description(stream: new_id<zkde_screencast_stream_unstable_v1>, name: string, description: string, width: int, height: int, scale: fixed, pointer: uint)
Argument | Type | Description |
|---|---|---|
| stream | new_id<zkde_screencast_stream_unstable_v1> | |
| name | string | name of the created output |
| description | string | user visible description of the created output |
| width | int | Logical width resolution |
| height | int | Logical height resolution |
| scale | fixed | Scaling factor of the display where it's to be displayed |
| pointer | uint | Requested pointer mode |
requests a feed from a new virtual output
zkde_screencast_stream_unstable_v1
version 6
zkde_screencast_stream_unstable_v1::close
Type: destructor
close()
Indicates we are done with the stream and the communication is over.
closed()
Notifies that the server has stopped the stream. Clients should now call close.
zkde_screencast_stream_unstable_v1::created
Deprecated since 6
created(node: uint)
Argument | Type | Description |
|---|---|---|
| node | uint | node of the pipewire buffer |
Notifies about a pipewire feed being created
Deprecated since version 6, use the object serial from the serial event instead
failed(error: string)
Argument | Type | Description |
|---|---|---|
| error | string | A human readable translated error message. |
Offers an error message so the client knows the created event will not arrive, and the client should close the resource.
serial(object_serial_hi: uint, object_serial_low: uint)
Argument | Type | Description |
|---|---|---|
| object_serial_hi | uint | high bits of the pipewire object serial |
| object_serial_low | uint | low bits of the pipewire object serial |
the pipewire object serial
The pipewire object serial of the stream. Should be preferred over the node id which is prone to id reuse. Will be sent before the created event.
Compositor Support
No compositor support found
Copyright
SPDX-FileCopyrightText: 2020-2021 Aleix Pol Gonzalez <aleixpol@kde.org>
SPDX-License-Identifier: LGPL-2.1-or-later