实时音视频 SPARKRTC-更新单流任务:响应参数

时间:2024-10-18 15:28:09

响应参数

状态码: 200

表5 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号,以便任务跟踪。

表6 响应Body参数

参数

参数类型

描述

job_id

String

任务编号

stream_name

String

流名

app_id

String

应用id

room_id

String

房间id

user_id

String

选看的用户id,单个录制任务内保证唯一

is_record_audio

Boolean

是否录制音频。

  • true:录制音频

  • false:不录制音频

缺省为true。

video_type

String

标识视频流的类型,可选摄像头流或者屏幕分享流,未填写表示不录制视频。

  • CAMERASTREAM:摄像头视频流

  • SCREENSTREAM:屏幕分享视频流

默认为CAMERASTREAM。

select_stream_type

String

指定窗口拉取的分辨率档位。

  • LD

  • SD

  • HD

  • FHD

缺省为FHD。

max_idle_time

Integer

最长空闲频道时间。

取值范围:[5,43200],默认值为30。

单位:秒。

如果频道内无连麦方的状态持续超过该时间,录制程序会自动退出。退出后,再次调用start请求,会产生新的录制任务。

连麦方指:joiner或者publisher的用户。

record_param

RecordParam object

录制参数

create_time

String

创建时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC

update_time

String

更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC

state

String

任务状态。

  • INIT:任务正在初始化

  • RUNNING:任务正在运行

  • STOPPED:任务已停止

stop_reason

String

任务结束原因

  • TENANT_STOP

  • EXCEED_MAX_IDLE_TIME

  • INTERNAL_ERROR

description

String

针对任务状态的详细信息描述

start_time

String

任务开始时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC

stop_time

String

任务完成时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC

表7 RecordParam

参数

参数类型

描述

record_rule_id

String

录制规则id。

状态码: 400

表8 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号,以便任务跟踪。

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表10 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号,以便任务跟踪。

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表12 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号,以便任务跟踪。

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

support.huaweicloud.com/api-rtc/UpdateIndividualStreamJobV2.html