检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
删除应用 功能介绍 调用此接口删除单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id} 表1 路径参数 参数 是否必选
解散房间 功能介绍 调用此接口解散房间,将该房间中所有用户踢出房间。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/r
启用应用 功能介绍 调用此接口启用单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/enable 表1 路径参数
配置RTC增值(录制)事件回调 功能介绍 调用此接口配置增值(录制)事件上报回调。 当任务发生订阅了的事件时,通过该接口配置的回调地址通知。 回调内容请参见增值(录制)事件回调通知内容。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成S
查询指标过去每天的规模数量,可查询最近31天的数据。当天未结束,无法查到当天的房间数与用户数。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{pro
可以同时播放给其他与会者听。 可以播放本地或在线音乐文件,文件格式支持播放wav、pcm和单声道mp3音频格式。 接口调用流程 实现播放音乐文件 加入房间 参考接口调用流程中加入房间的时序图步骤加入房间。 播放音乐文件 调用startAudioFile播放音乐文件,目前仅支持本端播放。
0:方法调用失败。具体请参见HWRtcErrorCode。 该接口仅支持房间内调用,更改的昵称会被实时同步到房间内其他用户的用户列表,退出房间不会保存,再次加入房间变更为加入房间时设置的昵称(参考joinRoom接口注意事项)。 会触发用户名变更通知的回调onUserNameChangedNotify。
查询合流任务 功能介绍 调用此接口查询合流转码任务状态。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/mix-stream-jobs/{job_id}
0:方法调用失败。具体请参见HWRtcErrorCode。 只支持iPhone。 需要先调用setAuxiliaryVideoEncoderConfig接口,设置编码参数。 目前可支持多路辅流共享,若需开启多辅流,请提交工单联系技术支持处理。 共享成功后会触发onScreenShareStarted回调。
scene:(HWRtcAudioSceneType)scene; 【功能说明】 设置使用场景。该接口需要在joinRoom前调用。 此接口可在initWithConfig接口设置场景后改变音频场景,暂不支持初始化scene设置音乐再通过此接口设置为会议。 【请求参数】 level:表示档位,会议模式暂时只支持
踢除在线用户 功能介绍 调用此接口强制用户离开房间。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms/{ro
停止合流任务 功能介绍 调用此接口停止已下发的合流转码任务。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id}/mix
查询自动录制配置 功能介绍 调用此接口查询自动录制配置 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/auto-record-mode
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后,新房间无法新增和加入,已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
R_MMSYSERR_INVALPARAM 音频设备API非法参数,目前已知是杀毒软件导致(仅适用于Windows) HRTC_LOCAL_AUDIO_REASON_ERROR_MMSYSERR_NODRIVER 音频设备API返回无驱动,需要用户升级驱动(仅适用于Windows)
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
修改合流任务 功能介绍 调用此接口更新合流任务布局。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/mix-stream-jobs/{job_id}
客户端对象(Client) 本章节介绍了Web SDK的Client接口详情。 表1 Client接口 接口 描述 join 加入房间。调用该接口让用户加入指定房间,进行音频/视频通话。 leave 离开房间。用户结束通话后须调用该接口离开房间。 publish 加入房间后,发布本地流。 unpublish
停止单流任务 功能介绍 调用此接口停止单流任务 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id}/individual
replace:(int)replace startPos:(unsigned int)startPos; 【功能说明】 接口一:设置播放的音频文件,需要入会调用才生效。 接口二:启动音频混音。 接口三:开始播放音频文件。当前只支持本地播放。若角色为“publisher”,不支持调用。 【请求参数】 startAudioFileParam