初始化

准备工作:将SDK 相关的dll 文件(nim.dll,nim_audio.dll, nim_tools_http.dll, nrtc.dll)放到App 的运行目录下,并将SDK 的配置文件目录nim_conf(目录里包含一个ver_ctrl.dll文件)放到App 的运行目录下。SDK 基于vs2010 开发,如果App 没有对应的运行时库文件(msvcp100.dll和msvcr100.dll),请将其放到App 的运行目录下。

准备工作完成后,在程序启动时,如果直接使用C接口,需要调用LoadLibrary 函数动态加载nim.dll,然后调用GetProcAddress获取API 接口:nim_client_init,调用此接口初始化NIM SDK。同时,SDK 能力的一些参数以及如果SDK 需要连接独立部署的服务器的地址等配置也是在初始化SDK 时传入。

API 介绍

参数说明

参数 类型 必须 说明
app_key(C++) std::string 应用注册的云信APP KEY
app_data_dir std::string 使用默认路径时只需传入单个目录名(不以反斜杠结尾),
使用自定义路径时需传入完整路径(以反斜杠结尾,
并确保有正确的读写权限!)
app_install_dir std::string SDK动态库所在的目录全路径(如果传入为空,
则按照默认规则搜索该动态库)
config(C++) struct 初始化特殊参数(下文会作说明)
json_extension(C) std::string 初始化特殊参数(下文会作说明)
参数 类型 必须 说明
appDataDir std::string 使用默认路径时只需传入单个目录名(不以反斜杠结尾),
使用自定义路径时需传入完整路径(以反斜杠结尾,并确保有正确的读写权限!)
appInstallDir std::string SDK动态库所在的目录全路径(如果传入为空,
则按照默认规则搜索该动态库)
config struct 初始化特殊参数(下文会作说明)

初始化特殊参数说明

初始化时开发者可以通过设置SDKConfig(C++)/NIMConfig(C#)/json_extenstion(C)来设置特殊参数。

SDKConfig参数 类型 说明
database_encrypt_key_ std::string 数据库秘钥,建议必填,目前只支持最多32个字符的加密密钥!
建议使用32个字符
custom_timeout_ int 通讯自定义超时时间,暂时不开放设置
login_max_retry_times_ int 登录重试最大次数,如需设置建议设置大于3次,SDK默认设置次数
preload_attach_ bool 是否需要预下载附件(图片和语音),选填,默认为true,
如果有对带宽流量有较高要求的请关闭该选项,改为上层开发者按需下载附件文件
preload_image_quality_ int 预下载图片质量,选填,范围0-100
preload_image_resize_ std::string 预下载图片基于长宽做内缩略,选填,比如宽100高50,则赋值为100x50,中间为字母小写x
sdk_log_level_ enum SDK log级别,定义见NIMSDKLogLevel,选填,SDK默认的内置级别为kNIMSDKLogLevelPro
sync_session_ack_ bool 设置是否已读未读状态多端同步,默认true
use_https_ bool 是否启用HTTPS协议,默认为false
use_private_server_ bool 是否使用私有服务器,如果使用私有服务器,则必须设置为true
default_link_address_ std::list< std::string> 默认link服务器地址,如果选择使用私有服务器,则必填
default_nos_access_address_ std::list< std::string> 默认nos access服务器地址,
如果选择使用私有服务器,则必填
default_nos_download_address_ std::list< std::string> 默认nos 下载服务器地址,
如果选择使用私有服务器,则必填
default_nos_upload_address_ std::list< std::string> 默认nos 上传服务器地址,
如果选择使用私有服务器,则必填
lbs_address_ std::string lbs地址,如果选择使用私有服务器,则必填
nos_lbs_address_ std::string nos lbs地址,如果选择使用私有服务器,则必填
rsa_public_key_module_ std::string RSA public key,如果选择使用私有服务器,则必填
rsa_version_ int RSA version,如果选择使用私有服务器,则必填
NIMConfig参数 类型 说明
AppKey std::string 应用注册的云信APP KEY
CommonSetting.DataBaseEncryptKey std::string 数据库秘钥,建议必填,目前只支持最多32个字符的加密密钥!
建议使用32个字符
CommonSetting.PredownloadAttachmentThumbnail bool 是否需要预下载附件(图片和语音),选填,默认为true,
如果有对带宽流量有较高要求的请关闭该选项,改为上层开发者按需下载附件文件
CommonSetting.LogLevel enum SDK log级别,定义见NIMSDKLogLevel,选填,SDK默认的内置级别为kNIMSDKLogLevelPro
CommonSetting.UsePriviteServer bool 是否使用私有服务器,如果使用私有服务器,则必须设置为true
SdkPrivateServerSetting.LinkServerList std::list< std::string> 默认link服务器地址,如果选择使用私有服务器,则必填
SdkPrivateServerSetting.AccessServerList std::list< std::string> 默认nos access服务器地址,如果选择使用私有服务器,则必填
SdkPrivateServerSetting.DownloadServerList std::list< std::string> 默认nos 下载服务器地址,如果选择使用私有服务器,则必填
SdkPrivateServerSetting.UploadServerList std::list< std::string> 默认nos 上传服务器地址,如果选择使用私有服务器,则必填
SdkPrivateServerSetting.LbsAddress std::string lbs地址,如果选择使用私有服务器,则必填
SdkPrivateServerSetting.NOSLbsAddress std::string nos lbs地址,如果选择使用私有服务器,则必填
SdkPrivateServerSetting.RSAPublicKey std::string RSA public key,如果选择使用私有服务器,则必填
SdkPrivateServerSetting.RsaVersion int RSA version,如果选择使用私有服务器,则必填
键常量名 键常量值 值类型 说明
kNIMAppKey app_key std::string 应用注册的云信APP KEY
kNIMGlobalConfig global_config json object 常用配置,以下常用配置皆为该对象的子对象
kNIMDataBaseEncryptKey db_encrypt_key std::string 常用配置之一,数据库秘钥,建议必填,
目前只支持最多32个字符的加密密钥!建议使用32个字符
kNIMLoginRetryMaxTimes login_max_retry_times int 常用配置之一,登录重试最大次数,
如需设置建议设置大于3次,SDK默认设置次数
kNIMPreloadAttach preload_attach bool 常用配置之一,是否需要预下载附件(图片和语音),选填,默认为true,
如果有对带宽流量有较高要求的请关闭该选项,改为上层开发者按需下载附件文件
kNIMPreloadImageQuality preload_image_quality int 常用配置之一,预下载图片质量,选填,范围0-100
kNIMPreloadImageResize preload_image_resize std::string 常用配置之一,预下载图片基于长宽做内缩略,选填,
比如宽100高50,则赋值为100x50,中间为字母小写x
kNIMSDKLogLevel sdk_log_level enum 常用配置之一,SDK log级别,定义见NIMSDKLogLevel,选填,SDK默认的内置级别为kNIMSDKLogLevelPro
kNIMSyncSessionAck sync_session_ack bool 常用配置之一,设置是否已读未读状态多端同步,默认true
kNIMUseHttps use_https bool 常用配置之一,是否启用HTTPS协议,默认为false
kNIMPrivateServerSetting private_server_setting json object 私有服务器配置,以下常用私有服务器配置皆为该对象的子对象
kNIMDefaultLinkAddress default_link json string array 私有服务器配置之一,默认link服务器地址,
如果选择使用私有服务器,则必填
kNIMDefaultNosAccessAddress default_nos_access json string array 私有服务器配置之一,默认nos access服务器地址,
如果选择使用私有服务器,则必填
kNIMDefaultNosDownloadAddress default_nos_download json string array 私有服务器配置之一,默认nos 下载服务器地址,
如果选择使用私有服务器,则必填
kNIMDefaultNosUploadAddress default_nos_upload json string array 私有服务器配置之一,默认nos 上传服务器地址,
如果选择使用私有服务器,则必填
kNIMLbsAddress lbs std::string 私有服务器配置之一,lbs地址,如果选择使用私有服务器,则必填
kNIMNosLbsAddress nos_lbs std::string 私有服务器配置之一,nos lbs地址,如果选择使用私有服务器,则必填
kNIMRsaPublicKeyModule rsa_public_key_module std::string 私有服务器配置之一,RSA public key,如果选择使用私有服务器,则必填
kNIMRsaVersion rsa_version int 私有服务器配置之一,RSA version,如果选择使用私有服务器,则必填

启用HTTPS

通过设置初始化特殊参数可以启用HTTPS协议,具体可查阅参数说明列表。

示例

在程序退出前,调用接口nim_client_cleanup 进行NIM SDK 的清理工作,然后调用FreeLibrary 函数释放nim.dll,对于清理工作的注意事项请查看后续的"登出/退出和清理SDK"章节。

音视频初始化

API介绍

在调用音视频网络通话相关功能前,需要在SDK初始化完成后,主动初始化音视频功能。

API原型

参数说明

参数 类型 说明
json_info string 无效扩展字段
参数 类型 说明
path string 无效扩展字段
参数 类型 说明
json_extension string 无效扩展字段

返回值说明

返回一个bool类型值。若初始化成功返回true,否则返回false。

示例

音视频清理

API介绍

在调用音视频网络通话相关功能结束后,需要在SDK清理前,主动清理音视频功能。清理音视频功能前,关闭所有设备功能,结束通话

API原型

参数说明

参数 类型 说明
json_extension string 无效扩展字段

返回值说明

无返回值。

示例

设置通话回调函数

API介绍

在使用音视频网络通话前,需要先设置通话回调。通过回调会通知音视频事件和相关操作结果。建议在音视频初始化后调用此接口

API原型

参数说明

参数 类型 说明
cb function 音视频通话回调接口
参数 类型 说明
session struct 回调接口封装结构体
参数 类型 说明
cb function 音视频通话回调接口
user_data void* APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理

返回值说明

无返回值。

示例

        //注册音视频会话交互回调
        NIM.VChatAPI.SetSessionStatusCb(_vchatHandlers);
    }