rtc
检测功能
更新时间:2021/01/07 GMT+08:00
startNetworkTest
startNetworkTest(config: HRTCNetworkTestConfig): number
【功能说明】
开始通话前网络质量探测。
【请求参数】
- config:必选,HRTCNetworkTestConfig类型, 网络探测选项。
- HRTCNetworkTestConfig: {
- userId:必选,string类型,本地用户ID。
- roomId:必选,string类型,需要加入的房间ID。
- signature:可选,string类型,认证用的签名。 如果开启了签名认证,则必选。
- ctime:可选,number类型,签名有效时间的时间戳。 如果开启了签名认证,则必选。
- enableUplinkTest:必选,number类型,是否开启上行网络探测。1为开启,0为不开启。
- enableDownlinkTest:必选,number类型,是否开启下行网络探测。 1为开启,0为不开启。
- expectedUplinkBitrate:必选,number类型,用户期望的最大上行码率,单位bps。 范围为0 | [100000, 5000000],其中0表示由SDK指定最高码率。
- expectedDownlinkBitrate:必选, number类型,用户期望的最大下行码率,单位bps。 范围为0 | [100000, 5000000],其中0表示由SDK指定最高码率。
【返回参数】
number类型,0表示调用成功,其它值表示调用失败。
【注意事项】
- 开启通话前的网络探测,如果需要发起RTC通话,需要先调用stopNetworkTest将网络探测关闭。
- 开启通话前的网络探测, 会定期有networkTestResult事件上报,直到探测完成。
- 探测完成后,会上报networkTestQuality事件。
number类型,0表示调用成功,其它值表示调用失败。
父主题: HRTCEngine
