启动录像--慢直播-火山引擎

文档中心

立即注册

导航

启动录像

最近更新时间：2023.04.11 16:35:01首次发布时间：2023.02.03 18:54:55

对指定视频流启动录像任务。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
StreamID	String	是	视频流 ID，可通过调用 ListStreams 接口获取
AutoPull	Boolean	是	是否自动拉起视频流： true（如果视频流当前不在线，发起录制任务前会主动尝试拉起视频流） false（需要通过调用 StartStream 接口启用视频流后再开始录制）
Timeout	Int	是	拉流超时时间，单位：秒（如果超过指定的超时时间视频流仍然不在线，则暂停录制任务，返回 timeout 错误）
RecordTime	Int	否	预估录制时间，单位：秒（如果超过指定的录制预估时间，则主动停止录制任务，返回录制结果；默认不主动停止录制，由停止录像/Timeout 控制）
Remux	String	否	是否发起转封装（如需发起转封装，可选字段：mp4，转封装成功后可以通过 GetStreamRecord 接口查询转封装结果，默认不发起）
Expire	Int	否	录像过期时间，单位：秒（过期的录像会被主动删除；默认过期时间为7天，-1表示永不过期）

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
ID	String	录制任务唯一 ID，凭借该 ID 可以停止录像、查询录像结果、删除录像

示例

请求示例

POST https://open.volcengineapi.com?Action=StreamStartRecord
&Version=2021-01-01
&<公共请求参数>

{
    "StreamID": "4b9ee060-9fed-4c0e-aaa4-283b17xxxxxx",
    "AutoPull": false,
    "Timeout": 20,
    "RecordTime": 100,
    "Remux": "mp4",
    "Expire": -1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202209141449260102020891370D037571",
        "Action": "StreamStartRecord",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
       "ID":"record0xxxxx"
    }
}