NECallkit SDK V4.8.2
载入中...
搜索中...
未找到
NECallkit SDK

为了方便您接入 音视频通话 2.0(NERTC) 的呼叫功能,网易云信将信令和 NERTC 的音视频能力相结合,简化呼叫的复杂流程,将呼叫功能以组件的形式(NERTCCallkit)提供给客户,提高接入效率、降低使用成本。

呼叫组件 NERTCCallkit 核心接口的类包括:

  • NECallEngine 接口类包含应用程序调用的主要方法。
  • NEGroupCall 接口类包含群组通话功能调用的主要方法。
  • NECallEngineDelegate 类用于向应用程序发送用户状态回调通知。

在调用 SDK API 的过程中,如果遇到问题,请 提交工单 联系网易云信技术支持工程师排查。

群组呼叫

接口 功能描述 起始版本
NEGroupCall.groupCall() 多人音视频呼叫 V3.0.0
NEGroupCall.groupHangup() 挂断 V3.0.0
NEGroupCall.groupAccept() 接受呼叫邀请 V3.0.0
NEGroupCall.groupInvite() 邀请他人加入多人通话 V3.0.0
NEGroupCall.groupJoin() 主动加入多人通话 V3.0.0
NEGroupCall.groupQueryCallInfo() 查询多人通话信息 V3.0.0
NEGroupCall.groupQueryMembers() 查询多人通话成员列表 V3.0.0
NEGroupCall.init() 多人通话设置 V3.0.0
NEGroupCall.addGroupCallDelegate() 添加代理接受回调 V3.0.0

呼叫主流程

接口 功能描述 起始版本
NECallEngine.sharedInstance() 获取 NECallKit 实例 V2.0.0
NECallEngine.setup() 呼叫组件初始化 V2.0.0
NECallEngine.destroy() 呼叫组件销毁 V2.0.0
NECallEngine.call() 发起呼叫 V2.0.0
NECallEngine.accept() 被叫接听 V2.0.0
NECallEngine.hangup() 挂断通话 取消通话 拒接来电 V2.0.0

单呼转群呼

接口 / 回调 功能描述 起始版本
NECallEngine.inviteMembers() 通话中邀请成员加入当前通话,支持 1v1 已接通后转为多人通话 V4.7.0
NECallEngine.currentMembers() 获取当前通话完整成员快照,包含已加入和待接听成员 V4.7.0
NECallEngine.isInMultiCall() 判断当前通话是否已经进入过多人模式 V4.7.0
NECallEngine.canInviteMembers() 判断当前通话是否允许继续邀请成员,可用于展示邀请入口 V4.7.0
NECallMultiDelegate.onCallModeChanged() 通话首次从单呼模式进入多人模式时回调 V4.7.0
NECallMultiDelegate.onCallMembersChanged() 通话成员变化回调,通知成员加入、离开、状态或媒体状态变化 V4.7.0
NECallMultiDelegate.onCallInviteStateChanged() 本端发出的通话中邀请生命周期变化回调 V4.7.0

呼叫配置

接口 功能描述 起始版本
NECallEngine.switchCallType() 在通话过程中切换通话类型 V2.0.0
NECallEngine.setTimeout() 配置通话接听的超时时间(主/被叫都生效) V2.0.0
NECallEngine.setupLocalView() 设置本端画布 V2.0.0
NECallEngine.setupRemoteView() 设置远端画布 V2.0.0
NECallEngine.enableLocalVideo() 启动或关闭摄像头 V2.0.0
NECallEngine.muteLocalVideo() 开启或关闭视频采集 V2.0.0
NECallEngine.muteLocalAudio() 开启或关闭麦克风静音 V2.0.0
NECallEngine.setCallRecordProvider() 自定义话单配置 V2.0.0
NECallEngine.switchCamera() 切换前后摄像头 V2.0.0
NECallEngine.setCallConfig() 设置呼叫时的配置参数,切换音视频是否需要切换,信令消息是否支持离线等 V2.0.0
NECallEngine.addCallDelegate() 设置回调监听 V2.0.0
NECallEngine.removeCallDelegate() 移除回调监听 V2.0.0

获取状态信息

接口 功能描述 起始版本
NECallEngine.getCallInfo() 通话过程中获取通话信息 V2.0.0
NECallEngine.getCallConfig() 获取呼叫时的配置参数 V2.0.0

回调

事件 功能描述 起始版本
NECallEngineDelegate.onReceiveInvited() 来电监听 V2.0.0
NECallEngineDelegate.onCallEnd() 通话被取消、拒绝、通话中挂断,即所有导致通话结束的行为都会触发此回调 V2.0.0
NECallEngineDelegate.onCallConnected() 主被叫加入通道,通话建立后触发 V2.0.0
NECallEngineDelegate.onCallTypeChange() 音视频切换 V2.0.0
NECallEngineDelegate.onVideoAvailable() 启用/禁用视频采集 V2.0.0
NECallEngineDelegate.onVideoMuted() 视频采集变更回调 V2.0.0
NECallEngineDelegate.onAudioMuted() 音频采集变更回调 V2.0.0