查询云录屏任务状态 GetWebCastTask--实时音视频-火山引擎

文档中心

立即注册

导航

查询云录屏任务状态 GetWebCastTask

最近更新时间：2024.07.16 15:31:21首次发布时间：2024.01.03 20:25:16

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在实时音视频通话场景中，若需获取特定云录屏任务的详细信息，你可通过调用此接口实现。

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

注意事项

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

请求说明

请求方式：GET
请求地址：https://rtc.volcengineapi.com?Action=GetWebCastTask&Version=2023-11-01

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetWebCastTask`	接口名称。当前 API 的名称为 `GetWebCastTask`。
Version	String	是	`2023-11-01`	接口版本。当前 API 的版本为 `2023-11-01`。
AppId	String	是	`661e****543cf`	你的音视频应用的唯一标志
RoomId	String	是	`Room1`	房间的 ID，是房间的唯一标志
TaskId	String	是	`Task1`	要查询的云录屏任务 ID。

返回参数

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

参数	类型	示例值	描述
WebCastTask	Object	`-`	云录屏任务信息
StartTime	Long	`1676987478000`	任务开始时间戳，Unix 时间，单位为毫秒
EndTime	Long	`1676987489000`	任务结束时间戳，Unix 时间，单位为毫秒。`0` 表示任务未结束
Status	Long	`3`	任务状态。支持取值及含义如下： `0`: 未知异常状态 `1`: 未开始 `2`: 运行中 `3`: 已结束 `4`: 任务运行失败
StopReason	String	`StopByAPI`	任务停止的原因。支持取值及含义如下：返回为空：表示任务未结束 `UnknownStopReason`：未知停止原因 `StopByAPI`：用户主动调用服务端 OpenAPI 停止 `StartTaskFailed`：任务启动失败 `ExceedMaxRunningTime`：任务超过最大运行时间
UserId	String	`User1`	推送网页音视频内容的用户对应的 UserId
SourceURL	String	`https://xxxxx`	需要转推的网页地址，可以携带自定义的 `queryParams` 来鉴权等，总体长度不超过 1024。
VideoSolutions	Object[]	`-`	输出的视频参数，最多支持 2 路，以大小流的方式支持接收端按需订阅，将以最大的视频流分辨率作为网页渲染分辨率，为空时按默认值填充一路
Width	Integer	`1280`	视频宽度，单位为像素，范围为 `[50,1920]`，默认值为 `1280`。必须是偶数，值为奇数时自动调整为偶数。
Height	Integer	`720`	视频高度，单位为像素，范围为 `[50,1080]`，默认值为 `720`。必须是偶数，值为奇数时自动调整为偶数。
FrameRate	Integer	`15`	发送帧率，单位为 `fps`，范围为`[1,60]`，默认值为 `15`。帧率和码率设置建议参照视频发布参数对照表以获取最佳体验。
Bitrate	Integer	`0`	最大发送码率，取值范围为 `[0,10000]`，单位为 `Kbps`，默认值 `0`，为 `0` 时表示自适应码率。
MaxRunningTime	Integer	`86400`	最大运行时间，超过此时间后，任务自动终止。单位为秒。取值范围为 `[10,86400]`，默认值为 `86400`。不填时自动调整为默认值。
MonitorConfig	Object	`-`	页面可用性监控配置
FreezeCheckInterval	Integer	`5`	对页面内容是否无变化的检测间隔。取值范围为 `[2,30]`，单位为秒。默认值为 `0`，表示不启用。当连续两次出现检测命中时，将对页面进行刷新，并回调`Status=4，Reason="PageFreeze"`。再次出现连续两次检测命中时，将进行任务重调度，并回调`Status=5，Reason="PageFreeze"`。注意：页面无变化可能是您业务的正常场景，请谨慎评估页面实际内容情况后再开启此功能，以免任务提前退出。
BlankCheckInterval	Integer	`5`	对页面是否白屏的检测间隔。取值范围为 `[2,30]`，单位为秒。默认值为`0`，表示不启用。当连续两次出现检测命中时，将对页面进行刷新，并回调`Status=4，Reason="PageBlank"` 。再次出现连续两次检测命中时将进行任务重调度，并回调`Status=5，Reason="PageBlank"`。注意：页面全白可能是您业务的正常场景，请谨慎评估页面实际内容情况后再开启此功能，以免任务提前退出。
CrashCheckInterval	Integer	`5`	对页面 JS 线程是否崩溃/卡死的检测间隔。取值范围为 `[0,30]`，单位为秒。默认值为 `0`，表示不启用。当出现检测命中时将进行任务重调度，并回调 `Status=5，Reason="PageCrash"`。
EventNotifyConfig	Object	`-`	页面事件通知配置。若需要避免未载入完成时的不完整页面被采集，可以启用此配置。
EnableEventNotify	Boolean	`true`	是否启用页面主动事件通知,。 `false`：页面在打开后就会开始采集，在收到 `StopWebCast` openAPI 请求后结束采集。 `true`：在页面中注入两个 JS 函数：`onWebcastStart()`和 `onWebcastEnd()`。默认值为`false`。当页面判断资源加载完成之后调用 `onWebcastStart()`，控制程序才会开始进行页面内容的采集。当页面判断本次任务内容已完成时调用`onWebcastEnd()` 通知控制程序结束本次任务。`StopWebCast` openAPI 效果不变，业务可提前结束任务。其他页面内容、JS 线程的检测（若启用），将在收到 `onWebcastStart()`事件后才开始。当启用页面主动事件通知后，你可以参考以下示例代码来通知采集开始。 `<script> if (ready() && typeof onWebcastStart === 'function') onWebcastStart(); </script>`
StartTimeout	Integer	`2`	启用页面主动事件通知后，等待开始事件的超时时间。取值范围为 `[0,60]`，单位为秒。默认值为 `0`，表示不启用。仅当 `EnableEventNotify` 为 `true` 时，此参数有效。当在超时时间内收到开始事件，采集功能正常运行，用户将收到 `Status=1`的回调。当超时时间内未收到开始事件，将进行刷新，等待时间被重置，再次发生超时后将进行任务重调度。刷新时将回调 `Status=4，Reason=" StartEventTimeout"`。重调度时将回调 `Status=5，Reason="StartEventTimeout"`。

请求示例

GET https://rtc.volcengineapi.com?Action=GetWebCastTask&Version=2023-11-01&AppId=661e****543cf&RoomId=Room1&TaskId=Task1

返回示例

{
    "Result": {
        "WebcastTask": {
            "StartTime": 1676987478000,
            "EndTime": 1676987489000,
            "Status": 3,
            "StopReason": "StopByAPI",
            "UserId": "user1",
            "SourceURL": "https://xxxxx",
            "VideoSolutions": [
                {
                    "Width": 1920,
                    "Height": 1080,
                    "FrameRate": 60,
                    "Bitrate": 10000
                }
            ],
            "MonitorConfig": {
                "BlankCheckInterval": 5,
                "CrashCheckInterval": 5,
                "FreezeCheckInterval": 5
            },
            "EventNotifyConfig": {
                "EnableEventNotify": true,
                "StartTimeout": 2
            },
            "MaxRunningTime": 3600
        }
    },
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "GetWebCastTask",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}

错误码

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