Changeset View
Changeset View
Standalone View
Standalone View
src/client/protocols/video-streaming.xml
- This file was added.
| 1 | <?xml version="1.0" encoding="UTF-8"?> | ||||
|---|---|---|---|---|---|
| 2 | <protocol name="video_streaming"> | ||||
| 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="org_kde_kwin_video_streaming" version="1"> | ||||
| 9 | <description summary="Protocol for managing Pipewire feeds of the different displays and windows."/> | ||||
| 10 | | ||||
| 11 | <enum name="SourceType"> | ||||
| 12 | <description summary="describes enabled state"/> | ||||
| 13 | <entry name="window" value="0"/> | ||||
| 14 | <entry name="output" value="1"/> | ||||
| 15 | </enum> | ||||
| 16 | <event name="addSource"> | ||||
| 17 | <description summary="Notifies about a feed being created"/> | ||||
| 18 | <arg name="sourceId" 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"/> | ||||
| 25 | <arg name="geometryHeight" type="int" summary="geometry.height"/> | ||||
| 26 | </event> | ||||
| 27 | <event name="removeSource"> | ||||
| 28 | <description summary="Notifies about a feed becoming unavailable"/> | ||||
| 29 | <arg name="sourceId" type="uint" summary="the source identifier"/> | ||||
| 30 | </event> | ||||
| 31 | | ||||
| 32 | <event name="done"> | ||||
| 33 | <description summary="Notifies that the initial propagation of sources is over"/> | ||||
| 34 | </event> | ||||
| 35 | <event name="created"> | ||||
| 36 | <description summary="Notifies about a pipewire feed being created"/> | ||||
| 37 | <arg name="nodeid" type="int" summary="nodeid of the pipewire buffer"/> | ||||
| 38 | <arg name="sourceId" type="uint" summary="source the buffer is for"/> | ||||
| 39 | </event> | ||||
| 40 | | ||||
| 41 | <request name="create"> | ||||
| 42 | <description summary="requests a feed from a given source"/> | ||||
| 43 | <arg name="sourceId" type="uint"/> | ||||
| 44 | </request> | ||||
| 45 | <request name="close"> | ||||
| 46 | <description summary="notifies about being done with the source"/> | ||||
| 47 | <arg name="sourceId" type="uint"/> | ||||
| 48 | </request> | ||||
| 49 | | ||||
| 50 | </interface> | ||||
| 51 | </protocol> | ||||