NERTCCallkit iOS API  V1.8.0
简介

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

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

错误码

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

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

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

1对1呼叫

方法 功能 起始版本
NERtcCallKit#setupAppKey:options: 初始化。使用呼叫组件功能前,必须初始化。 V1.0.0
NERtcCallKit#call:type:attachment:completion: 开始呼叫。 V1.0.0
NERtcCallKit#call:type:attachment:globalExtra:withToken:channelName:completion: 开始呼叫。通过 globalExtraCopy 参数,设置呼叫时的全局抄送信息。 V1.5.5
NERtcCallKit#cancel: 取消一对一呼叫 V1.0.0
NERtcCallKit#accept: 接受呼叫。 V1.0.0
acceptWithToken:withCompletion: 呼叫时传入 rtc token。 V1.5.7
NERtcCallKit#reject: 拒绝呼叫。

V1.0.0

NERtcCallKit#hangup: 挂断,同时挂断其他人。 V1.0.0
NERtcCallKit#leave: 离开,不影响通话中的其他人。 V1.0.0
NERtcCallKit#getCurrentState: 获取当前组件的通话状态。 V1.0.0
NERtcCallKit#setupLocalView: 设置本端画布。 V1.0.0
NERtcCallKit#setupRemoteView:forUser: 设置远端画布。 V1.0.0
NERtcCallKit#enableLocalVideo: 开启/关闭摄像头设备。 V1.0.0
NERtcCallKit#muteLocalAudio: 开启/关闭音频采集。 V1.0.0
NERtcCallKit#muteLocalVideo: 开启/关闭视频采集。 V1.0.0
NERtcCallKit#switchCamera 切换摄像头。 V1.0.0
NERtcCallKit#switchCallType:withState:completion: 视频通话/音频通话相互切换。 V1.0.0
NERtcCallKit#setAudioMute:forUser:error: 禁言指定用户。 V1.0.0
NERtcCallKit#addDelegate: 添加代理,接收回调。 V1.0.0
NERtcCallKit#removeDelegate: 移除代理。 V1.0.0

回调接口

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