Differential D28882 Diff 81113 src/client/protocols/screencast.xml

Changeset View

Standalone View

View Options

src/client/protocols/screencast.xml

  • This file was added.
1​<?xml version="1.0" encoding="UTF-8"?>
2​<protocol name="zkde_screencast_unstable_v1">
3​ <copyright><![CDATA[
4​ SPDX-FileCopyrightText: 2020 Aleix Pol Gonzalez <aleixpol@kde.org>
5​
6​ SPDX-License-Identifier: LGPL-2.1-or-later
7​ ]]></copyright>
8​ <interface name="zkde_screencast_unstable_v1" version="1">
9​ <description summary="Protocol for managing Pipewire feeds of the different displays and windows."/>
romanggUnsubmitted
Done

Interface names should be scoped too. Example.

Don't ask me why exactly why. I think it has something to do with the C structs becoming ambiguous otherwise. Someone else knows?

But in any case I would follow the examples set by upstream.

romangg: Interface names should be scoped too. [[ https://gitlab.freedesktop.org/wayland/wayland…
zzagUnsubmitted
Not Done

Interfaces usually come without unstable in the name.

s/zkde_screencast_unstable_v1/zkde_screencast_v1/

zzag: Interfaces usually come without `unstable` in the name.
10​
11​ <enum name="SourceType">
12​ <description summary="describes enabled state, follows org.freedesktop.impl.portal.ScreenCast.xml"/>
13​ <entry name="monitor" value="1"/>
14​ <entry name="window" value="2"/>
jgrulichUnsubmitted
Done

Can we switch the values to follow xdg-desktop-portal specification?

See https://github.com/flatpak/xdg-desktop-portal/blob/master/data/org.freedesktop.impl.portal.ScreenCast.xml#L168.

Even not following the specs, output will be the most used one.

jgrulich: Can we switch the values to follow xdg-desktop-portal specification? See https://github.
15​ </enum>
16​ <event name="add_source">
17​ <description summary="Notifies about a feed being created"/>
davidedmundsonUnsubmitted
Done

Typically events are like signals, so would be called "source_added"

Convention is also lower_snake_case

davidedmundson: Typically events are like signals, so would be called "source_added" Convention is also…
18​ <arg name="source" type="uint" summary="the source identifier"/>
19​ <arg name="description" type="string" summary="human readable text defining what the source is"/>
20​ <arg name="iconName" type="string" summary="icon name that defines the source (e.g. computer-laptop, window, tv)"/>
21​ <arg name="type" type="uint" summary="if it's a composited output (e.g a display) or a window instead"/>
22​ <arg name="geometryX" type="int" summary="geometry.x"/>
23​ <arg name="geometryY" type="int" summary="geometry.y"/>
24​ <arg name="geometryWidth" type="int" summary="geometry.width. Logical width, to place the source on the workspace."/>
25​ <arg name="geometryHeight" type="int" summary="geometry.height. Logical height, to place the source on the workspace."/>
26​ <arg name="width" type="int" summary="geometry.width. Width the buffer will have once created."/>
27​ <arg name="height" type="int" summary="geometry.height. Height the buffer will have once created."/>
28​ </event>
29​ <event name="removeSource">
30​ <description summary="Notifies about a source becoming unavailable"/>
31​ <arg name="source" type="uint" summary="the source identifier"/>
32​ </event>
davidedmundsonUnsubmitted
Not Done

this is racey with create.

davidedmundson: this is racey with create.
apolAuthorUnsubmitted
Not Done

Any suggestion on how to do it better?

apol: Any suggestion on how to do it better?
33​
34​ <event name="done">
35​ <description summary="Notifies that the initial propagation of sources is over"/>
36​ </event>
37​
38​ <request name="create">
39​ <description summary="requests a feed from a given source"/>
40​ <arg name="source" type="uint"/>
41​ <arg name="stream" type="new_id" interface="zkde_screencast_stream_unstable_v1"/>
42​ </request>
43​ </interface>
44​
45​ <interface name="zkde_screencast_stream_unstable_v1" version="1">
46​ <request name="close">
davidedmundsonUnsubmitted
Not Done

add type = "destructor"

so that clients calling this release the resource

davidedmundson: add type = "destructor" so that clients calling this release the resource
47​ <description summary="requests closing a pipewire buffer"/>
48​ </request>
49​ <event name="closed">
50​ <description summary="notifies about being done with the pipewire buffer"/>
51​ </event>
52​
53​ <event name="created">
54​ <description summary="Notifies about a pipewire feed being created"/>
55​ <arg name="node" type="uint" summary="node of the pipewire buffer"/>
zzagUnsubmitted
Not Done

zkde_screencast_stream_unstable_v1 must have a destructor request.

zzag: zkde_screencast_stream_unstable_v1 must have a destructor request.
56​ </event>
57​ <event name="failed">
58​ <description summary="Offers an error message so the client knows created will not arrive"/>
59​ <arg name="error" type="string" summary="error message"/>
60​ </event>
61​ </interface>
62​</protocol>