点对点音视频通话

点对点音视频通话功能包含点对点的音频通话和点对点的音视频通话,提供呼叫接听挂断话单通知等功能。通过阅读该章节,您可以快速了解点对点实时音视频通话的流程,帮助您迅速搭建一个最简单的点对点实时音视频通话功能。

呼叫/接听流程

sequenceDiagram 主叫->>被叫: 主叫发起通话请求(nim_vchat_start) 被叫->>被叫: 被叫收到通话请求回调(nim_vchat_cb_func kNIMVideoChatSessionTypeInviteNotify) 被叫->>主叫: 被叫响应通话请求(nim_vchat_callee_ack) 被叫->>被叫: 呼入的通话已经被该帐号其他端处理回调(nim_vchat_cb_func kNIMVideoChatSessionTypeSyncAckNotify) 主叫->>主叫: 主叫收到被叫响应回调(nim_vchat_cb_func kNIMVideoChatSessionTypeCalleeAckNotify) 主叫->>主叫: 通话建立成功(nim_vchat_cb_func kNIMVideoChatSessionTypeConnect) 被叫->>被叫: 通话建立成功(nim_vchat_cb_func kNIMVideoChatSessionTypeConnect)

主叫发起通话请求

API介绍
发起一个音视频网络通话。
API原型
参数说明
参数 类型 说明
mode enum 音视频通话类型,音频或音视频
apns_text string 推送文本,推送给手机显示
custom_info string 自定义信息,带给接收方
json_info string Json string 扩展,音视频通话的扩展参数设置
参数 类型 说明
mode enum 音视频通话类型,音频或音视频
apns_text string 推送文本,推送给手机显示
info Json json扩展封装类,见NIMVChatInfo
customInfo string 自定义信息,带给接收方
参数 类型 说明
mode enum 音视频通话类型,音频或音视频
apns_text string 推送文本,推送给手机显示
custom_info string 自定义信息,带给接收方
json_extension string Json string 扩展,音视频通话的扩展参数设置
user_data void* 无效扩展
返回值说明

返回一个bool类型值。若调用成功返回true,否则返回false。一般失败是由于有正在进行的通话导致。

示例
特殊说明

在通话发起时,应该设置一个定时器,用于在通话建立前等待超时时能主动结束通话。

扩展参数全在NIMVChatInfo info中,发起结果回调见NIMVChatSessionStatus.onSessionStartRes

扩展参数见音视频相关扩展发起参数,发起结果回调见nim_vchat_cb_func,返回类型NIMVideoChatSessionType::kNIMVideoChatSessionTypeStartRes

被叫收到通话请求回调

API介绍

收到一个点对点音视频通话的邀请。由注册通话事件后,在回调中区分。

API原型
参数说明
参数 类型 说明
channel_id long 频道id
uid string 邀请者uid
mode int 通话类型
time long 时间戳(毫秒级)
customInfo string 自定义信息
参数 类型 说明
type enum 回调类型kNIMVideoChatSessionTypeInviteNotify
channel_id int64 频道id
code int 无效错误码
json_extension string Json string 扩展,返回kNIMVChatUid发起者,kNIMVChatType对应NIMVideoChatMode, kNIMVChatTime, kNIMVChatCustomInfo
user_data void* 注册回调时的APP自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理
示例

被叫响应通话请求

API介绍

通知邀请方自己的处理结果。如果已有通话存在,需要结束已有通话才能接听新的通话。

API原型
参数说明
参数 类型 说明
channel_id uint64_t 频道id
accept bool 是否接听
json_extension string Json string 扩展,音视频通话的扩展参数设置
参数 类型 说明
channel_id long 频道id
accept bool 是否接听
info Json json扩展封装类,见NIMVChatInfo
参数 类型 说明
channel_id uint64_t 频道id
accept bool 是否接听
json_extension string Json string 扩展,音视频通话的扩展参数设置
user_data void* 无效扩展
返回值说明

返回一个bool类型值。若调用成功返回true,否则返回false。

示例
特殊说明

在通话接听时,应该设置一个定时器,用于在通话建立前等待超时时能主动结束通话。

主叫收到被叫响应回调

API介绍

收到被叫方响应的回调信息通知。由注册通话事件后,在回调中区分。

API原型
参数说明
参数 类型 说明
channel_id long 频道id
uid string 被邀请者uid
mode int 通话类型
accept bool 是否接听
参数 类型 说明
type enum 回调类型kNIMVideoChatSessionTypeCalleeAckNotify
channel_id int64 频道id
code int 无效错误码
json_extension string Json string 扩展,返回kNIMVChatUid被邀请者,kNIMVChatType对应NIMVideoChatMode, kNIMVChatAccept
user_data void* 注册回调时的APP自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理
示例

呼入的通话已经被该帐号其他端处理回调

API介绍

收到本人在别的端响应的回调通知。由注册通话事件后,在回调中区分。

API原型
参数说明
参数 类型 说明
channel_id long 频道id
uid string 无效
mode int 通话类型
accept bool 是否接听
time long 时间戳(毫秒级)
client int 处理响应的客户端类型
参数 类型 说明
type enum 回调类型kNIMVideoChatSessionTypeSyncAckNotify
channel_id int64 频道id
code int 无效错误码
json_extension string Json string 扩展,返回 kNIMVChatTime,kNIMVChatType对应NIMVideoChatMode,kNIMVChatAccept,kNIMVChatClient
user_data void* 注册回调时的APP自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理
示例
    private static void OnSessionSyncAckNotify(channel_id,code,uid,  mode, accept,  time, client)
    {
        EndDevices();
        if (code == 200)
        {
            Action action = () =>
            {
                MessageBox.Show("已在其他端接听");

                MainForm.VideoChatForm vform = MainForm.VideoChatForm.GetInstance();
                if (vform != null)
                {
                    vform.Close();
                }
            };
            _ownerFriendsListForm.Invoke(action);
        }
    }

通话建立成功

API介绍

通话在对方接听后,双方底层都开始建立连接,以对方加入通话为通话建立成果的标记。

API原型
参数说明
参数 类型 说明
channel_id long 频道id
code int 状态码
record_file string 服务器录制的音频文件名
video_record_file string 服务器录制的视频文件名
uid string 对方id
status int 成员状态,离开、加入等

连接状态:

参数 类型 说明
type enum 回调类型kNIMVideoChatSessionTypeConnect
channel_id int64 频道id
code int 错误码NIMVChatConnectErrorCode,200代表连接成功
json_extension string Json string 扩展,如果成功返回 kNIMVChatVideoRecordFile和kNIMVChatRecordFile
user_data void* 注册回调时的APP自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理

对端进出:

参数 类型 说明
type enum 回调类型kNIMVideoChatSessionTypePeopleStatus
channel_id int64 频道id
code int 状态码,对应NIMVideoChatSessionStatus
json_extension string Json string 扩展,返回kNIMVChatUid,如果是离开带kNIMVChatStatus对应NIMVideoChatUserLeftType
user_data void* 注册回调时的APP自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理
示例
特殊说明

在主叫发起通话和被叫收到邀请后,都应该创建一个定时器,当通话建立超时时,应该按创建失败的流程结束通话。

挂断流程

sequenceDiagram 主叫->>被叫: 结束通话(nim_vchat_end) 被叫->>被叫: 收到对方结束通话回调(nim_vchat_cb_func kNIMVideoChatSessionTypeHangupNotify) 被叫->>被叫: 通话断开(nim_vchat_cb_func kNIMVideoChatSessionTypeConnect) 被叫->>被叫: 话单通知(nim_talk_receive_cb_func) 主叫->>主叫: 通话断开(nim_vchat_cb_func kNIMVideoChatSessionTypeConnect) 主叫->>主叫: 话单通知(nim_talk_receive_cb_func)

结束通话

API介绍

需要在通话结束时调用,用于底层挂断和清理数据,如果是自己主动结束会通知对方。

API原型
参数说明

需要带上session_id。用于关闭对应的通话。

参数 类型 说明
json_extension string Json string 扩展,kNIMVChatSessionId
参数 类型 说明
jsonExtension string Json string 扩展,kNIMVChatSessionId
参数 类型 说明
json_extension string Json string 扩展,kNIMVChatSessionId
返回值说明

无返回值。

示例
特殊说明

主动结束会返回hangup调用结果的回调通知,对于已经建立连接的通话,结束后返回connect的回调通知,code=1001(kNIMVChatConnectLogout)

收到对方结束通话回调

API介绍

对端主动结束通话,另一端会收到挂断通知。

API原型
参数说明
参数 类型 说明
channel_id long 频道id
code int 错误码
参数 类型 说明
type enum 回调类型kNIMVideoChatSessionTypeHangupNotify
channel_id int64 频道id
code int 错误码
json_extension string 无效 Json string 扩展
user_data void* 注册回调时的APP自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理
示例

通话断开

API介绍

在通话建立后,会有connect的通知,告知200的成功状态。之后connect返回非200都代表通话断开。

API原型
参数说明
参数 类型 说明
channel_id long 频道id
code int 状态码
record_file string 服务器录制的音频文件名
video_record_file string 服务器录制的视频文件名
参数 类型 说明
type enum 回调类型kNIMVideoChatSessionTypeConnect
channel_id int64 频道id
code int 错误码NIMVChatConnectErrorCode,200代表连接成功
json_extension string Json string 扩展,如果成功返回 kNIMVChatVideoRecordFile和kNIMVChatRecordFile
user_data void* 注册回调时的APP自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理
示例
特殊说明

大部分因为网络原因导致的通话断开,都会在连接超时后返回connect通知,并且这个超时和IM的账号登陆长链接无关联。

话单通知

API介绍

在一通通话结束后,会返回一个通话话单,以IM自定义系统消息的形式发出。

API原型
参数说明
参数 类型 说明
json_extension string json 扩展
cb function 音视频通话回调接口
user_data void* APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理
示例
特殊说明

通过IM消息中的系统通知,得到对应的attach,话单详情可以参考C代码示例中的attach解析。