多人音频通话

本章节介绍多人实时音频通话的相关功能。多人实时音频通话顾名思义是支持多个人同时进行实时音频通话,Cocos SDK目前仅支持纯音频模式。在这里需要明确几个概念: 房间:房间就是用户进行多人实时音频通话的地方,房间以房间名称为唯一标识,多人房间需要先创建成功后才能加入,当所有用户都离开房间后,可以复用该房间名重新创建。 互动者:互动者是指在多人通话时可以参与互动,可以发言的人,这些用户可以发送上行的音频,也可以接收其他互动者下行的音频。 观众:观众是指在多人通话时只可以观看的人,没有发言的权限,这些用户只可以接收互动者下行的音频,不可以发送上行音频。 其中互动者和观众身份可以随时切换。

多人音频通话流程

sequenceDiagram participant Meeting participant 成员 participant ... Meeting->>Meeting:创建多人房间(nim_vchat_create_room) 成员->>Meeting:加入多人房间(nim_vchat_join_room) Meeting->>成员: 通话建立(nim_vchat_cb_func kNIMVideoChatSessionTypeConnect code = 200) Meeting->>成员:其他成员进出房间通知(nim_vchat_cb_func kNIMVideoChatSessionTypePeopleStatus) 成员->>Meeting:离开多人房间(nim_vchat_end) Meeting->>成员: 通话断开(nim_vchat_cb_func kNIMVideoChatSessionTypeConnect code != 200)

预定会议

API介绍

根据房间名,创建一个多人会议房间。创建后的房间需要有人加入后才会实际产生话单。

API原型

static void CreateRoom(const std::string& room_name, const std::string& custom_info, const std::string& json_extension, Opt2Callback cb);

File:nim_cpp_vchat.h

参数说明
参数 类型 说明
room_name string 房间名
custom_info string 自定义信息,所有加入房间的成员都会收到此信息
json_extension string 无效扩展字段
cb Opt2Callback 回调函数

返回值说明

无返回值。

示例
void test_crate_room(string room_name)
{
    auto cb = [=](int code, std::int64_t channel_id, const std::string& json_extension)
    {

    };
    nim::VChat::CreateRoom(room_name, custom_info, json_extension, cb);
}
特殊说明

返回错误码中417说明已经存在同名的房间,如果是目标房间议,则可以直接走后面流程加入此房间。如果不是希望创建的目标房间,则需要重新设定房间名后再创建。

加入会议

API介绍

加入一个房间。所有音频相关通话都是互斥,只允许存在一个,并且加入前必选预先创建房间。

API原型

static bool JoinRoom(NIMVideoChatMode mode, const std::string& room_name, const std::string& json_extension, Opt2Callback cb)

File:nim_cpp_vchat.h

参数说明
参数 类型 说明
mode enum 音视频通话类型,仅支持音频通话类型,见nim_vchat_def.h
room_name string 房间名
json_extension string 扩展,音频通话的扩展参数设置
cb function 结果回调
示例
void test_join_room(string room_name)
{
    auto cb = [=](int code, std::int64_t channel_id, const std::string& json_extension)
    {

    };
    nim::VChat::JoinRoom(kNIMVideoChatModeAudio, room_name, json_extension, cb);
}

离开会议

API介绍

需要在结束时调用,用于底层挂断和清理数据。

API原型

static void End(const std::string& json_extension);

File:nim_cpp_vchat.h

参数说明
参数 类型 说明
json_extension 无效拓展参数
示例
nim::VChat::End("");

用户进出会议通知

API介绍

在连接建立后,如果已有成员在通话中,或新进来的成员都会通过此回调通知。有成员离开也通过此回调,并告诉是正常离开还是超时离开,超时离开代表本地超时未收到对端数据,可能对方网络异常也可能是本地网络异常。

API原型

typedef std::function SessionStatusCallback;

NIMVideoChatSessionType::kNIMVideoChatSessionTypePeopleStatus

File:nim_cpp_vchat.h

参数说明
参数 类型 说明
type enum 回调类型kNIMVideoChatSessionTypePeopleStatus
channel_id int64_t 频道id
code int 状态码,对应NIMVideoChatSessionStatus
json_extension string Json string 扩展,返回kNIMVChatUid,如果是离开带kNIMVChatStatus对应NIMVideoChatUserLeftType
示例
void VChatSessionCb(NIMVideoChatSessionType type, std::uint64_t channel_id, int code, const std::string& json_extension)
{
    switch (type)
    {
        case kNIMVideoChatSessionTypeStartRes:            /**< 创建通话结果 */
        break;
        case kNIMVideoChatSessionTypeInviteNotify:        /**< 通话邀请 */
        break;
        case kNIMVideoChatSessionTypeCalleeAckRes:        /**< 确认通话,接受拒绝结果 */
        break;
        case kNIMVideoChatSessionTypeCalleeAckNotify:    /**< 确认通话,接受拒绝通知 */
        break;
        case kNIMVideoChatSessionTypeControlRes:        /**< NIMVChatControlType 结果 */
        break;
        case kNIMVideoChatSessionTypeControlNotify:        /**< NIMVChatControlType 通知 */
        break;
        case kNIMVideoChatSessionTypeConnect:            /**< 通话中链接状态通知 */
        break;
        case kNIMVideoChatSessionTypePeopleStatus:        /**< 通话中成员状态 */
        break;
        case kNIMVideoChatSessionTypeNetStatus:            /**< 通话中网络状态 */
        break;
        case kNIMVideoChatSessionTypeHangupRes:            /**< 通话挂断结果 */    
        break;
        case kNIMVideoChatSessionTypeHangupNotify:        /**< 通话被挂断通知 */
        break;
        case kNIMVideoChatSessionTypeSyncAckNotify:        /**< 通话接听挂断同步通知 */
        break;
        case kNIMVideoChatSessionTypeMp4Notify:            /**< 通知MP4录制状态,包括开始录制和结束录制 */
        break;
        case kNIMVideoChatSessionTypeInfoNotify:        /**< 通知实时音频数据状态 */
        break;
        case kNIMVideoChatSessionTypeVolumeNotify:        /**< 通知实时音频发送和混音的音量状态 */
        break;
        case kNIMVideoChatSessionTypeAuRecordNotify:    /**< 通知音频录制状态,包括开始录制和结束录制 */
        break;
    }
}

会议发生了错误

API介绍

当房间发生异常,统一返回连接错误信息,和开始时连接成功及连接失败是同一个回调函数。

API原型

typedef std::function SessionStatusCallback;

NIMVideoChatSessionType::kNIMVideoChatSessionTypeConnect

File:nim_cpp_vchat.h

参数说明
参数 类型 说明
type enum 回调类型kNIMVideoChatSessionTypeConnect
channel_id int64_t 频道id
code int 错误码NIMVChatConnectErrorCode,200代表连接成功
json_extension string Json string 扩展,如果成功返回 kNIMVChatVideoRecordFile和kNIMVChatRecordFile
枚举定义 说明
kNIMVChatConnectDisconn 0 断开连接
kNIMVChatConnectStartFail 1 启动失败
kNIMVChatConnectTimeout 101 超时
kNIMVChatConnectMeetingModeError 102 会议模式错误
kNIMVChatConnectRtmpModeError 103 非rtmp用户加入rtmp频道
kNIMVChatConnectRtmpNodesError 104 超过频道最多rtmp人数限制
kNIMVChatConnectRtmpHostError 105 已经存在一个主播
kNIMVChatConnectRtmpCreateError 106 需要旁路直播, 但频道创建者非主播
kNIMVChatConnectSuccess 200 成功
kNIMVChatConnectLayoutError 208 主播自定义布局错误
kNIMVChatConnectInvalidParam 400 错误参数
kNIMVChatConnectDesKey 401 密码加密错误
kNIMVChatConnectInvalidRequst 417 错误请求
kNIMVChatConnectServerUnknown 500 服务器内部错误
kNIMVChatConnectLogout 1001 退出
kNIMVChatChannelStartFail 11000 发起失败
kNIMVChatChannelDisconnected 11001 断开连接
kNIMVChatVersionSelfLow 11002 本人SDK版本太低不兼容
kNIMVChatVersionRemoteLow 11003 对方SDK版本太低不兼容
示例
void VChatSessionCb(NIMVideoChatSessionType type, std::uint64_t channel_id, int code, const std::string& json_extension)
{
    switch (type)
    {
        case kNIMVideoChatSessionTypeStartRes:            /**< 创建通话结果 */
        break;
        case kNIMVideoChatSessionTypeInviteNotify:        /**< 通话邀请 */
        break;
        case kNIMVideoChatSessionTypeCalleeAckRes:        /**< 确认通话,接受拒绝结果 */
        break;
        case kNIMVideoChatSessionTypeCalleeAckNotify:    /**< 确认通话,接受拒绝通知 */
        break;
        case kNIMVideoChatSessionTypeControlRes:        /**< NIMVChatControlType 结果 */
        break;
        case kNIMVideoChatSessionTypeControlNotify:        /**< NIMVChatControlType 通知 */
        break;
        case kNIMVideoChatSessionTypeConnect:            /**< 通话中链接状态通知 */
        break;
        case kNIMVideoChatSessionTypePeopleStatus:        /**< 通话中成员状态 */
        break;
        case kNIMVideoChatSessionTypeNetStatus:            /**< 通话中网络状态 */
        break;
        case kNIMVideoChatSessionTypeHangupRes:            /**< 通话挂断结果 */    
        break;
        case kNIMVideoChatSessionTypeHangupNotify:        /**< 通话被挂断通知 */
        break;
        case kNIMVideoChatSessionTypeSyncAckNotify:        /**< 通话接听挂断同步通知 */
        break;
        case kNIMVideoChatSessionTypeMp4Notify:            /**< 通知MP4录制状态,包括开始录制和结束录制 */
        break;
        case kNIMVideoChatSessionTypeInfoNotify:        /**< 通知实时音频数据状态 */
        break;
        case kNIMVideoChatSessionTypeVolumeNotify:        /**< 通知实时音频发送和混音的音量状态 */
        break;
        case kNIMVideoChatSessionTypeAuRecordNotify:    /**< 通知音频录制状态,包括开始录制和结束录制 */
        break;
    }
}