NIM PC Cross Platform SDK
载入中...
搜索中...
未找到
nim_tools_def.h 文件参考

工具类 接口相关的常量函数等定义头文件 更多...

#include "public_defines.h"

浏览源代码.

类型定义

typedef void(* nim_tool_get_audio_text_cb_func) (int rescode, const char *text, const char *json_extension, const void *user_data)
 
typedef void(* nim_tool_filter_client_antispam_cb_func) (bool succeed, int ret, const char *text, const char *json_extension, const void *user_data)
 
typedef void(* nim_tool_sdk_log_cb_func) (const char *log_content, const void *user_data)
 
typedef void(* nim_tool_sdk_collect_log_cb_func) (char **log_files, uint64_t *length, const void *user_data)
 SDK 日志上报时用户层指定的要上报的日志文件回调
 

枚举

enum  NIMAppDataType { kNIMAppDataTypeUnknownOtherRes = 0 , kNIMAppDataTypeImage = 1 , kNIMAppDataTypeAudio = 2 , kNIMAppDataTypeVideo = 3 }
 

变量

Trans Audio Msg Info Keys
static const char * kNIMTransAudioKeyMime = "mime"
 string 语音类型
 
static const char * kNIMTransAudioKeySample = "samp"
 string 语音采样率
 
static const char * kNIMTransAudioKeyAudioUrl = "url"
 string 语音url
 
static const char * kNIMTransAudioKeyDuration = "dur"
 long 语音时长,毫秒
 

详细描述

工具类 接口相关的常量函数等定义头文件

作者
Harrison
日期
2015/2/1

类型定义说明

◆ nim_tool_filter_client_antispam_cb_func

void(* nim_tool_filter_client_antispam_cb_func)(bool succeed, int ret, const char *text, const char *json_extension, const void *user_data)

nim callback function for client antispam

参数
[out]succeed本地反垃圾成功
[out]ret本地反垃圾结果码, 1:敏感词已被替换,替换后的内容可以发送,2:表明含有敏感词不允许发送;3:表明发送时需要将内容设置在消息结构的反垃圾字段里,由服务器过滤;
[out]rescode转换结果,成功200
[out]text反垃圾处理后的内容
[out]json_extensionjson扩展数据(备用)
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值

◆ nim_tool_get_audio_text_cb_func

void(* nim_tool_get_audio_text_cb_func)(const char *text, const char *json_extension, const void *user_data)

nim callback function for get audio text

参数
[out]rescode转换结果,成功200
[out]text语音文字
[out]json_extensionjson扩展数据(备用)
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值

◆ nim_tool_sdk_collect_log_cb_func

void(* nim_tool_sdk_collect_log_cb_func)(const char *log_files, const void *user_data)

SDK 日志上报时用户层指定的要上报的日志文件回调

参数
[out]log_files日志文件列表,json array 格式,每个文件要求绝对路径
[out]length数据长度
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!

◆ nim_tool_sdk_log_cb_func

void(* nim_tool_sdk_log_cb_func)(const char *log_content, const void *user_data)

SDK系统日志回调

参数
[out]log_content日志内容
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值

枚举类型说明

◆ NIMAppDataType

AppData类型

枚举值
kNIMAppDataTypeUnknownOtherRes 

其他资源文件(除了消息历史文件和已知类型之外的消息数据缓存文件)

kNIMAppDataTypeImage 

图片消息文件

kNIMAppDataTypeAudio 

语音消息文件

kNIMAppDataTypeVideo 

视频消息文件

变量说明

◆ kNIMTransAudioKeyAudioUrl

const char* kNIMTransAudioKeyAudioUrl = "url"
static

string 语音url

◆ kNIMTransAudioKeyDuration

const char* kNIMTransAudioKeyDuration = "dur"
static

long 语音时长,毫秒

◆ kNIMTransAudioKeyMime

const char* kNIMTransAudioKeyMime = "mime"
static

string 语音类型

◆ kNIMTransAudioKeySample

const char* kNIMTransAudioKeySample = "samp"
static

string 语音采样率