You need to enable JavaScript to run this app.
导航

查询录制任务状态 GetRecordTask

最近更新时间2024.01.12 16:39:45

首次发布时间2023.10.31 17:39:57

本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本
你可以使用此接口查询指定录制任务的相关信息。

使用说明

接口行为

如果有多个任务, 会返回最新创建的录制任务。
录制文件生成后,不推荐调用 GetRecordTask接口获取录制生成的文件,强烈建议接入录制结束回调事件。

通过此接口仅能查询距今 72 小时内开始的录制任务。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法

注意事项

请求频率:QPS 不得超过 60。

请求说明

  • 请求方式:GET
  • 请求地址:https://rtc.volcengineapi.com?Action=GetRecordTask&Version=2023-06-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetRecordTask接口名称。当前 API 的名称为 GetRecordTask
VersionString2023-06-01接口版本。当前 API 的版本为 2023-06-01
AppIdStringYour_AppId你的音视频应用的唯一标志
RoomIdStringYour_RoomId房间的 ID,是房间的唯一标志
TaskIdStringYour_TaskId要查询的云端录制任务 ID。

返回参数

下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构

参数类型示例值描述
RecordTaskObject of RecordTask录制任务信息

RecordTask

参数类型示例值描述
StartTimeLong1624873773000任务开始的时间,为 Unix 时间戳,单位毫秒
EndTimeLong1624874235000任务结束的时间,为 Unix 时间戳,单位毫秒。0 表示任务未结束

Status

Long

1

任务状态:0: 未知异常状态

  • 1: 未开始
  • 2: 运行中
  • 3: 已结束
  • 4: 任务运行失败

StopReason

String

StopByAPI

任务停止的原因:

  • 空:表示任务未结束
  • UnknownStopReason:未知停止原因
  • StopByAPI:用户主动通过 API 停止
  • StartTaskFailed:任务启动失败
  • IdleTimeOut:超过了最大空闲时间
RecordFileListArray of RecordFile-录制生成的文件列表。

RecordFile

参数类型示例值描述
VidStringYour_Vid文件在火山引擎视频点播 VOD 平台的唯一标识。你可以根据 vid 在点播平台上找到对应的文件。仅在你选择配置存储到 Vod 平台时,此参数有效。
ObjectKeyStringabc/efg/123.mp4文件在对象存储平台中的完整路径,如abc/efg/123.mp4。仅在你选择配置存储到对象存储平台时,此参数有效。
DurationLong457280文件时长,单位为毫秒。
SizeLong30388433文件大小,单位为 byte。
StartTimeLong1624873773354文件开始录制的 UTC 时间,单位为毫秒。
StreamListArray of Stream录制文件中包含流的列表。
VideoCodecString0视频录制编码协议
AudioCodecString0音频录制编码器
VideoWidthInteger640录制视频宽度,单位为像素
VideoHeightInteger480录制视频高度,单位为像素

Stream

参数类型示例值描述
IndexInteger0在自定义布局中,使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中,你需要使用 Index 指定对应流的布局设置。
UserIdStringYour_UserId用户Id,表示这个流所属的用户。
StreamTypeInteger0流的类型,值可以取01,默认值为00表示普通音视频流,1表示屏幕流。

请求示例

GET https://rtc.volcengineapi.com?Action=GetRecordTask&Version=2023-06-01&AppId=Your_AppId&RoomId=Your_RoomId&TaskId=Your_TaskId

返回示例

{
    "Result": {
        "RecordTask": {
            "StartTime": 1624873773000,
            "EndTime": 1624874235000,
            "Status": 3,
            "StopReason": "StopByAPI",
            "RecordFileList": [
                {
                    "Vid": "Your_Vid",
                    "Duration": 457280,
                    "Size": 30388433,
                    "StartTime": 1624873773354,
                    "StreamList": [
                        {
                            "UserId": "Your_UserId",
                            "StreamType": 0
                        }
                    ]
                }
            ]
        }
    },
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "GetRecordTask",
        "Version": "2023-06-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。