用于管理不同显示器和窗口的 PipeWire 流的协议

警告!此文件中描述的协议是桌面环境的实现细节。普通客户端不得使用此协议。可能会在不增加扩展主版本号的情况下引入不兼容的变更。

stream_output(stream: new_id<zkde_screencast_stream_unstable_v1>, output: object<wl_output>, pointer: uint)
参数
类型
描述
streamnew_id<zkde_screencast_stream_unstable_v1>
outputobject<wl_output>
pointeruint
Requested pointer mode
从给定源请求一个流
stream_window(stream: new_id<zkde_screencast_stream_unstable_v1>, window_uuid: string, pointer: uint)
参数
类型
描述
streamnew_id<zkde_screencast_stream_unstable_v1>
window_uuidstring
window Identifier
pointeruint
Requested pointer mode
从给定源请求一个流
destroy()
销毁 zkde_screencast_unstable_v1 对象

销毁 zkde_screencast_unstable_v1 对象。

stream_virtual_output(stream: new_id<zkde_screencast_stream_unstable_v1>, name: string, width: int, height: int, scale: fixed, pointer: uint)
参数
类型
描述
streamnew_id<zkde_screencast_stream_unstable_v1>
namestring
name of the created output
widthint
Logical width resolution
heightint
Logical height resolution
scalefixed
Scaling factor of the display where it's to be displayed
pointeruint
Requested pointer mode
从新的虚拟输出请求一个流
stream_region(stream: new_id<zkde_screencast_stream_unstable_v1>, x: int, y: int, width: uint, height: uint, scale: fixed, pointer: uint)
参数
类型
描述
streamnew_id<zkde_screencast_stream_unstable_v1>
xint
Logical left position
yint
Logical top position
widthuint
Logical width resolution
heightuint
Logical height resolution
scalefixed
Scaling factor of the output recording
pointeruint
Requested pointer mode
从工作区中的区域请求一个流

从版本 5 起,如果给定的 scale 为 0.0,合成器将为该区域选择最高的缩放因子。

stream_virtual_output_with_description(stream: new_id<zkde_screencast_stream_unstable_v1>, name: string, description: string, width: int, height: int, scale: fixed, pointer: uint)
参数
类型
描述
streamnew_id<zkde_screencast_stream_unstable_v1>
namestring
name of the created output
descriptionstring
user visible description of the created output
widthint
Logical width resolution
heightint
Logical height resolution
scalefixed
Scaling factor of the display where it's to be displayed
pointeruint
Requested pointer mode
从新的虚拟输出请求一个流
pointer { hidden, embedded, metadata } 
参数
描述
hidden1
不显示光标
embedded2
在流上渲染光标
metadata4
通过 PipeWire 发送光标位置的元数据
流消费者的附加属性


close()
表示流已结束,通信完成。
closed()
通知服务器已停止该流。客户端现在应调用 close。
created(node: uint)
参数
类型
描述
nodeuint
node of the pipewire buffer
通知已创建一个 PipeWire 流
failed(error: string)
参数
类型
描述
errorstring
A human readable translated error message.
提供错误消息,使客户端知道 created 事件不会到达,客户端应关闭该资源。

合成器支持

未发现合成器支持

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

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

Footer

© 2026 Wayland Explorer

本网站与 Wayland 官方项目无任何关联。网站所有内容均根据 Wayland 协议 XML 文件自动生成。

本网站使用的 Visual Studio Code - Codicons 遵循 CC BY 4.0 许可。