KDE screencast
zkde_screencast_unstable_v1
version 3
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
zkde_screencast_stream_unstable_v1
version 3
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.
created(node: uint)
Argument | Type | Description |
|---|---|---|
| node | uint | node of the pipewire buffer |
Notifies about a pipewire feed being created
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