KDE screencast

Protocol for managing PipeWire feeds of the different displays and windows.
stream_output(stream: new_id<zkde_screencast_stream_unstable_v1>, output: object<wl_output>, pointer: uint)
Argument
Type
Description
streamnew_id<zkde_screencast_stream_unstable_v1>
outputobject<wl_output>
pointeruint
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
streamnew_id<zkde_screencast_stream_unstable_v1>
window_uuidstring
window Identifier
pointeruint
Requested pointer mode
Requests a feed from a given source
destroy()
Destroy the zkde_screencast_unstable_v1

Destroy the zkde_screencast_unstable_v1 object.

pointer { hidden, embedded, metadata } 
Argument
Value
Description
hidden1
No cursor
embedded2
Render the cursor on the stream
metadata4
Send metadata about where the cursor is through PipeWire
Stream consumer attachment attributes


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
nodeuint
node of the pipewire buffer
Notifies about a pipewire feed being created
failed(error: string)
Argument
Type
Description
errorstring
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.

SPDX-FileCopyrightText: 2020 Aleix Pol Gonzalez <aleixpol@kde.org>

SPDX-License-Identifier: LGPL-2.1-or-later