你可以使用此接口查询指定云录屏任务的相关信息。
你可以调用GetWebCastTask
接口,指定你所属的 AppId
,查询指定 RoomId
下的云录屏任务。
通过此接口仅能查询距今 72 小时内开始的云录屏任务。
请求频率:QPS 不得超过 60。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetWebCastTask | 接口名称。当前 API 的名称为 GetWebCastTask 。 |
Version | String | 是 | 2020-12-01 | 接口版本。当前 API 的版本为 2020-12-01 。 |
AppId | String | 是 | Your_AppId | 你的音视频应用的唯一标志 |
RoomId | String | 是 | Your_RoomId | 房间的 ID,是房间的唯一标志 |
TaskId | String | 是 | Your_TaskId | 要查询的云录屏任务 ID。 |
下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
WebCastTask | Object | - | 云录屏任务信息 |
StartTime | Long | 1676987478000 | 任务开始时间戳,Unix 时间,单位为毫秒 |
EndTime | Long | 1676987489000 | 任务结束时间戳,Unix 时间,单位为毫秒。 0 表示任务未结束 |
Status | Long | 3 | 任务状态。
|
StopReason | String | StopByAPI | 任务停止的原因
|
UserId | String | Your_UserId | 推送网页音视频内容的用户对应的 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 | 发送帧率,单位为 帧/秒,范围为 [1,60] ,默认值为 15 。帧率和码率设置建议参照视频发布参数对照表以获取最佳体验。 |
Bitrate | Integer | 0 | 最大发送码率,取值范围为 [0,10000] ,单位为 Kbps,默认值 0 ,为 0 时表示自适应码率。 |
MaxRunningTime | Integer | 86400 | 最大运行时间,超过此时间后,任务自动终止。单位为秒。取值范围为 [10,86400] ,默认值为 86400 。不填时自动调整为默认值。 |
MonitorConfig | Object | - | 页面可用性监控配置 |
FreezeCheckInterval | Integer | 5 | 对页面内容是否无变化的检测间隔。取值范围为
|
BlankCheckInterval | Integer | 5 | 对页面是否白屏的检测间隔。取值范围为
|
CrashCheckInterval | Integer | 5 | 对页面 JS 线程是否崩溃/卡死的检测间隔。 取值范围为 Status=5,Reason="PageCrash" 。 |
EventNotifyConfig | Object | - | 页面事件通知配置。若需要避免未载入完成时的不完整页面被采集,可以启用此配置。 |
EnableEventNotify | Boolean | true | 是否启用页面主动事件通知, 默认值为
当页面判断资源加载完成之后调用 当启用页面主动事件通知后,你可以参考以下示例代码来通知采集开始。
|
StartTimeout | Integer | 2 | 启用页面主动事件通知后,等待开始事件的超时时间。取值范围为
|
GET https://rtc.volcengineapi.com?Action=GetWebCastTask&Version=2020-12-01&AppId=Your_AppId&RoomId=Your_RoomId&TaskId=Your_TaskId
{ "Result": { "WebcastTask": { "StartTime": 1676987478000, "EndTime": 1676987489000, "Status": 3, "StopReason": "StopByAPI", "UserId": "Your_UserId", "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": "Your_RequestId", "Action": "GetWebCastTask", "Version": "2020-12-01", "Service": "rtc", "Region": "cn-north-1" } }
您可访问公共错误码,获取更多错误码信息。