实时音视频 SparkRTC-启动单流任务:请求参数

时间:2023-11-01 16:16:40

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

内容类型。

X-Auth-Token

String

用户Token。使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

X-Project-Id

String

使用AK/SK方式认证时必选,携带项目ID信息。

表3 请求Body参数

参数

是否必选

参数类型

描述

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的用户。

publish_param

PublishParam object

转推参数

record_param

RecordParam object

录制参数

表4 PublishParam

参数

是否必选

参数类型

描述

rtmp_urls

Array of strings

合流任务完成后,转推的RTMP推流地址。

表5 RecordParam

参数

是否必选

参数类型

描述

record_rule_id

String

录制规则id。

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