本文档包含NemoSDK中所有统计和日志相关的函数接口。
版本支持: 3.11.0
函数概述: 获取通话简单统计信息
函数定义:
virtual const XYStatistics& getStatistics() = 0;
返回值:
const XYStatistics& - 简单统计信息
版本支持: 3.11.0
函数概述: 获取通话详细统计信息
函数定义:
virtual const XYDetailStatistics& getDetailStatistics() = 0;
返回值:
const XYDetailStatistics& - 详细统计信息
版本支持: 3.11.0
函数概述: 上报事件
函数定义:
virtual void eventReport(const char* category, const char* eventName, const char* eventValue) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
category | const char* | 是 | 无 | 事件类型 |
eventName | const char* | 是 | 无 | 事件名称 |
eventValue | const char* | 是 | 无 | 事件带的一些值（json字符串） |
版本支持: 3.11.0
函数概述: 通过SDK记录日志
函数定义:
virtual void log(const char* log) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
log | const char* | 是 | 无 | 日志信息 |
版本支持: 3.11.0
函数概述: 日志上传
函数定义:
virtual void logUpload(XYLogType type, const char* comments = "") = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
type | 是 | 无 | 日志类型 | |
comments | const char* | 否 | "" | 日志注释（一段简单描述 这段日志的作用） |
版本支持: 3.11.0
函数概述: 取消日志上传
函数定义:
virtual void cancelLogUpload() = 0;
版本支持: 3.11.0
函数概述: 根据日志类型获取会中日志标识
函数定义:
virtual uint32_t getDumpFlagValue(XYDumpType dumpType) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
dumpType | 是 | 无 | 日志类型 |
返回值:
uint32_t - 日志标识
版本支持: 3.3.0
函数概述: 更新会中dump日志
函数定义:
virtual void setMediaDumpMask(uint32_t dumpMask) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
dumpMask | uint32_t | 是 | 无 | 标识 通过"getDumpFlagValue"拿到 |
版本支持: 3.11.0
函数概述: 保存会中详细日志Dump
函数定义:
virtual void saveDump() = 0;
版本支持: 3.11.0
函数概述: 保存音频日志Dump
函数定义:
virtual void saveAudioDump() = 0;
版本支持: 3.3.0
函数概述: ae audio dump 入会前设置，dump本次会叫总的音频数据
函数定义:
virtual void enableAudioDump() = 0;
版本支持: 3.3.0
函数概述: 是否开启小鱼回声消除功能(默认启用)
函数定义:
virtual void enableAECMode(bool enable) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
enable | bool | 是 | 无 | 是否开启 |
版本支持: 3.11.0
函数概述: 取消aedumper
函数定义:
virtual void disableAEDumper() = 0;
版本支持: 3.11.0
函数概述: 标记aedumper
函数定义:
virtual void markAEDumper() = 0;
版本支持: 3.11.0
函数概述: ae audio dump 入会前设置，dump本次会叫总的音频数据(加密)
函数定义:
virtual void enableAEDumper(const char* path, uint32_t capacityInMB) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
path | const char* | 是 | 无 | 存储加密dump数据的路径 |
capacityInMB | uint32_t | 是 | 无 | dump文件尺寸最大值 |
版本支持: 3.3.0
函数状态: 已废弃, 请使用 getStatistics()
函数概述: 获取通话统计信息
函数定义:
virtual const SDKStatistics& getStatistics(bool isOld = true) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
isOld | bool | 否 | true | 用来区分是否是3.3.0版本的接口，无实际意义 |
返回值:
const SDKStatistics& - 统计信息
版本支持: 3.3.0
函数状态: 已废弃, 请使用 getDetailStatistics()
函数概述: 获取详细统计信息
函数定义:
virtual const SDKDetailStatistics& getDetailStatistics(bool isOld = true) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
isOld | bool | 否 | true | 用来区分是否是3.3.0版本的接口，无实际意义 |
返回值:
const SDKDetailStatistics& - 详细统计信息
版本支持: 3.3.0
函数状态: 已废弃, 请使用 logUpload(XYLogType type, const char* comments = "")
函数概述: 日志上传
函数定义:
virtual void logUpload(const char* comments) = 0;
函数参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
comments | const char* | 是 | 无 | 日志注释 |