事件名
回调方法
调节本地播放的某个房间的所有用户的信号音量。
详情描述:通过此接口可以实现在通话过程中随时调节本地播放的某个房间的所有用户的混音音量。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
播放音量,取值范围为 [0,400]
调整共享音频音量。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
播放音量。取值范围为 [0, 400]。其中:
调节采集信号音量。
详情描述:通过本接口可以实现设置录制声音的信号幅度,从而达到调节采集音量的目的。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
相关回调:
相关接口:
采集信号音量,取值范围为 0 ~ 400。:
调节本地播放的指定远端用户的信号音量。
详情描述:通过此接口可以实现在通话过程中随时调节本地播放的指定远端用户的混音音量。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
远端用户 ID
设置要展示的对端具体成员的字符串格式的userID,用户如果业务上要求userID需要超过number的范围时可以使用
播放音量,取值范围为 [0,100]
销毁 NERtc 实例,释放资源。
详情描述:该方法释放 NERTC SDK 使用的所有资源。有些 App 只在用户需要时才进行实时音视频通信,完成音视频通话后,则将资源释放出来用于其他操作,该方法适用于此类情况。。
调用时机:该接口需要在调用 NERTC.leaveChannel、并收到 NERtcCallback.onUserLeave 回调后调用。或收到 NERtcCallback.onDisconnect 回调、重连失败时调用此接口销毁实例,并释放资源。
void
销毁本地视频辅流的视图。
详情描述:通过本接口可以实现解绑本地视频辅流用户和显示视图。
销毁本地用户视图。
详情描述:通过本接口可以实现解绑本地用户和显示视图。
销毁远端用户视频辅流视图。
详情描述:通过本接口可以实现解绑远端用户和显示视图。
设置视频画布的参数
设置要展示的对端具体成员的userID。
设置要展示的对端具体成员的字符串格式的userID,用户如果业务上要求userID需要超过number的范围时可以使用。
销毁远端用户视图。
详情描述:通过本接口可以实现解绑远端用户和显示视图。
设置本地视频画布的参数。
设置要展示的对端具体成员的userID。
设置要展示的对端具体成员的字符串格式的userID,用户如果业务上要求userID需要超过number的范围时可以使用。
启用说话者音量提示。
详情描述:通过此接口可以实现允许 SDK 定期向 App 反馈房间内发音频流的用户和瞬时音量最高的远端用户(最多 3 位,包括本端)的音量相关信息,即当前谁在说话以及说话者的音量。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
业务场景: 适用于通过发言者的人声相关信息做出 UI 上的音量展示的场景,或根据发言者的音量大小进行视图布局的动态调整。
相关回调:
是否启用说话者音量提示
是否启用本地采集人声监测
指定音量提示的时间间隔。单位为毫秒。必须设置为 100 毫秒的整数倍值,建议设置为 200 毫秒以上。
设置是否开启耳返功能。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
是否开启耳返功能
设置耳返音量。取值范围为 0 ~ 100,默认值为 100。
开启或关闭本地音频的采集和发送。
详情描述:通过本接口可以实现开启或关闭本地语音功能,进行本地音频采集及处理。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
业务场景: 适用于通过发言者的人声相关信息做出 UI 上的音量展示的场景,或根据发言者的音量大小进行视图布局的动态调整。
相关回调:
开启或关闭本地视频的采集与发送。
详情描述:通过本接口可以实现开启或关闭本地视频,不影响接收远端视频。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
业务场景: 适用于通过发言者的人声相关信息做出 UI 上的音量展示的场景,或根据发言者的音量大小进行视图布局的动态调整。
相关回调:
启用本地video参数
是否开启本地视频采集与发送: - true:启用本地视频采集。 - false:关闭本地视频采集。
视频类型:
是否开启音频共享。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
是否开启。
开启或关闭本地媒体流(主流)的发送。
详情描述:该方法用于开始或停止向网络发送本地音频或视频数据。 该方法不影响接收或播放远端媒体流,也不会影响本地音频或视频的采集状态。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
是否发布本地音频流
获取当前房间连接状态。
调用时机:请在初始化后调用该方法。
用于检查当前APP是否配置启动了某些服务。
详情描述:安卓端专用,用于检查当前APP是否配置启动了某些服务(比如前台服务)。
调用时机:请在初始化后调用该方法。
要检查了安卓服务类型
加入音视频房间。
详情描述:通过本接口可以实现加入音视频房间,加入房间后可以与房间内的其他用户进行音视频通话。
调用时机:请在初始化引擎后调用该方法。
使用限制:无。
相关接口:
相关回调:
加入房间时的参数。
房间名称,设置相同房间名称的用户会进入同一个通话房间。 - 字符串格式,长度为 1 ~ 64 字节。
用户的唯一标识 ID。
安全认证签名(NERTC Token),可以设置为: - ''。调试模式下可设置为 null。安全性不高,建议在产品正式上线前在云信控制台中将鉴权方式恢复为默认的安全模式。
离开音视频房间。
详情描述:通过本接口可以实现挂断或退出通话,并释放本房间内的相关资源。
调用时机:请在初始化并成功加入房间后调用该方法。
相关回调:
开启或关闭本地音频主流的发送。
详情描述:该方法用于向网络发送或取消发送本地音频数据,不影响本地音频的采集状态,也不影响接收或播放远端音频流。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
相关回调:
是否关闭本地音频的发送: - true:不发送本地音频。 - false:发送本地音频。
取消或恢复发布本地视频。
详情描述:调用该方法取消发布本地视频主流或辅流后,SDK 不再发送本地视频流。
调用时机:一般在通过 NERTC.enableLocalVideo 接口开启本地视频采集并发送后调用该方法。
业务场景: 适用于通过发言者的人声相关信息做出 UI 上的音量展示的场景,或根据发言者的音量大小进行视图布局的动态调整。
相关回调:
是否取消发布本地视频流:
原生插件日志接口。
详情描述:原生java暴露的日志输出接口,可以输入到android Studio/xcode的控制台,以及写入手机日志文件中。
调用时机:开发者js开发语言的业务console日志需要存入系统日志文件时。
要打印的日志log
重新播放对端的音频流。
远端的用户ID
移除所有的注册的回调事件。
移除事件回调。
事件名
回调方法
监测到自动播放受限后,重新播放音视频流。
远端的用户ID
设置音频编码属性。
详情描述:通过此接口可以实现设置音频编码的采样率、码率、编码模式、声道数等,也可以设置音频属性的应用场景,包括聊天室场景、语音场景、音乐场景等。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
设置本地音频的编码参数。
设置音频的编码模式。
音频场景场景。
设置房间场景。
详情描述:通过此接口可以实现设置房间场景为通话(默认)或直播场景。针对不同场景采取的优化策略不同,如通话场景侧重语音流畅度,直播场景侧重视频清晰度。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间前调用。
加入房间时的参数
设置直播场景下的用户角色。
详情描述:通过此接口可以实现设置房间场景为通话(默认)或直播场景。针对不同场景采取的优化策略不同,如通话场景侧重语音流畅度,直播场景侧重视频清晰度。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间前调用。
使用限制:该方法仅在通过 setChannelProfile() 方法设置房间场景为直播场景(LIVE_BROADCASTING)时调用有效。
业务场景:适用于观众上下麦与主播互动的互动直播场景。
注意事项:用户切换为观众角色时,SDK 会自动关闭音视频设备。
相关回调:
用户角色
设置耳返音量。
调用时机:调用 NERTC.enableEarback 方法开启耳返功能之后,您可以调用 NERTC.setEarbackVolume 方法设置耳返音量。
设置耳返音量,可设置为 0~100,默认为 100。
设置视频编码属性。
详情描述:通过此接口可以设置视频主流或辅流的编码分辨率、裁剪模式、码率、帧率、带宽受限时的视频编码降级偏好、编码的镜像模式、编码的方向模式参数。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
设置视频画布的参数
设置的视频码率。
设置视频视频裁剪模式。
设置带宽受限时的视频编码降级偏好。
设置的视频帧率。
设置视频帧在纵轴上的像素,即自定义高。
设置的视频配置项。
设置的视频最小码率。
设置的视频最小帧率。
设置视频镜像模式。
设置适应视频,视频尺寸等比缩放。
设置的视频类型。
设置视频帧在横轴上的像素,即自定义宽。
设置音视频通话的相关参数。
详情描述:此接口提供技术预览或特别定制功能(比如AI降噪功能),详情请咨询技术支持或者开发者文档。
调用时机:请在初始化后调用该方法,且该方法在加入房间前后均可调用。
使用限制:无
业务场景:适用于需要开启SDK特殊功能。
要开启的配置项
设置是否由扬声器播放声音。
详情描述:通过本接口可以实现设置是否将语音路由到扬声器,即设备外放。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
是否将音频路由到扬声器
统计信息观测。
详情描述:注册统计信息观测器,设置统计信息回调。
调用时机:请在初始化后调用该方法。
相关回调:
是否开启统计信息的监听器:
创建 NERtc 实例。
详情描述:创建 NERtc 实例。 通过本接口可以实现创建 NERtc 实例并初始化 NERTC SDK 服务。
业务场景:是使用NERtc服务的前提。
调用时机:请确保在调用其他 API 前先调用该方法创建并初始化 NERtc 实例。
创建NERTC引擎时的参数
SDK日志log文件的路径,可以传递为''
SDK日志log等级
设置本端用户的视频辅流画布。
详情描述:通过此接口可以实现设置本端用户的辅流显示视图。
调用时机:请在初始化后调用该方法,且该方法在加入房间前后均可调用。
使用限制:无。
设置本地视频辅流画布的参数。
设置视频View是否在Z轴上覆盖。
设置视频镜像模式。
设置适应视频,视频尺寸等比缩放。
设置本地用户视图。
详情描述:通过本接口可以实现绑定本地用户和显示视图,并设置本地用户视图在本地显示时的镜像模式和裁减比例,只影响本地用户看到的视频画面。
调用时机:请在初始化后调用该方法,且该方法在加入房间前后均可调用。
使用限制:无。
设置本地视频画布的参数。
设置视频View是否在Z轴上覆盖。
设置视频镜像模式。
设置适应视频,视频尺寸等比缩放。
设置远端用户的视频辅流视图。
详情描述:通过本接口可以实现绑定远端用户和显示视图,并设置远端用户视图在本地显示时的镜像模式和裁减比例,只影响本地用户看到的视频画面。
调用时机:请在初始化后调用该方法,且该方法在加入房间前后均可调用。
设置本地视频画布的参数。
设置视频View是否在Z轴上覆盖。
设置视频镜像模式。
设置适应视频,视频尺寸等比缩放。
设置要展示的对端具体成员的userID。
设置远端用户视图。
详情描述:通过本接口可以实现绑定远端用户和显示视图,并设置远端用户视图在本地显示时的镜像模式和裁减比例,只影响本地用户看到的视频画面。
调用时机:请在初始化后调用该方法,且该方法在加入房间前后均可调用。
设置本地视频画布的参数。
设置视频View是否在Z轴上覆盖。
设置视频镜像模式。
设置适应视频,视频尺寸等比缩放。
设置要展示的对端具体成员的userID。
设置要展示的对端具体成员的字符串格式的userID,用户如果业务上要求userID需要超过number的范围时可以使用。
开启视频预览。
详情描述:通过本接口可以实现在加入房间前启动本地视频预览,支持预览本地摄像头或外部输入视频。
调用时机:请在初始化后调用该方法,且该方法仅可当不在房间内时可调用。
业务场景:适用于加入房间前检查设备状态是否可用、预览视频效果等场景。
使用限制:
设置本地视频画布的参数。
开启屏幕共享。
详情描述:通过此接口开启屏幕共享后,屏幕共享内容以视频辅流的形式发送。
调用时机:请在引擎初始化之后调用此接口,且该方法仅可在加入房间后调用。
相关回调:
设置屏幕共享画布的参数。
设置本地视频画布的参数。
关闭屏幕共享。
详情描述:通过此接口可以实现关闭屏幕共享辅流。
相关回调:
订阅或取消订阅远端用户的视频辅流。
详情描述:加入房间后,默认不订阅所有远端用户的视频辅流;若您希望看到指定远端用户的视频辅流,可以在监听到对方加入房间或发布视频辅流之后,通过此方法订阅该用户的视频辅流。
调用时机:
相关回调:
启用本地video参数
视频类型:
是否取消发布本地视频流: - true:取消发布本地视频辅流。 - false:恢复发布本地视频辅流。
对端userID:
对端具体成员的字符串格式的userID,用户如果业务上要求userID需要超过number的范围时可以使用
订阅或取消订阅指定远端用户的视频主流。
详情描述:加入房间后,默认不订阅所有远端用户的视频主流;若您希望看到指定远端用户的视频,可以在监听到对方加入房间或发布视频流之后,通过此方法订阅该用户的视频主流。
调用时机:请在初始化后调用该方法,且该方法仅可在加入房间后调用。
业务场景: 适用于通过发言者的人声相关信息做出 UI 上的音量展示的场景,或根据发言者的音量大小进行视图布局的动态调整。
相关回调:
启用本地video参数
视频类型:
是否订阅远端用户的视频流 - true:订阅指定视频流。 - false:不订阅指定视频流。
指定用户的 ID
对端具体成员的字符串格式的userID,用户如果业务上要求userID需要超过number的范围时可以使用
切换前置或后置摄像头。
详情描述:该方法用于向网络发送或取消发送本地音频数据,不影响本地音频的采集状态,也不影响接收或播放远端音频流。
调用时机:请在调用 NERTC.startPreview 或 NERTC.joinChannel 方法且开启摄像头之后调用此接口。
上传 SDK 信息。
详情描述:上传的信息包括 log 和 Audio dump 等文件。
调用时机:只能在加入房间后调用。
添加事件回调。
5.3.7 及以上。