NERTCCallkit Android API  V1.8.0
简介

为了方便开发者快速接入音视频通话 2.0,提升应用的研发效率,音视频通话 2.0 和信令产品携手为您打造应用层组件 NERTCCallkit,组件中集成了音视频通话 2.0 和信令的多项基础功能,全方位提升接入效率。

呼叫组件 NERTCCallkit 依赖网易云信 NERTC SDK 和 NIM SDK(含信令),支持 1v1 和多人视频通话。

  • NERTCVideoCall 接口类包含应用程序调用的主要方法。
  • NERTCCallingDelegate 类用于向应用程序发送用户状态回调通知。

错误码

在调用 NERtcCallKit API 的过程中,组件可能会返回错误码或状态码,您可以根据错误码或状态码判断当前组件或任务的状态。如果遇到未知的错误码,请联系技术支持排查。

NERtcCallKit API 的状态码和错误码如下:

  • 通用错误码:CallErrorCode。
  • 状态码:CallState。

房间管理

方法 功能 起始版本
NERTCVideoCall#setupAppKey() 初始化。使用呼叫组件功能前,必须初始化。 V1.0.0
NERTCVideoCall#call() 开始呼叫。 V1.0.0
NERTCVideoCall#call(String userId, String selfUserId, ChannelType type, String extraInfo, String globalExtraCopy, JoinChannelCallBack joinChannelCallBack) 开始呼叫。通过 globalExtraCopy 参数,设置呼叫时的全局抄送信息。 V1.5.5
NERTCVideoCall#cancel() 取消一对一呼叫 V1.0.0
NERTCVideoCall#accept() 接受呼叫。 V1.0.0
NERTCVideoCall#reject() 拒绝呼叫。 V1.0.0
NERTCVideoCall#hangup() 挂断,同时挂断其他人。 V1.0.0
NERTCVideoCall#hangup(String channelId, int reason, RequestCallback<Void> callback) 通过 reason 参数控制挂断原因,例如实现占线挂断等。

V1.5.5

NERTCVideoCall#leave() 离开,不影响通话中的其他人。 V1.0.0
NERTCVideoCall#getCurrentState() 获取当前组件的通话状态。 V1.0.0
NERTCVideoCall#setupLocalView() 设置本端画布。 V1.0.0
NERTCVideoCall#setupRemoteView() 设置远端画布。 V1.0.0
NERTCVideoCall#enableLocalVideo() 开启/关闭摄像头设备。 V1.0.0
NERTCVideoCall#muteLocalAudio() 开启/关闭音频采集。 V1.0.0
NERTCVideoCall#muteLocalVideo() 开启/关闭视频采集。 V1.0.0
NERTCVideoCall#switchCamera() 切换摄像头。 V1.0.0
NERTCVideoCall#switchCallType() 视频通话/音频通话相互切换。 V1.0.0
NERTCVideoCall#setAudioMute() 禁言指定用户。 V1.0.0
NERTCVideoCall#addDelegate() 添加代理,接收回调。 V1.0.0
NERTCVideoCall#removeDelegate() 移除代理。 V1.0.0
NERTCVideoCall#setTimeOut() 设置呼叫超时时间。在呼叫/被叫前设置生效,可在调用setupAppKey(Context, String, VideoCallOptions)后立即调用 默认时长两分钟。 V1.0.0
NERTCVideoCall#setPushConfigProvider() 设置离线对应信令推送配置。 V1.3.3
NERTCVideoCall#getAccIdByRtcUid() 通过 rtcUid 获取对应的 accId。 V1.4.0
NERTCVideoCall#getRtcUidByAccId() 通过 accId 获取对应的 rtcUid。 V1.4.0

回调接口

事件 描述 起始版本
NERTCCallingDelegate#onInvited() 收到对方邀请。 V1.0.0
NERTCCallingDelegate#onUserEnter() 对方加入通话。 V1.0.0
NERTCCallingDelegate#onRejectByUserId() 对方拒绝邀请。 V1.0.0
NERTCCallingDelegate#onCancelByUserId() 对方取消一对一邀请。 V1.0.0
NERTCCallingDelegate#onUserBusy() 对方忙线。 V1.0.0
NERTCCallingDelegate#onUserLeave() 对方退出群聊房间。 V1.0.0
NERTCCallingDelegate#onUserDisconnect() 用户异常情况断开的回调。 V1.0.0
NERTCCallingDelegate#onUserNetworkQuality() 网络状态回调。 V1.0.0
NERTCCallingDelegate#onCallTypeChange() 音视频通话类型切换的回调,仅限点对点。 V1.0.0
NERTCCallingDelegate#onDisconnect() 音视频断开回调上抛。 V1.0.0
NERTCCallingDelegate#timeOut() 邀请超时。 V1.0.0
NERTCCallingDelegate#onCameraAvailable() 开启/关闭相机。 V1.0.0
NERTCCallingDelegate#onAudioAvailable() 开启/关闭麦克风。 V1.0.0
NERTCCallingDelegate#onCallEnd() 通话结束。 V1.0.0
NERTCCallingDelegate#onError() 错误回调。 V1.0.0
NERTCCallingDelegate#onAudioMuted() 对端是否开启/关闭音频采集。 V1.0.0
NERTCCallingDelegate#onVideoMuted() 对端是否开启/关闭视频采集。 V1.0.0
NERTCCallingDelegate#onFirstVideoFrameDecoded() 首帧解码成功的回调。 V1.2.0
NERTCCallingDelegate#onJoinChannel() 本端加入音视频房间回调。 V1.3.0