NERTC Miniapp SDK for WeChat API Reference
NERTC mini SDK提供基于网络的视频通话和语音通话功能,支持在微信小程序中调用API快速建立音视频连接,进行音视频通话和推流的服务。
基本API文档
YunXinMiniappSDK 是基础对象,是所有可调用方法的入口
Client 是客户端对象,负责通话中的本地或远程用户的核心操作。
Client对象的基础方法
NERTC Miniapp SDK for Wechat 的 Client 方法提供 NERTC 的核心功能,包含如下 API:
方法 | 功能描述 | 起始版本 |
---|---|---|
Client.init | 初始化对象 | 4.0.0 |
Client.setRole | 设置用户角色 | 4.2.0 |
Client.join | 加入音视频频道 | 4.0.0 |
Client.leave | 离开音视频频道 | 4.0.0 |
Client.publish | 发布音视频流 | 4.0.0 |
Client.unpublish | 取消发布音视频流 | 4.0.0 |
Client.subscribe | 接收远端音视频流 | 4.0.0 |
Client.unsubscribe | 取消接收远端音视频流 | 4.0.0 |
Client.mute | 停止发送本地音视频流 | 4.1.0 |
Client.unmute | 停止发送本地音视频流 | 4.1.0 |
Client.setVoiceBeautifierPreset | 设置本地上行美声效果 | 4.6.0 |
Client.setAudioEffectPreset | 设置本地上行变声效果 | 4.6.0 |
Client.setLocalVoicePitch | 调整本地上行语音音调 | 4.6.0 |
Client.setLocalVoiceEqualization | 调整本地上行语音音效均衡 | 4.6.0 |
Client.addTasks | 添加推流任务 | 4.6.0 |
Client.updateTasks | 更新推流任务 | 4.6.0 |
Client.deleteTasks | 删除推流任务 | 4.6.0 |
Client.startAsrCaptions | 开启字幕&翻译 | 4.7.1 |
Client.stopAsrCaptions | 关闭字幕&翻译 | 4.7.1 |
Client.aiManualInterrupt | 打断字幕&翻译 | 4.7.1 |
Client.on | 监听事件 | 4.0.0 |
Client.off | 取消监听事件 | 4.0.0 |