录屏 RecordScreen--云手机-火山引擎

文档中心

立即注册

导航

录屏 RecordScreen

最近更新时间：2024.05.09 17:19:40首次发布时间：2022.04.21 18:01:57

对指定云手机实例录屏，并保存录制文件。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	RecordScreen
Version	Query	String	是	公共参数，OpenAPI 接口版本	2020-10-25

Body 参数

字段	类型	必填	说明
product_id	String	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
instance_id	String	是	实例 ID
option	String	是	录屏操作，可选枚举值为： `start`：开始录屏 `stop`：停止录屏注意：当处于 start 状态下，再次 start 会报错；当处于 stop 状态下，再次 stop 会报错。
file_name	String	否	保存录制文件的名称（文件名称以 .mp4 结尾），当 `option` 为 `start`时，为必填项
time_limit_seconds	Int32	否	录屏时长（到期后自动停止），单位：秒最大值：10800（3小时）默认值：180（3分钟）

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
file_path	String	保存录制文件的地址，例如：`/sdcard/mp4/record.mp4`（录制文件存储在实例内；如需上传录制文件至火山引擎对象存储，可调用 PullFile 接口）

示例

请求示例

POST https://open.volcengineapi.com?Action=RecordScreen
&Version=2020-10-25
&<通过header传入的公共请求参数>

{
    "product_id": "14677396781xxxxxxxx",
    "instance_id": "i-1726334685xxxxxx",
    "option": "start",
    "file_name": "record.mp4",
    "time_limit_seconds": 600
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ScreenRecord",
        "Region": "cn-north-1",
        "RequestId": "202203091551430101940340380F0B95C8",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "file_path": "/sdcard/mp4/record.mp4"
    }
}

错误码

错误码	错误信息	说明
21202	CodeInstanceInsufficientStorage	云手机实例存储空间不足
21301	CodeScreenRecordRecording	正在对当前云手机实例录屏中
21302	CodeScreenRecordNotRecording	当前云手机实例未处于录屏中