检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
客户端对象(Client) 本章节介绍了Web SDK的Client接口详情。 表1 Client接口 接口 描述 join 加入房间。调用该接口让用户加入指定房间,进行音频/视频通话。 leave 离开房间。用户结束通话后须调用该接口离开房间。 publish 加入房间后,发布本地流
查询用量 功能介绍 查询过去的某一时间段内各种业务的用量数据 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{project_id}/rtc/history
播放音效 功能描述 用户可以同时播放多个音效文件,给自己和其他与会者听,用于烘托气氛。 支持播放wav、pcm和单声道mp3音频文件,支持本地或在线文件路径。 接口调用流程 实现过程 加入房间 参考接口调用流程中加入房间的时序图步骤加入房间。 播放音效文件 调用playAudioClip
主要功能 SparkRTC主要包含基本房间功能和跨房功能,各端主要功能框架,如图1所示。 说明:图1中仅展示各端的统一功能,独属功能详见各端SDK指导。 图1 功能框架 表1 功能说明 类别 功能分类 功能说明 基本功能 初始化等基础接口 主要功能包括创建/销毁RTC引擎、设置日志保存位置等
事件回调(HWRtcEngine) 本章节介绍了iOS/Mac SDK的回调接口HWRtcEngineDelegate的详情。 表1 事件回调说明 接口 描述 onJoinSuccess 成功加入房间回调 onJoinRoomFailure 加入房间失败回调 onRejoinRoomSuccess
设备管理 setSpeakerModel - (int)setSpeakerModel:(HWRtcSpeakerModel)speakerModel; 【功能说明】 设置声音播放模式。成功加入房间后才能调用。 【请求参数】 speakerModel:声音播放模式,具体请参见HWRtcSpeakerModel
事件回调(HWRtcConnection) 本章节介绍了iOS/macOS SDK的回调接口HWRtcConnectionDelegate的详情。 表1 事件回调说明 接口 描述 connection:onJoinSuccess 成功加入跨房房间回调 connection:onJoinRoomFailure
播放音效文件 功能描述 用户可以同时播放多个音效文件,给自己和其他与会者听,用于烘托气氛。 支持本地或在线文件路径,文件格式支持播放wav、pcm和单声道mp3音频格式。 接口调用流程 实现播放音效文件 加入房间 参考接口调用流程中加入房间的时序图步骤加入房间。 播放音效文件 调用
数据类型 本章节列出了iOS/macOS SDK的所有数据类型,您可以结合HWRtcEngine接口和回调进行开发。 表1 数据类型 类型 描述 HWRtcUserInfo 用户信息 HWRtcJoinParam 入会信息 HWRtcVideoEncode 视频编码 HWRtcDeviceInfo
播放音乐 功能描述 混音是将音乐文件和麦克风音频混合,一般用于播放时长较长的背景音乐或者伴奏。同一时间只能播放一个音乐文件。可以在本地播放,也可以同时播放给其他与会者听。 支持播放本地或在线音乐文件,文件格式支持播放wav、pcm和单声道mp3音频格式。 接口调用流程 实现过程 加入房间
SDK使用 检测浏览器是否兼容 SDK。具体接口详情请参见checkSystemRequirements。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 async isBrowserSupport() { let check =
SDK使用 创建引擎。 AppId获取方法请参见创建应用。 1 2 3 4 5 6 7 8 9 10 11 HRTCEngineConfig config = new HRTCEngineConfig(); config.setAppId(appId); // AppId
播放音乐 功能描述 混音是将音乐文件和麦克风音频混合,一般用于播放时长较长的背景音乐或者伴奏。同一时间只能播放一个音乐文件。可以在本地播放,也可以同时播放给其他与会者听。 支持播放wav、pcm和单声道mp3音频文件。可以播放本地或在线音乐文件。 接口调用步骤 实现过程 加入房间
查询历史质量 功能介绍 查询质量指标过去每天的体验数据,可查询最近31天的数据。当天未结束,无法查询到当天的体验数据。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能
自定义视频渲染 功能描述 实时音视频传输过程中,上层应用可以不用SDK默认的渲染功能,选择对视频帧数据进行自定义渲染。 接口调用流程 实现过程 加入房间前开启视频自渲染 加入房间前调用接口setExternalVideoFrameOutput打开视频自渲染功能。 //开启远端或者本地的视频自渲染
辅流管理 startRemoteAuxiliaryStreamView public abstract int startRemoteAuxiliaryStreamView(String userId, SurfaceView view); 【功能说明】 开始订阅辅流。 【请求参数
屏幕分享 功能描述 屏幕共享用于在音视频会议中,把一个与会者的屏幕内容,以视频的方式分享给其他与会者。 接口调用流程 实现屏幕共享 加入房间 参考接口调用流程中加入房间的时序图步骤加入房间。 共享桌面 加入房间后可以调用setAuxiliaryVideoEncoderConfig设置编码参数
接口总览 本章节介绍了Android SDK的HRTCConnection接口详情。 HRTCConnection按照其功能可分类为:初始化等基础接口、房间功能、音频管理、视频管理、屏幕共享。 单击下图中相应接口名称,可快速跳转到相应接口位置查看其使用方法。 表1 初始化等基础接口
事件回调(IHRTCEngineEventHandler) 本章节介绍了Android SDK的回调接口IHRTCEngineEventHandler的详情。 表1 回调接口 接口 描述 onError 错误回调 onJoinRoomSuccess 加入房间成功回调 onJoinRoomFailure
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则:{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer