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

文档中心

立即注册

导航

StreamStartRecord - 启动录像

最近更新时间：2025.06.06 14:20:33首次发布时间：2023.02.03 18:54:55

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

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=StreamStartRecord&Version=2021-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ID	String	record0xxxxxxxx	录制任务唯一 ID，凭借该 ID 可以停止录像、查询录像结果、删除录像

请求示例

POST /?Action=StreamStartRecord&Version=2021-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241219T033133Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241219/cn-beijing/aiotvideo/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "StreamID": "8RFQ",
  "AutoPull": false,
  "Timeout": 887
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241219113137179036159024C1D941",
    "Action": "StreamStartRecord",
    "Version": "2021-01-01",
    "Service": "aiotvideo",
    "Region": "cn-beijing"
  },
  "Result": {
    "ID": "GW3HBbfgM"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter.StreamStartRecordReq	InvalidParameter.StreamStartRecordReq