检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
renewAuthorization 签名更新 √ √ √ √ changeUserRole 设置用户的角色,切换角色时使用 √ √ √ √ changeUserName 设置用户自己的昵称 √ √ √ √ createConnection 创建连接。跨房前需先创建连接 √ √ √ √
设置音效播放的最大音量 getAudioClipsVolume 获取音效播放的最大音量 setVolumeOfAudioClip 设置指定音效的播放音量 getVolumeOfAudioClip 获取指定音效的播放音量 setAudioClipPosition 设置指定音效文件的播放位置
String 共享屏幕的背景图地址,图片先上传obs,格式s3://bucket/object,如:s3://rtc-bucket-cn-north-4/img/testImg.jpg。 在一大多小的布局场景下,无论大窗是显示非指定用户(屏幕共享人的桌面)还是指定用户的共享桌面,都通过该字段指定背景图。
String 共享屏幕的背景图地址,图片先上传obs,格式s3://bucket/object,如:s3://rtc-bucket-cn-north-4/img/testImg.jpg。 在一大多小的布局场景下,无论大窗是显示非指定用户(屏幕共享人的桌面)还是指定用户的共享桌面,都通过该字段指定背景图。
String 共享屏幕的背景图地址,图片先上传obs,格式s3://bucket/object,如:s3://rtc-bucket-cn-north-4/img/testImg.jpg。 在一大多小的布局场景下,无论大窗是显示非指定用户(屏幕共享人的桌面)还是指定用户的共享桌面,都通过该字段指定背景图。
描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识 room_id 否 String 房间ID metric 是 String 查询的数据类型 OnlineUsers:在线用户数
是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识 metric 是 String 查询的数据类型 CommunicationDuration:音视频通话时长
描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id room_id 否 String 房间id start_time 是 String 起始时间。UT
音效文件支持同时播放多个,setAudioClipsVolume接口设置的音量是所有音频文件的最大音量,setVolumeOfAudioClip接口设置的是单个音效文件的音量,音效文件的实际播放音量 = 最大音量 * 自身音量 / 100。例如,最大音量是50,单个音效音量是80,实际播放音量就是50 * 80 /
路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id room_id 是 String 房间id 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。 X-Auth-Token 否
X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表2 请求Body参数 参数 是否必选 参数类型 描述 bucket 是 String OBS桶名 operation 是 Integer
断流后生成新文件:是指录制的直播流中断后,会立即生成新的录制文件。 断流后不生成新文件:是指录制的直播流中断后,会和之前录制的文件合并为一个文件。最大断流合并时长为30天。 其他数值:是指录制的直播流中断时间在设置范围内,则和之前录制的文件合并为一个文件,否则,生成新的录制文件。 MP4规则
参数类型 描述 location 是 String OBS Bucket所在RegionID cn-north-4 project_id 是 String OBS Bucket所在Region的项目ID bucket 是 String OBS的bucket名称 object 否 String
参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain 否 String 域名 app_id 是 String 应用id room_id 是 String 房间ID user_id
bucket 是 String 要查询的桶名 prefix 否 String 对象名前缀,可以理解为文件夹路径 type 是 String 查询类型。取值如下: folders:查询目录 objects:查询对象 location 是 String 查询bucket所在的region:
描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id room_id 否 String 房间id start_time 是 String 起始时间。UT
掉水印)。 xOffset:水印显示的左上角X轴偏移,取(0,1)的浮点数。 yOffset:水印显示的左上角y轴偏移,取(0,1)的浮点数。 fWidthRatio:水印显示的宽度占画面宽度的比例(水印按该参数等比例缩放显示),取(0,1)的浮点数。 【返回参数】 0:方法调用成功。
路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id job_id 是 String 任务编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。 X-Auth-Token 否
*)userid muted:(BOOL)muted; 【功能说明】 订阅或取消订阅对应远端用户的音频流。同一时间所有房间最多只能接收17路音频流。 【请求参数】 userid : 远端用户的id,唯一的标识。 muted:YES表示取消订阅,NO表示订阅。默认值 NO。 【返回参数】 0:方法调用成功。
频文件的最大音量,setVolumeOfAudioClip接口设置的是单个音效文件的音量,音效文件的实际播放音量 = 最大音量 * 自身音量 / 100。例如,最大音量是50,单个音效音量是80,实际播放音量就是50 * 80 / 100 = 40。 setAudioClipPosition