TaskId

String

是

Your_TaskId

任务 ID。你必须对每个云录屏任务设定 TaskId，且在后续结束任务时也须使用该 TaskId。
TaskId 是任务的标识，在一个 AppId 的 RoomId 下 taskId 是唯一的，不同 AppId 或者不同 RoomId 下 TaskId 可以重复，因此 AppId + RoomId + TaskId 是任务的唯一标识，可以用来标识指定 AppId 下某个房间内正在运行的任务，从而能在此任务运行中进行更新或者停止此任务。
关于 TaskId 及以上 Id 字段的命名规则符合正则表达式：[a-zA-Z0-9_@\-\.]{1,128}。
若任务运行中，使用相同的 TaskId 重复调用开始接口不会导致请求失败，BaseResponse.Result 会提示 The task has been started. Please do not call the startup task interface repeatedly。

VideoSolutions

Array of VideoSolution

否

-

输出流的视频参数。网页渲染分辨率为输入最大视频流的分辨率。该值为空时按默认值填充一路。

• 当设置一路流时，不会输出多路流，输出流参数与设置值相同。
• 当设置两路流时， RTC 会启动推送多路流功能，设置的两路分辨率相当于分辨率等级划分中的大流和中流的上限。

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"。

EnableEventNotify

Boolean

否

true

是否启用页面主动事件通知, 默认值为false。

• false：页面在打开后就会开始采集，在收到 StopWebCast openAPI 请求后结束采集。
• true：在页面中注入两个 JS 函数：onWebcastStart()和 onWebcastEnd()。
  当页面判断资源加载完成之后调用 onWebcastStart()，控制程序才会开始进行页面内容的采集。当页面判断本次任务内容已完成时调用onWebcastEnd() 通知控制程序结束本次任务。StopWebCast openAPI 效果不变，业务可提前结束任务。其他页面内容、JS 线程的检测（若启用），将在收到 onWebcastStart()事件后才开始。
  当启用页面主动事件通知后，你可以参考以下示例代码来通知采集开始。

<script>
    if (ready() && typeof onWebcastStart === 'function')
        onWebcastStart();
</script>
html

StartTimeout

Integer

否

2

启用页面主动事件通知后，等待开始事件的超时时间。取值范围为[0,60]，单位为秒。默认值为0，表示不启用。仅当 EnableEventNotify 为 true 时，此参数有效。

• 当在超时时间内收到开始事件，采集功能正常运行，用户将收到 Status=1的回调。
• 当超时时间内未收到开始事件，将进行刷新，等待时间被重置，再次发生超时后将进行任务重调度。刷新时将回调 Status=4，Reason=" StartEventTimeout"。重调度时将回调 Status=5，Reason="StartEventTimeout"。