正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
客户端对象(Client) 本章节介绍了Web SDK的Client接口详情。 表1 Client接口 接口 描述 join 加入房间。调用该接口让用户加入指定房间,进行音频/视频通话。 leave 离开房间。用户结束通话后须调用该接口离开房间。 publish 加入房间后,发布本地流。 unpublish
通话质量监测 功能描述 加入房间后,SDK上报通话质量相关的回调,上报当前通话的网络质量、本地和远端的音视频统计信息。 接口调用流程 通话质量上报 network-quality网络上下行质量报告事件,用户加入房间后,在网络质量变化的时候会触发一次该事件,报告用户的本地网络上下行质量情况。
跨房连接的ChangeUserRole方法将本端的角色切换为HWRtcRoleJoiner后才能发送音频流和视频流。 接口调用流程 实现过程 加入房间 参考接口调用流程中加入房间的时序图步骤加入主房间。 创建跨房连接 当收到远端用户加入房间后会触发IHRTCConnectionE
通话质量监测 功能描述 加入频道后,SDK会每隔2秒自动触发通话质量相关的回调,上报当前通话的网络质量、本地和远端的音视频统计信息。 上报接口 通话质量上报 onNetworkQualityNotify回调上报当前通话中每个入会者的上下行网络质量。默认开启,每2s上报一次。 -
通话质量监测 功能描述 加入频道后,SDK会每隔2秒自动触发通话质量相关的回调,上报当前通话的网络质量、本地和远端的音视频统计信息。 上报接口 通话质量上报 onNetworkQualityNotify回调上报当前通话中每个入会者的上下行网络质量。默认开启,每2s上报一次。 -
IHRTCConnectionEventHandler eventHandler); 【功能说明】 根据房间ID,创建HRTCConnection对象,为跨房做准备。 通过此接口创建一个与房间关联的HRTCConnection连接对象。 该方法支持多次调用,创建多个HRTCConnection连接对象,调用每个对象
通话质量监测 功能描述 加入频道后,SDK会每隔2秒自动触发通话质量相关的回调,上报当前通话的网络质量、本地和远端的音视频统计信息。 上报接口 通话质量上报 onNetworkQualityNotify回调上报当前通话中每个入会者的上下行网络质量。默认开启,每2s上报一次。 void
事件回调(IHRTCEngineEventHandler) 本章节介绍了Android SDK的回调接口IHRTCEngineEventHandler的详情。 表1 回调接口 接口 描述 onError 错误回调 onJoinRoomSuccess 加入房间成功回调 onJoinRoomFailure
> 0:方法调用失败。具体请参见HRTCErrorCode。 该接口仅支持房间内调用,更改的昵称会被实时同步到房间内其他用户的用户列表,退出房间不会保存,再次加入房间变更为加入房间时设置的昵称(参考joinRoom接口注意事项)。 会触发用户名变更的通知回调onUserNameChangedNotify。
技巧1:基本使用逻辑说明 用时序图展示各端接口使用顺序,单击相应接口可以快速查看相关接口使用方法。 技巧2:接口总览说明 包括SparkRTC接口总体功能流程图和接口列表,根据功能分类可以快速查找具体功能单个接口,方便接口对接。 技巧3:单个接口使用须知 接口使用时注意使用的时机、参数说明。
HRTCAudioSceneType scene) 【功能说明】 设置音频使用场景。该接口需要在joinRoom前调用。 此接口可在create接口设置场景后改变音频场景,暂不支持初始化scene设置音乐再通过此接口设置为会议。 【请求参数】 level:表示档位,会议模式暂时只支持16k。
检测功能 startNetworkTest - (int)startNetworkTest:(HWRtcNetworkTestConfig *_Nonnull)netWorkTestConfig; 【功能说明】 会前网络质量开启测试,房间外调用,要等探测结束后才能加入房间。 【请求参数】
屏幕共享 startScreenShare public abstract int startScreenShare(); 【功能说明】 开启屏幕共享。 【返回参数】 0:成功。 > 0:失败。具体请参见客户端错误码。 Android 5.0及以上版本支持此功能。 使用时,在AndroidManifest
检测功能 startNetworkTest public abstract int startNetworkTest(HRTCNetworkTestConfig networkTestConfig); 【功能说明】 启动入会前网络检测。 【请求参数】 networkTestCon
0:方法调用失败。具体请参见HWRtcErrorCode。 只支持iPhone。 需要先调用setAuxiliaryVideoEncoderConfig接口,设置编码参数。 目前可支持多路辅流共享,若需开启多辅流,请提交工单联系技术支持处理。 共享成功后会触发onScreenShareStarted回调。
HWRtcReplay 表1 HWRtcReplay接口 接口 描述 sharedInstance 生成HWRtcReplay单例对象 setupWithAppGroup 通过appGroup启动HWrtcReplay broadcastFinished 系统录屏结束 sendVideoSampleBuffer
0:方法调用失败。具体请参见HWRtcErrorCode。 该接口仅支持房间内调用,更改的昵称会被实时同步到房间内其他用户的用户列表,退出房间不会保存,再次加入房间变更为加入房间时设置的昵称(参考joinRoom接口注意事项)。 会触发用户名变更通知的回调onUserNameChangedNotify。
具体请参见HRTCVideoAuxiliaryEncParam。 【返回参数】 0:成功。 > 0:失败。具体请参见客户端错误码。 使用该接口设置辅流编码参数时,由于当前系统策略会根据获取的区域宽高比对设置的宽高进行调整,使用户设置的宽高比与获取的宽高比保持一致,因此用户实际收流的分辨率与设置的分辨率可能存在不同。
音频增强管理 enableUserVolumeNotify public abstract int enableUserVolumeNotify(int interval); 【功能说明】 设置音量值上报回调函数(onUserVolumeStatsNotify)的回调周期。 【请求参数】
设备管理 isSpeakerphoneEnabled int isSpeakerphoneEnabled(); 【功能说明】 是否启用扬声器。 【请求参数】 无 【返回参数】 0:不使用扬声器。 1:使用扬声器。 仅支持iOS和Android。 setCameraConfig public