zkde_screencast_unstable_v1 protocol

zkde_screencast_unstable_v1 interface version 2

Requests

stream_output since version 0

stream_output(stream new_id[zkde_screencast_stream_unstable_v1], output object[wl_output], pointer uint)
Arguments
Name Type Description
stream new_id[zkde_screencast_stream_unstable_v1]
output object[wl_output]
pointer uint Requested pointer mode

stream_window since version 0

stream_window(stream new_id[zkde_screencast_stream_unstable_v1], window_uuid string, pointer uint)
Arguments
Name Type Description
stream new_id[zkde_screencast_stream_unstable_v1]
window_uuid string window Identifier
pointer uint Requested pointer mode

destroy (destructor) since version 0

~destroy()

Destroy the zkde_screencast_unstable_v1 object.


stream_virtual_output since version 2

stream_virtual_output(stream new_id[zkde_screencast_stream_unstable_v1], name string, width int, height int, scale fixed, pointer uint)
Arguments
Name 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

Enums

pointer since version 0

enum pointer {
    hidden = 1,
    embedded = 2,
    metadata = 4,
}
Entries
Name Value Description
hidden 1 No cursor
embedded 2 Render the cursor on the stream
metadata 4 Send metadata about where the cursor is through PipeWire

zkde_screencast_stream_unstable_v1 interface version 2

Requests

close (destructor) since version 0

~close()

Events

closed since version 0

closed()

created since version 0

created(node uint)
Arguments
Name Type Description
node uint node of the pipewire buffer

failed since version 0

failed(error string)
Arguments
Name Type Description
error string A human readable translated error message.

SPDX-FileCopyrightText: 2020-2021 Aleix Pol Gonzalez <aleixpol@kde.org> SPDX-License-Identifier: LGPL-2.1-or-later