云信跨平台 SDK 开发手册

前言

版本更新

传输门

接口文档

传输门

概述

云信跨平台 SDK对外暴露的是C接口，为了让开发者更加方便快捷的接入SDK，我们基于C接口进行了各平台下的C++封装，既可以让开发者方便直观的调用接口使用云信的服务，也可以供基于C接口开发的的开发者作为参考。

支持平台

Windows

Windows xp(sp3及以上）、Windows 7、Windows 8/8.1、Windows 10.
iOS/OSX (alpha)

iOS 9.0以上，OSX 10.8 以上

开发准备

可以通过官网下载SDK以及Demo源码，SDK包含C接口API文件和C++封装层的API文件及项目文件。

SDK内容

SDK 目录结构及主要文件介绍

nim_sdk ..................................................... SDK目录
    include ................................................. SDK 引入包含目录
        depend_lib .......................................... SDK C++封装层依赖库目录
            include ......................................... SDK C++封装层依赖库包含目录
                json ........................................ Json工具包含目录
                nim_json_util.h ............................. JSON工具辅助方法
                nim_sdk_util.h .............................. 提供加载/卸载SDK以及获取接口的方法
        nim_c_api.h ......................................... c im api引入文件
        nim_chatroom_c_api.h ................................ c chatroom api引入文件
        nim_cpp_api.h ....................................... c++ im api 引入文件
        nim_chatroom_cpp_api.h .............................. c++ chatroom api 引入文件
        nim_cpp_tools_api.h ................................. nim 工具类api 引入文件
    public_define ........................................... SDK 共公类型定义目录 c/c++都会引用到数据结构定义
        defines ............................................. im/chatroom/nim_tools数据类型定义目录
        util ................................................ 编译开关及基础类型定义目录
        nim_sdk_define_include.h ............................ im 公共数据类型定义引入文件
        nim_chatroom_define_include.h ....................... chatroom 公共数据类型定义引入文件
        nim_tool_define_include.h ........................... nim_tools 公共数据类型定义引入文件
        nim_util_include.h .................................. 基础类型定义引入文件
    src ..................................................... c api/c++封装层实现代码目录
        c_sdk ............................................... c api 定义代码目录                
        cpp_sdk ............................................. c++封装层代码目录
            depend_lib ...................................... c++封装层依赖库的实现代码目录
                cpp_wrapper_util_md.sln ..................... c++封装层依赖库 md/mdd 运行时库工程的解决方案文件
                cpp_wrapper_util_mt.sln ..................... c++封装层依赖库 mt/mtd 运行时库工程的解决方案文件
            nim ............................................. im c++封装层实现代码目录
                nim_sdk_cpp_wrapper_dll.vcxproj ............. im c++封装层动态库工程文件 
                nim_sdk_cpp_wrapper_lib_md.vcxproj .......... im c++封装层静态库 md/mdd 运行时库工程文件
                nim_sdk_cpp_wrapper_lib_mt.vcxproj .......... im c++封装层静态库 mt/mtd 运行时库工程文件
            nim_chatroom .................................... chatrooom c++封装层实现代码目录
                nim_chatroom_sdk_cpp_wrapper_dll.vcxproj .... chatrooom c++封装层动态库工程文件
                nim_chatroom_sdk_cpp_wrapper_lib_md.vcxproj . chatrooom c++封装层静态库 md/mdd 运行时库工程文件
                nim_chatroom_sdk_cpp_wrapper_lib_mt.vcxproj . chatrooom c++封装层静态库 mt/mtd 运行时库工程文件
            nim_tools ....................................... nim tools c++封装层实现代码目录
                audio ....................................... audio模块 c++封装层实现代码目录
                http ........................................ http模块 c++封装层实现代码目录
    libs .................................................... c++封装层(静态库)、依赖库输出目录
        win ................................................. windows平台库目录
            x86 ............................................. x86平台输出目录
            x64 ............................................. x64平台输出目录
        iOS ................................................. iOS平台库目录
        Mac ................................................. Mac平台库目录

SDK二进制文件介绍

libs\win

x64:存放64位Dll的文件夹
x86：存放32位Dll的文件夹
nim.dll： SDK主模块；放在用户程序目录下
nim_audio.dll：负责语音录制和播放；放在用户程序目录下
nim_tools_http.dll：负责通用的http传输；nim.dll加载了此模块，需要放在用户程序目录下
nrtc.dll：负责视频聊天功能；放在用户程序目录下
nrtc_audio_process.dll：负责音频处理；放在用户程序目录下
nim_audio_hook.dll：负责辅助采集播放器音频，由nrtc.dll调用；放在用户程序目录下，x64位暂时不提供该Dll。
nim_conf： SDK版本相关；放在用户程序目录下
README.md: C/C++ SDK开发手册。
QT_README.md: C++ QT项目接入手册。

libs\iOS

core_iOS.framework:t通用模块，nim/chatroom依赖模块
nim_sdk_iOS.framework : IM相关的功能
nim_chatroom_iOS.framework:聊天室相关功能模块

libs\Mac:

core_Mac.framework:t通用模块，nim/chatroom依赖模块
nim_sdk_Mac.framework : IM相关的功能
nim_chatroom_Mac.framework:聊天室相关功能模块

SDK不提供debug版本的动态链接库供开发者调试，如果遇到问题请联系技术支持或在线客服。

SDK C++封装层类讲解

SDK C++封装层代码在nim_cpp_sdk\下，主要封装了以下核心类：

nim::Client: 全局管理功能：主要包括SDK初始化/清理、客户端登录/注销/重连/掉线/多点登录/把其他端踢下线等功能
nim::DataSync: 数据同步接口：提供注册监听数据同步结果的接口
nim::Friend: 好友功能：主要包括添加、删除好友、通过验证，拒绝好友请求、获取好友列表等功能
nim::Global: 全局接口：提供SDK分配的内存的释放的相关接口
nim::User: 用户特殊关系管理功能：主要包括设置对方消息静音和取消静音，把对方加入黑名单和从黑名单移除
nim::Talk: 聊天功能：主要包括发送消息、接受消息等功能
nim::Team: 群功能：主要包括查询群信息、查询群成员信息、加人、踢人、转移群主、设置管理员、接受入群邀请等功能
nim::VChat: 音视频功能：主要包括初始化/清理、发起会话、设置通话模式、会话控制、结束会话等功能
nim::SystemMsg: 系统消息和自定义通知功能：主要包括注册接收系统消息、发送自定义通知，删除查询系统消息等功能
nim::Session: 会话列表管理功能：主要包括查询会话列表，删除会话列表等功能
nim::MsgLog: 消息历史功能（不包含系统消息）：主要包括查询消息，设置消息读取状态，删除消息和导出消息到本地等功能。
nim::NOS: NOS云服务功能：主要包括资源文件的上传和下载功能，支持断点续传。
nim::Rts: RTS会话功能：主要包括发起RTS会话，接收会话请求，监听会话，会话控制和结束会话等功能。
nim::Tool: 提供的一些工具接口，主要包括获取SDK里app account对应的app data目录、计算md5、语音转文字等
nim::User: 用户信息托管：提供基础的用户信息托管服务。
nim_chatroom::ChatRoom: 聊天室服务
nim_audio::Audio: 语音播放功能
nim_http::HttpRequest: Http上传下载功能

此外，每个类都包含一个对应Helper文件，如nim_cpp_client.h对应nim_client_helper.h，主要包含接口需要的辅助方法和数据结构的定义。

开发集成

Windows

开发集成

c++封装层接入
iOS/OSX

c++封装层接入

交流

遇到问题：欢迎查看网易云信提供的更详细的API文档，网易云信的客户也可以通过技术支持更快的找到我们。
提交缺陷：在确保使用最新版本依然存在问题时请尽量以简洁的语言描述清楚复现该问题的步骤并提交 issue。网易云信的客户也可以通过技术支持更快的将问题反馈给我们。

TODO

Android 适配
Linux 适配

habbyge/CrossPlatform-SDK