|
NERoom SDK V1.41.0
|
函数 | |
| __declspec (dllimport) INERoomKit *createNERoomKit() | |
| 创建组件实例 | |
| using neroom::INERoomChatRoomNotificationItemMemberLeave = INERoomChatRoomNotificationItemMemberJoin |
聊天室成员离开通知
在文件 base_type_defines.h 第 673 行定义.
音频设备自动选择策略
在文件 base_type_defines.h 第 154 行定义.
音频设备连接类型
在文件 base_type_defines.h 第 162 行定义.
| using neroom::NEAudioDumpType |
音频dump文件类型
在文件 base_type_defines.h 第 1169 行定义.
| using neroom::NEAudioFormat |
音频帧格式
在文件 base_type_defines.h 第 1729 行定义.
| using neroom::NEAudioType |
| typedef enum neroom::tagNEAuthEvent neroom::NEAuthEvent |
登录状态
自定义背景图片的类型
在文件 base_type_defines.h 第 1196 行定义.
| using neroom::NECallback = std::function<void(int, const std::string&, const TResultParam&...)> |
通用回调
在文件 base_type_defines.h 第 37 行定义.
| using neroom::NEChatRoomMember |
聊天室成员
在文件 base_type_defines.h 第 598 行定义.
聊天室成员类型
| using neroom::NEClientType |
客户端类型
在文件 base_type_defines.h 第 413 行定义.
| using neroom::NEConnectState |
网络连接状态
在文件 base_type_defines.h 第 1178 行定义.
创建房间属性
在文件 base_type_defines.h 第 368 行定义.
创建房间参数
在文件 base_type_defines.h 第 343 行定义.
| using neroom::NECustomMessage |
IM自定义透传消息
在文件 base_type_defines.h 第 874 行定义.
| using neroom::NEDeviceBaseInfo |
设备基本信息
在文件 base_type_defines.h 第 189 行定义.
| typedef struct neroom::tagNEDomainInfo neroom::NEDomainInfo |
可用域名结果
| typedef struct neroom::tagNEDomainInfoResult neroom::NEDomainInfoResult |
可用域名查询结果
| typedef struct neroom::tagNEDomainItem neroom::NEDomainItem |
域名条目
| using neroom::NEEmptyCallback = NECallback<> |
在文件 base_type_defines.h 第 38 行定义.
| using neroom::NEErrorCode |
接口错误码
在文件 error_code_defines.h 第 38 行定义.
| typedef struct neroom::tagNEIMServerConfig neroom::NEIMServerConfig |
IM 服务器配置
加入房间选项
在文件 base_type_defines.h 第 392 行定义.
| using neroom::NEJoinRoomParams |
加入房间时参数
在文件 base_type_defines.h 第 355 行定义.
| using neroom::NEMediaPubType |
媒体 Pub 类型,目前仅支持音频
在文件 base_type_defines.h 第 136 行定义.
| using neroom::NEMemberProperty |
模板成员属性
在文件 base_type_defines.h 第 264 行定义.
用户音量信息
在文件 base_type_defines.h 第 1016 行定义.
| using neroom::NENetworkType |
网络类型
在文件 base_type_defines.h 第 2169 行定义.
权限流配置
在文件 base_type_defines.h 第 247 行定义.
| using neroom::NEPreviewRoomOptions = struct tagNEPreviewRoomOptions {} |
房间预览选项
在文件 base_type_defines.h 第 408 行定义.
| using neroom::NEPreviewRoomParams = struct tagNEPreviewRoomParams {} |
房间预览参数
在文件 base_type_defines.h 第 403 行定义.
| using neroom::NERectangle |
共享区域,待共享区域相对于整个屏幕或窗口的位置
在文件 base_type_defines.h 第 106 行定义.
角色所对应的音频参数
在文件 base_type_defines.h 第 210 行定义.
| using neroom::NERoleParams |
角色配置参数
在文件 base_type_defines.h 第 227 行定义.
角色所对应的屏幕共享参数
在文件 base_type_defines.h 第 218 行定义.
角色所对应的视频参数
在文件 base_type_defines.h 第 201 行定义.
智能降噪类型枚举
在文件 base_type_defines.h 第 2128 行定义.
音效均衡波段的中心频率
在文件 base_type_defines.h 第 2073 行定义.
| using neroom::NERoomAudioFrame |
外部输入的音频帧
在文件 base_type_defines.h 第 1740 行定义.
美颜类型。
在文件 base_type_defines.h 第 1266 行定义.
字幕状态变更事件错误码
在文件 base_type_defines.h 第 1151 行定义.
| using neroom::NERoomCaptionMessagePtr = std::shared_ptr<NERoomCaptionMessage> |
等候室成员信息智能指针
在文件 base_type_defines.h 第 1136 行定义.
字幕状态变更事件状态值
在文件 base_type_defines.h 第 1141 行定义.
字幕目标翻译语言枚举
在文件 base_type_defines.h 第 1024 行定义.
创建音效的配置项
在文件 base_type_defines.h 第 1806 行定义.
创建混音的配置项
在文件 base_type_defines.h 第 1761 行定义.
带宽受限时的视频编码降级偏好
在文件 base_type_defines.h 第 2022 行定义.
| using neroom::NERoomEndReason |
房间关闭的原因
在文件 base_type_defines.h 第 326 行定义.
扩展类型
在文件 base_type_defines.h 第 2533 行定义.
| typedef struct neroom::tagNERoomKitOptions neroom::NERoomKitOptions |
组件初始化配置
| typedef struct neroom::tagNERoomKitServerConfig neroom::NERoomKitServerConfig |
RoomKit 服务器配置
| using neroom::NERoomLanguage |
语言类型
在文件 base_type_defines.h 第 2158 行定义.
| typedef struct neroom::tagNERoomLiveConfig neroom::NERoomLiveConfig |
推流任务信息
| using neroom::NERoomLiveInfo |
直播信息
在文件 base_type_defines.h 第 969 行定义.
| using neroom::NERoomLiveLayout |
直播布局类型
在文件 base_type_defines.h 第 913 行定义.
直播基础信息
在文件 base_type_defines.h 第 933 行定义.
| using neroom::NERoomLiveState |
直播状态
在文件 base_type_defines.h 第 923 行定义.
音频编码规格
音频推流采样率
图片布局
| typedef struct neroom::tagNERoomLiveStreamLayout neroom::NERoomLiveStreamLayout |
直播推流模式
推流任务信息
直播成员布局
直播推流视频和画布的调节属性
本地录制错误码
在文件 base_type_defines.h 第 1244 行定义.
本地录制状态
在文件 base_type_defines.h 第 1230 行定义.
本地录制配置
在文件 base_type_defines.h 第 2259 行定义.
录制视频窗口流的布局配置
在文件 base_type_defines.h 第 2285 行定义.
成员邀请类型,用于标记成员被邀请过程中的状态
在文件 base_type_defines.h 第 55 行定义.
成员邀请类型
在文件 base_type_defines.h 第 70 行定义.
成员状态,用于标记成员在房间中的状态
在文件 base_type_defines.h 第 44 行定义.
| using neroom::NERoomProperty |
房间属性
在文件 base_type_defines.h 第 256 行定义.
开启录制请求配置
在文件 base_type_defines.h 第 2486 行定义.
| using neroom::NERoomRecordMode |
录制模式
在文件 base_type_defines.h 第 2469 行定义.
混响参数
在文件 base_type_defines.h 第 2061 行定义.
| using neroom::NERoomRole |
角色
在文件 base_type_defines.h 第 237 行定义.
音频帧请求数据的读写模式
在文件 base_type_defines.h 第 2098 行定义.
音频帧请求格式
在文件 base_type_defines.h 第 2106 行定义.
音频属性。设置采样率,码率,编码模式和声道数
在文件 base_type_defines.h 第 2115 行定义.
远端用户的音频统计
在文件 base_type_defines.h 第 1568 行定义.
音频应用场景。不同的场景设置对应不同的音频采集模式、播放模式
在文件 base_type_defines.h 第 2137 行定义.
本地音频流上传统计信息
在文件 base_type_defines.h 第 1530 行定义.
音频流类型
在文件 base_type_defines.h 第 1516 行定义.
场景模式
在文件 base_type_defines.h 第 2150 行定义.
在文件 base_type_defines.h 第 316 行定义.
安装音频驱动插件结果(仅适用于 Mac 系统)
在文件 base_type_defines.h 第 2523 行定义.
网络质量类型
在文件 base_type_defines.h 第 994 行定义.
网络质量统计信息。
在文件 base_type_defines.h 第 1007 行定义.
屏幕共享采集对象发生变化返回的信息
在文件 base_type_defines.h 第 1986 行定义.
在文件 base_type_defines.h 第 1941 行定义.
| using neroom::NERoomRtcStats |
通话相关的统计信息
在文件 base_type_defines.h 第 1386 行定义.
云代理模式
在文件 base_type_defines.h 第 2504 行定义.
远端视频流的统计信息
在文件 base_type_defines.h 第 1660 行定义.
本地视频流上传统计信息
在文件 base_type_defines.h 第 1598 行定义.
设置视频流模式
在文件 base_type_defines.h 第 2513 行定义.
视频流类型
在文件 base_type_defines.h 第 2089 行定义.
被共享数据源信息
在文件 base_type_defines.h 第 1922 行定义.
屏幕分享状态
在文件 base_type_defines.h 第 1749 行定义.
共享高亮边框选项
在文件 base_type_defines.h 第 2005 行定义.
屏幕共享选项
在文件 base_type_defines.h 第 2039 行定义.
| using neroom::NERoomSize |
NERoom 通用大小数据结构
在文件 base_type_defines.h 第 1886 行定义.
| using neroom::NERoomSourceID = void* |
| using neroom::NERoomTemplate |
房间模板配置
在文件 base_type_defines.h 第 311 行定义.
| using neroom::NERoomThumbImage |
缩略图数据
在文件 base_type_defines.h 第 1897 行定义.
| using neroom::NERoomVideoFrame |
外部输入的视频帧
在文件 base_type_defines.h 第 1710 行定义.
| using neroom::NERoomVideoView |
视频画布
在文件 base_type_defines.h 第 1869 行定义.
自定义背景图像
在文件 base_type_defines.h 第 1205 行定义.
虚拟背景未成功启用的原因或确认成功的信息
在文件 base_type_defines.h 第 1218 行定义.
设备支持级别。
在文件 base_type_defines.h 第 1034 行定义.
在文件 base_type_defines.h 第 1960 行定义.
| typedef struct neroom::tagNERtcServerConfig neroom::NERtcServerConfig |
Rtc 服务器配置
| using neroom::NESDKVersions |
版本信息
在文件 base_type_defines.h 第 1186 行定义.
| typedef struct neroom::tagNEServerConfig neroom::NEServerConfig |
私有化配置
| using neroom::NETemplateMember |
模板成员
在文件 base_type_defines.h 第 288 行定义.
模板权限配置
在文件 base_type_defines.h 第 303 行定义.
| using neroom::NETemplateRoom |
模板房间
在文件 base_type_defines.h 第 296 行定义.
| using neroom::NETemplateStream |
模板成员流信息
在文件 base_type_defines.h 第 272 行定义.
模板成员流配置
在文件 base_type_defines.h 第 279 行定义.
视频设备链接类型
在文件 base_type_defines.h 第 179 行定义.
| using neroom::NEVideoFramerate |
视频帧率
在文件 base_type_defines.h 第 900 行定义.
视频镜像模式
在文件 base_type_defines.h 第 1860 行定义.
视频分辨率
在文件 base_type_defines.h 第 884 行定义.
| using neroom::NEVideoRotation |
视频帧旋转角度
在文件 base_type_defines.h 第 144 行定义.
视频缩放模式
在文件 base_type_defines.h 第 1851 行定义.
| using neroom::NEVideoStats |
视频统计数据
在文件 base_type_defines.h 第 982 行定义.
视频流类型
在文件 base_type_defines.h 第 1842 行定义.
| using neroom::NEVideoType |
视频帧格式
在文件 base_type_defines.h 第 123 行定义.
| using neroom::NEWaitingRoomManagerPtr = std::shared_ptr<INEWaitRoomManager> |
等候室主持人成员信息智能指针
在文件 base_type_defines.h 第 2409 行定义.
| using neroom::NEWaitingRoomMemberPtr = std::shared_ptr<INEWaitingRoomMember> |
等候室成员信息智能指针
在文件 base_type_defines.h 第 2397 行定义.
| typedef struct neroom::tagNEWhiteBoardAppConfig neroom::NEWhiteBoardAppConfig |
白板初始化配置
白板服务器配置
| using neroom::SharedChatMessagePtr = std::shared_ptr<INERoomChatMessage> |
聊天室消息智能指针
在文件 base_type_defines.h 第 718 行定义.
| using neroom::SharedMemberPtr = std::shared_ptr<INERoomMember> |
房间用户信息智能指针
在文件 base_type_defines.h 第 869 行定义.
获取成员列表的排序方式
| 枚举值 | |
|---|---|
| kNERoomGetMemberOriDesc | 按照加入时间降序排列 |
| kNERoomGetMemberOriAsc | 按照加入时间升序排列 |
在文件 waiting_room_ctrl_interface.h 第 22 行定义.
| 枚举值 | |
|---|---|
| kUnknown | 未知聊天室 |
| kMeetingRoom | 会议中聊天室 |
| kWaitingRoom | 等候室聊天室 |
在文件 base_type_defines.h 第 455 行定义.
| enum neroom::NELogLevel |
检索聊天室消息的排序规则
| 枚举值 | |
|---|---|
| kNEMessageSearchOrderDesc | 降序 |
| kNEMessageSearchOrderAsc | 升序 |
在文件 base_type_defines.h 第 430 行定义.
录制文件类型
| 枚举值 | |
|---|---|
| kNERecordFileUnknown | @biref 未知类型 |
| kNERecordFileTypeAAC | AAC 类型文件 |
| kNERecordFileTypeMP4 | MP4 类型文件 |
| kNERecordFileTypeFLV | FLV 类型文件 |
在文件 base_type_defines.h 第 2205 行定义.
| 枚举值 | |
|---|---|
| NERoomChatMessageNotificationTypeUnknown | 未识别的通知类型,可通过 INERoomChatRoomNotificationItem 的 rawData 字段获取原始内容 |
| NERoomChatMessageNotificationTypeMemberJoin | 聊天室有成员进入 |
| NERoomChatMessageNotificationTypeMemberLeave | 聊天室有成员退出 |
| NERoomChatMessageNotificationTypeMessageRecall | 聊天室有消息被撤回 |
在文件 base_type_defines.h 第 92 行定义.
房间聊天室消息类型
| 枚举值 | |
|---|---|
| kNERoomMessageTypeText | 文本消息 |
| kNERoomMessageTypeCustom | 自定义消息 |
| kNERoomMessageTypeFile | 文件类型消息 |
| kNERoomMessageTypeImage | 图片类型消息 |
| kNERoomMessageTypeNotification | 通知类型消息 |
在文件 base_type_defines.h 第 79 行定义.
房间云录制状态
| 枚举值 | |
|---|---|
| kNERoomRecordingStart | 云录制中 |
| kNERoomRecordingStop | 未在云录制 |
在文件 base_type_defines.h 第 2190 行定义.
被共享数据源类型
| 枚举值 | |
|---|---|
| kNERoomScreenCaptureSourceTypeUnknown | 未知类型 |
| kNERoomScreenCaptureSourceTypeWindow | 应用窗口 |
| kNERoomScreenCaptureSourceTypeScreen | 显示器对应的桌面 |
| kNERoomScreenCaptureSourceTypeCustom | 自定义 |
在文件 base_type_defines.h 第 1907 行定义.
| 枚举值 | |
|---|---|
| kNERoomSessionTypeNone | |
| kNERoomSessionTypeP2P | |
在文件 message_service_interface.h 第 20 行定义.
|
strong |
成员状态变更原因
| 枚举值 | |
|---|---|
| kReasonBySelf | 自动进入/自动离开等候室 |
| kReasonPuttedIn | 在会议中被管理员移至等候室 |
| kReasonSelfKicked | 同账号互踢 |
| kReasonExpelled | 在等候室中被管理员移出 |
| kReasonTimeout | 超时 |
| kReasonPermit | 被管理员准入 |
| kReasonAllKicked | 被管理员全部移除 |
在文件 base_type_defines.h 第 2330 行定义.
等候室成员状态
| 枚举值 | |
|---|---|
| kStatusNone | 未在等候室 |
| kStatusWaiting | 等候中 |
| kStatusAdmitted | 被管理准入,加入中 |
| kStatusLeft | 已离开 |
在文件 base_type_defines.h 第 2316 行定义.
|
strong |
登录状态
| 枚举值 | |
|---|---|
| kAuthKickOut | 被踢出登录 |
| kAuthUnauthorized | 授权过期或失败 |
| kAuthForbidden | 服务端禁止登录 |
| kAuthAccountTokenError | 账号或密码错误 |
| kAuthLoggedIn | 登录成功 |
| kAuthLoggedOut | 未登录 |
在文件 auth_service_interface.h 第 23 行定义.
聊天室成员类型
在文件 chat_ctrl_interface.h 第 23 行定义.
音频编码规格
| 枚举值 | |
|---|---|
| kProfileLCAAC | LC-AAC 规格,表示基本音频编码规格 |
| kProfileHEAAC | HE-AAC 规格,表示高效音频编码规格 |
在文件 live_ctrl_interface.h 第 40 行定义.
音频推流采样率
| 枚举值 | |
|---|---|
| kRate32000 | 采样率为 32 kHz |
| kRate44100 | 采样率为 44.1 kHz |
| kRate48000 | 采样率为 48 kHz |
在文件 live_ctrl_interface.h 第 23 行定义.
直播推流视频和画布的调节属性
| 枚举值 | |
|---|---|
| kScaleFit | 视频尺寸等比缩放。优先保证视频内容全部显示。因视频尺寸与显示视窗尺寸不一致造成的视窗未被填满的区域填充背景色 |
| kScaleCropFill | 视频尺寸等比缩放。优先保证视窗被填满。因视频尺寸与显示视窗尺寸不一致而多出的视频将被截掉 |
在文件 live_ctrl_interface.h 第 48 行定义.
| neroom::__declspec | ( | dllimport | ) |
创建组件实例
销毁组件实例