后台屏幕录制
后台录制屏幕区域为视频文件,通过会话 ID 跨步骤控制录制生命周期。
当前模块定义
sys:screenRecording输入 17 · 输出 6 · 枚举 5
输入参数
- 操作
operationEnum必填录屏会话操作类型。
4 个选项开始录屏、暂停录屏、继续录屏
开始录屏默认start暂停录屏pause继续录屏resume结束录屏stop - 会话 ID
sessionIdText可选录屏会话标识(GUID)。开始录屏时留空将自动生成;暂停/继续/结束时必须提供。
- 失败后停止
stopIfFailBoolean可选失败后是否停止动作
- 录制范围
regionTypeEnum必填要录制的屏幕区域类型。
固定区域默认fixed_area主屏幕primary_screen所有屏幕full_screen - 录制区域
areaText可选固定区域坐标,格式:left,top,right,bottom。默认不包含右边和底边像素。
- 包含右下边像素
includeRightBottomBorderBoolean可选包含时,0,0,2,2 表示 3×3 区域;否则为 2×2。
- 输出文件路径
outputFilePathText可选留空时使用 Quicker 临时目录下的时间戳文件名。
- 输出格式
outputFormatEnum必填录屏输出文件格式。
MP4默认mp4GIFgifAVIavi - 导出画质
exportQualityEnum必填录屏导出画质:标准、高清或原始。
标准默认standard高清high原始original - 帧率
framesPerSecondInteger可选录制帧率,将自动规整到 10/15/24/30/60。
- 显示鼠标光标
showCursorBoolean可选是否在录制画面中显示鼠标光标。
- 编码策略
encodingStrategyEnum必填边录边编码:录制时实时生成成品文件,停止后立即可用(需要 QuickerAvCodec)。先录后编码:先录制中间文件,停止后通过 ffmpeg 转码为目标格式,等待时间取决于录制时长和分辨率。
实时编码默认encodeWhileRecording录制结束后转码recordThenEncode - 开始后立即返回
returnImmediatelyBoolean可选启用后步骤在启动录制后立即成功返回;结束录屏请使用单独的结束步骤。
- 开始前延迟
delayInteger可选等待多少毫秒后开始录制。
- 等待编码完成
waitForCompletionBoolean可选结束录屏时是否等待文件写入完成。
- 结束后删除会话
removeSessionAfterStopBoolean可选结束录屏成功后从会话注册表移除。
- 加入录屏历史
addToHistoryBoolean可选结束录屏时显式将成品复制到本机录屏历史。后台录屏默认不加入历史。
输出参数
- 是否成功
isSuccessBoolean操作是否成功
- 会话 ID
sessionIdOutText录屏会话标识,供后续暂停/继续/结束步骤使用。
- 文件路径
filePathText录制完成的视频文件路径。
- 录制时长
durationSecondsNumber录制时长(秒)。
- 录制区域
rectText实际录制区域(left,top,right,bottom)。
- 错误消息
errMessageText步骤执行出错时的消息
后台屏幕录制
后台录制屏幕区域为视频文件,通过会话 ID 跨步骤控制录制生命周期。
使用说明
本模块与屏幕截图共享基础使用说明;本页上方参数表是当前模块自身的定义。