neroom 命名空间参考

类
class	INEAnnotationView
	批注视图接口 更多...
class	INEAuthListener
	登录状态等事件监听 更多...
class	INEAuthService
	登录服务 更多...
class	INEBaseController
	基础控制器 更多...
class	INEBaseService
	基础服务 更多...
class	INEGlobalEventListener
	Kit 全局事件监听类 更多...
class	INEMessageChannelListener
	消息监听 更多...
class	INEMessageChannelService
	消息服务 更多...
class	INENosService
class	INEPreviewRoomContext
	房间外context 更多...
class	INEPreviewRoomListener
	房间外事件监听 更多...
class	INEPreviewRoomRtcController
	房间外rtc控制器 更多...
class	INERoomAnnotationController
	批注制器接口类 更多...
class	INERoomAppInviteController
	app邀请控制器 更多...
class	INERoomChatController
	聊天控制器 更多...
class	INERoomChatCustomMessage
	房间自定义消息 更多...
class	INERoomChatFileMessage
	文件消息 更多...
class	INERoomChatImageMessage
	图片消息 更多...
class	INERoomChatMessage
	房间聊天室消息 更多...
class	INERoomChatNotificationMessage
	聊天室通知消息 更多...
class	INERoomChatRoomNotificationItem
class	INERoomChatRoomNotificationItemMemberJoin
	聊天室成员加入通知 更多...
class	INERoomChatRoomNotificationItemMessageRecall
	聊天室消息撤回通知 更多...
class	INERoomChatTextMessage
	房间文本消息 更多...
class	INERoomContext
	房间上下文 更多...
class	INERoomKit
	组件接口类 更多...
class	INERoomListener
	事件监听类 更多...
class	INERoomLiveController
	直播控制器 更多...
class	INERoomMember
	房间用户信息 更多...
class	INERoomMemberBase
class	INERoomRtcAudioFrameObserver
	语音观测器对象 更多...
class	INERoomRtcController
	房间内rtc控制器 更多...
class	INERoomRtcStatsListener
	统计数据监听类 更多...
class	INERoomService
	房间服务 更多...
class	INERoomSIPController
	SIP控制器 更多...
class	INERoomWhiteboardController
	白板控制器接口类 更多...
class	INERtcWrapper
	RTC实例包装类，可获取RTC实例，添加/删除RTC回调 更多...
class	INEWaitingRoomController
	等候室控制器 更多...
class	INEWaitingRoomListener
class	INEWaitingRoomMember
	等候室成员信息 更多...
class	INEWaitRoomManager
	等候室主持人信息 更多...
class	INEWhiteboardBaseView
	白板视图基础接口 更多...
class	INEWhiteboardView
	白板视图接口 更多...
struct	NECustomSessionMessage
	自定义透传消息 更多...
struct	NEHistoryMessageSearchOption
struct	NEHistoryMessageSearchOptionByTags
struct	NEMyWaitingRoomState
struct	NERecordFileInfo
	录制文件信息详情 更多...
struct	NERoomAppInviteCallInfo
	app呼叫信息 更多...
class	NERoomCaptionMessage
	字幕消息对象 更多...
class	NERoomCaptionTranslator
	字幕目标翻译语言枚举 更多...
class	NERoomChatRoomNotificationItemBase
struct	NERoomGetSessionMessagesHistoryParam
	获取会话消息历史记录参数 更多...
struct	NERoomLiveBackgroundInfo
	直播背景详细信息 更多...
struct	NERoomLiveBackgroundParam
	直播背景信息描述 更多...
struct	NERoomRecentSession
	自定义会话消息 更多...
struct	NERoomRecord
	房间录制信息 更多...
struct	NERoomSIPCallInfo
	SIP呼叫信息 更多...
struct	NERoomSystemDevice
struct	NERoomTakeSnapshotInfo
	截图信息 更多...
struct	NEWaitingRoomInfo
struct	tagNEIMServerConfig
	IM 服务器配置 更多...
struct	tagNERoomKitOptions
	组件初始化配置 更多...
struct	tagNERoomKitServerConfig
	RoomKit 服务器配置 更多...
struct	tagNERoomLiveConfig
	推流任务信息 更多...
struct	tagNERoomLiveStreamImageInfo
	图片布局 更多...
struct	tagNERoomLiveStreamLayout
struct	tagNERoomLiveStreamTaskInfo
	推流任务信息 更多...
struct	tagNERoomLiveStreamUserTranscoding
	直播成员布局 更多...
struct	tagNERtcServerConfig
	Rtc 服务器配置 更多...
struct	tagNEServerConfig
	私有化配置 更多...
struct	tagNEWhiteboardServerConfig
	白板服务器配置 更多...

类型定义
typedef enum neroom::tagNEAuthEvent	NEAuthEvent
	登录状态
template<class... TResultParam>
using	NECallback = std::function<void(int, const std::string&, const TResultParam&...)>
	通用回调
using	NEEmptyCallback = NECallback<>
using	NERoomMemberState
	成员状态，用于标记成员在房间中的状态
using	NERoomMemberInviteState
	成员邀请类型，用于标记成员被邀请过程中的状态
using	NERoomMemberInviteType
	成员邀请类型
using	NERectangle
	共享区域,待共享区域相对于整个屏幕或窗口的位置
using	NEVideoType
	视频帧格式
using	NEMediaPubType
	媒体 Pub 类型，目前仅支持音频
using	NEVideoRotation
	视频帧旋转角度
using	NEAudioDeviceAutoSelectType
	音频设备自动选择策略
using	NEAudioDeviceTransportType
	音频设备连接类型
using	NEVideoDeviceTransportType
	视频设备链接类型
using	NEDeviceBaseInfo
	设备基本信息
using	NERoleVideoParams
	角色所对应的视频参数
using	NERoleAudioParams
	角色所对应的音频参数
using	NERoleScreenParams
	角色所对应的屏幕共享参数
using	NERoleParams
	角色配置参数
using	NERoomRole
	角色
using	NEPermissionStreams
	权限流配置
using	NERoomProperty
	房间属性
using	NEMemberProperty
	模板成员属性
using	NETemplateStream
	模板成员流信息
using	NETemplateStreams
	模板成员流配置
using	NETemplateMember
	模板成员
using	NETemplateRoom
	模板房间
using	NETemplatePermissions
	模板权限配置
using	NERoomTemplate
	房间模板配置
using	NERoomRTCClientRole
using	NERoomEndReason
	房间关闭的原因
using	NECreateRoomParams
	创建房间参数
using	NEJoinRoomParams
	加入房间时参数
using	NECreateRoomOptions
	创建房间属性
using	NEJoinRoomOptions
	加入房间选项
using	NEPreviewRoomParams = struct tagNEPreviewRoomParams {}
	房间预览参数
using	NEPreviewRoomOptions = struct tagNEPreviewRoomOptions {}
	房间预览选项
using	NEClientType
	客户端类型
using	NEChatRoomMember
	聊天室成员
using	INERoomChatRoomNotificationItemMemberLeave = INERoomChatRoomNotificationItemMemberJoin
	聊天室成员离开通知
using	SharedChatMessagePtr = std::shared_ptr<INERoomChatMessage>
	聊天室消息智能指针
using	SharedMemberPtr = std::shared_ptr<INERoomMember>
	房间用户信息智能指针
using	NECustomMessage
	IM自定义透传消息
using	NEVideoResolution
	视频分辨率
using	NEVideoFramerate
	视频帧率
using	NERoomLiveLayout
	直播布局类型
using	NERoomLiveState
	直播状态
using	NERoomLiveRequest
	直播基础信息
using	NERoomLiveInfo
	直播信息
using	NEVideoStats
	视频统计数据
using	NERoomRtcNetWorkQuality
	网络质量类型
using	NERoomRtcNetworkQualityInfo
	网络质量统计信息。
using	NEMemberVolumeInfo
	用户音量信息
using	NERoomCaptionTranslationLanguage
	字幕目标翻译语言枚举
using	NERoomVirtualBackgroundSupportedType
	设备支持级别。
using	NERoomCaptionMessagePtr = std::shared_ptr<NERoomCaptionMessage>
	等候室成员信息智能指针
using	NERoomCaptionState
	字幕状态变更事件状态值
using	NERoomCaptionErrorCode
	字幕状态变更事件错误码
using	NEAudioDumpType
	音频dump文件类型
using	NEConnectState
	网络连接状态
using	NESDKVersions
	版本信息
using	NEBackgroundSourceType
	自定义背景图片的类型
using	NERoomVirtualBackgroundSource
	自定义背景图像
using	NERoomVirtualBackgroundSourceStateReason
	虚拟背景未成功启用的原因或确认成功的信息
using	NERoomBeautyEffectType
	美颜类型。
using	NERoomRtcStats
	通话相关的统计信息
using	NERoomRtcAudioStreamType
using	NERoomRtcAudioSendStats
	本地音频流上传统计信息
using	NERoomRtcAudioRecvStats
	远端用户的音频统计
using	NERoomRtcVideoSendStats
	本地视频流上传统计信息
using	NERoomRtcVideoRecvStats
	远端视频流的统计信息
using	NERoomVideoFrame
	外部输入的视频帧
using	NEAudioType
	音频帧类型
using	NEAudioFormat
	音频帧格式
using	NERoomAudioFrame
	外部输入的音频帧
using	NERoomScreenCaptureStatus
	屏幕分享状态
using	NERoomCreateAudioMixingOption
	创建混音的配置项
using	NERoomCreateAudioEffectOption
using	NEVideoStreamType
	视频流类型
using	NEVideoScalingMode
	视频缩放模式
using	NEVideoMirrorMode
	视频镜像模式
using	NERoomVideoView
	视频画布
using	NERoomSourceID = void*
using	NERoomSize
	NERoom 通用大小数据结构
using	NERoomThumbImage
	缩略图数据
using	NERoomScreenCaptureInfo
	被共享数据源信息
using	NERoomRtcScreenCaptureSourceType
using	NERtcScreenCaptureCustomHLBorderAction
using	NERoomRtcScreenCaptureSourceData
	屏幕共享采集对象发生变化返回的信息
using	NERoomScreenSharingHighlight
	共享高亮边框选项
using	NERoomScreenSharingOption
	屏幕共享选项
using	NERoomReverbParam
	混响参数
using	NERoomAudioEqualizationBandFrequency
	音效均衡波段的中心频率
using	NERoomRtcVideoStreamType
	视频流类型
using	NERoomRtcAudioFrameOpMode
	音频帧请求数据的读写模式
using	NERoomRtcAudioFrameRequestFormat
	音频帧请求格式
using	NERoomRtcAudioProfileType
	音频属性。设置采样率，码率，编码模式和声道数
using	NERoomRtcAudioScenarioType
	音频应用场景。不同的场景设置对应不同的音频采集模式、播放模式
using	NERoomRtcChannelProfileType
	场景模式
using	NERoomLanguage
	语言类型
using	NENetworkType
	网络类型
using	NEWaitingRoomMemberPtr = std::shared_ptr<INEWaitingRoomMember>
	等候室成员信息智能指针
using	NEWaitingRoomManagerPtr = std::shared_ptr<INEWaitRoomManager>
	等候室主持人成员信息智能指针
typedef enum neroom::tagNEChatRoomMemberQueryType	NEChatRoomMemberQueryType
	聊天室成员类型
typedef enum neroom::tagNERoomLiveStreamAudioSampleRate	NERoomLiveStreamAudioSampleRate
	音频推流采样率
typedef enum neroom::tagNERoomLiveStreamMode	NERoomLiveStreamMode
	直播推流模式
typedef enum neroom::tagNERoomLiveStreamAudioCodecProfile	NERoomLiveStreamAudioCodecProfile
	音频编码规格
typedef enum neroom::tagNERoomLiveStreamVideoScaleMode	NERoomLiveStreamVideoScaleMode
	直播推流视频和画布的调节属性
typedef struct neroom::tagNERoomLiveStreamImageInfo	NERoomLiveStreamImageInfo
	图片布局
typedef struct neroom::tagNERoomLiveStreamUserTranscoding	NERoomLiveStreamUserTranscoding
	直播成员布局
typedef struct neroom::tagNERoomLiveStreamLayout	NERoomLiveStreamLayout
typedef struct neroom::tagNERoomLiveConfig	NERoomLiveConfig
	推流任务信息
typedef struct neroom::tagNERoomLiveStreamTaskInfo	NERoomLiveStreamTaskInfo
	推流任务信息
using	NEErrorCode
	接口错误码
typedef struct neroom::tagNERoomKitServerConfig	NERoomKitServerConfig
	RoomKit 服务器配置
typedef struct neroom::tagNEIMServerConfig	NEIMServerConfig
	IM 服务器配置
typedef struct neroom::tagNERtcServerConfig	NERtcServerConfig
	Rtc 服务器配置
typedef struct neroom::tagNEWhiteboardServerConfig	NEWhiteboardServerConfig
	白板服务器配置
typedef struct neroom::tagNEServerConfig	NEServerConfig
	私有化配置
typedef struct neroom::tagNERoomKitOptions	NERoomKitOptions
	组件初始化配置

枚举
enum class	tagNEAuthEvent {   kAuthKickOut , kAuthUnauthorized , kAuthForbidden , kAuthAccountTokenError ,   kAuthLoggedIn , kAuthLoggedOut }
	登录状态 更多...
enum	NERoomChatMessageType {   kNERoomMessageTypeText , kNERoomMessageTypeCustom , kNERoomMessageTypeFile , kNERoomMessageTypeImage ,   kNERoomMessageTypeNotification }
	房间聊天室消息类型 更多...
enum	NERoomChatMessageNotificationType { NERoomChatMessageNotificationTypeUnknown = 0 , NERoomChatMessageNotificationTypeMemberJoin = 301 , NERoomChatMessageNotificationTypeMemberLeave = 302 , NERoomChatMessageNotificationTypeMessageRecall = 323 }
enum	NEMessageSearchOrder { kNEMessageSearchOrderDesc , kNEMessageSearchOrderAsc }
	检索聊天室消息的排序规则 更多...
enum	NEChatroomType { kUnknown = -1 , kMeetingRoom , kWaitingRoom }
enum	NERoomScreenCaptureSourceType { kNERoomScreenCaptureSourceTypeUnknown = -1 , kNERoomScreenCaptureSourceTypeWindow = 0 , kNERoomScreenCaptureSourceTypeScreen = 1 , kNERoomScreenCaptureSourceTypeCustom = 2 }
	被共享数据源类型 更多...
enum	NEEncryptionType { kNEEncryptionTypeGMCryptoSM4ECB }
	RTC 流加密类型 更多...
enum	NERoomCloudRecordState { kNERoomRecordingStart , kNERoomRecordingStop }
	房间云录制状态 更多...
enum	NERecordFileType { kNERecordFileUnknown , kNERecordFileTypeAAC , kNERecordFileTypeMP4 , kNERecordFileTypeFLV }
	录制文件类型 更多...
enum	NEWaitingRoomState { kStatusNone = 0 , kStatusWaiting , kStatusAdmitted , kStatusLeft }
	等候室成员状态 更多...
enum	NEWaitingRoomMemberStateChangeReason {   kReasonBySelf , kReasonPuttedIn , kReasonSelfKicked , kReasonExpelled ,   kReasonTimeout , kReasonPermit , kReasonAllKicked }
	成员状态变更原因 更多...
enum class	NERoomSipDeviceInviteProtocolType { kIp = 1 , kH323 = 2 }
	设备地址呼叫协议，1=ip/uri 2=H.323 更多...
enum	tagNEChatRoomMemberQueryType { kNormal , kOnlineNormal , kGuestDesc , kGuestAsc }
	聊天室成员类型 更多...
enum	tagNERoomLiveStreamAudioSampleRate { kRate32000 = 32000 , kRate44100 = 44100 , kRate48000 = 48000 }
	音频推流采样率 更多...
enum	tagNERoomLiveStreamMode { kModeVideo , kModeAudio }
	直播推流模式 更多...
enum	tagNERoomLiveStreamAudioCodecProfile { kProfileLCAAC = 0 , kProfileHEAAC = 1 }
	音频编码规格 更多...
enum	tagNERoomLiveStreamVideoScaleMode { kScaleFit = 0 , kScaleCropFill = 1 }
	直播推流视频和画布的调节属性 更多...
enum	GetMemberOrientation { kNERoomGetMemberOriDesc , kNERoomGetMemberOriAsc }
	获取成员列表的排序方式 更多...
enum	NERoomSessionType { kNERoomSessionTypeNone , kNERoomSessionTypeP2P }
enum	NELogLevel {   NEVERBOSE , NEDEBUG , NEINFO , NEWARNING ,   NEERROR }
	日志等级 更多...

函数
	__declspec (dllimport) INERoomKit *createNERoomKit()
	创建组件实例

类型定义说明

INERoomChatRoomNotificationItemMemberLeave

using neroom::INERoomChatRoomNotificationItemMemberLeave = INERoomChatRoomNotificationItemMemberJoin

聊天室成员离开通知

在文件 base_type_defines.h 第 664 行定义.

NEAudioDeviceAutoSelectType

using neroom::NEAudioDeviceAutoSelectType

初始值:

 enum {
    kNEAudioDeviceAutoSelectTypeDefault = 0,   
    kNEAudioDeviceAutoSelectTypeAvailable = 1, 
}

音频设备自动选择策略

在文件 base_type_defines.h 第 151 行定义.

NEAudioDeviceTransportType

using neroom::NEAudioDeviceTransportType

初始值:

 enum tagNEAudioDeviceTransportType {
    kNEAudioDeviceTransportTypeUnknown = 0,       
    kNEAudioDeviceTransportTypeBluetooth = 1,     
    kNEAudioDeviceTransportTypeBluetoothA2DP = 2, 
    kNEAudioDeviceTransportTypeBluetoothLE = 3,   
    kNEAudioDeviceTransportTypeUSB = 4,           
    kNEAudioDeviceTransportTypeHDMI = 5,          
    kNEAudioDeviceTransportTypeBuiltIn = 6,       
    kNEAudioDeviceTransportTypeThunderbolt = 7,   
    kNEAudioDeviceTransportTypeAirPlay = 8,       
    kNEAudioDeviceTransportTypeVirtual = 9,       
    kNEAudioDeviceTransportTypeOther = 10,        
}

音频设备连接类型

在文件 base_type_defines.h 第 159 行定义.

NEAudioDumpType

using neroom::NEAudioDumpType

初始值:

 enum tagNEAudioDumpType {
    kNEAudioDumpTypePCM = 0, 
    kNEAudioDumpTypeAll = 1, 
    kNEAudioDumpTypeWAV = 2  
}

音频dump文件类型

在文件 base_type_defines.h 第 1117 行定义.

NEAudioFormat

using neroom::NEAudioFormat

初始值:

 struct tagNEAudioFormat {
    NEAudioType type = kNEAudioTypePCM16; 
    uint32_t channels = 2;                
    uint32_t sampleRate = 0;              
    uint32_t bytesPerSample = 16;         
    uint32_t samplesPerChannel = 1;       
}

音频帧格式

在文件 base_type_defines.h 第 1641 行定义.

NEAudioType

using neroom::NEAudioType

初始值:

 enum tagNEAudioType {
    kNEAudioTypePCM16 = 0, 
}

音频帧类型

在文件 base_type_defines.h 第 1634 行定义.

NEAuthEvent

typedef enum neroom::tagNEAuthEvent neroom::NEAuthEvent

登录状态

NEBackgroundSourceType

using neroom::NEBackgroundSourceType

初始值:

 enum tagNEBackgroundSourceType {
    kNEBackgroundColor = 1, 
    kNEBackgroundImage = 2, 
}

自定义背景图片的类型

在文件 base_type_defines.h 第 1146 行定义.

NECallback

template<class... TResultParam>

using neroom::NECallback = std::function<void(int, const std::string&, const TResultParam&...)>

通用回调

在文件 base_type_defines.h 第 37 行定义.

NEChatRoomMember

using neroom::NEChatRoomMember

初始值:

 struct tagNEChatRoomMember {
    std::string nick;   
    std::string avatar; 
}

聊天室成员

在文件 base_type_defines.h 第 589 行定义.

NEChatRoomMemberQueryType

typedef enum neroom::tagNEChatRoomMemberQueryType neroom::NEChatRoomMemberQueryType

聊天室成员类型

NEClientType

using neroom::NEClientType

初始值:

 enum {
    kNEClientTypeUNKNOWN, 
    kNEClientTypeIOS,     
    kNEClientTypeANDROID, 
    kNEClientTypePC,      
    kNEClientTypeWEB,     
    kNEClientTypeSIP,     
    kNEClientTypeMAC,     
    kNEClientTypeMINIAPP,  
    kNEClientTypeH323  
}

客户端类型

在文件 base_type_defines.h 第 406 行定义.

NEConnectState

using neroom::NEConnectState

初始值:

 enum tagNEConnectState {
    kNEStateConnected,    
    kNEStateReConnecting, 
    kNEStateReConnected,  
    kNEStateDisConnected  
}

网络连接状态

在文件 base_type_defines.h 第 1126 行定义.

NECreateRoomOptions

using neroom::NECreateRoomOptions

初始值:

 struct tagNECreateRoomOptions {
    
    bool enableRecord = false;
    
    bool enableLive = false;
    
    bool enableRtc = true;
    
    bool enableChatroom = false;
    
    bool enableWhiteboard = false;
    
    std::map<std::string, std::string> roleBind;
    
    bool enableWaitingRoom = false;
    
    bool enableSIPInvite = false;
    
    bool enableAPPInvite = false;
}

创建房间属性

在文件 base_type_defines.h 第 361 行定义.

NECreateRoomParams

using neroom::NECreateRoomParams

初始值:

 struct tagNECreateRoomParams {
    std::string roomUuid;                                 
    std::string roomName;                                 
    std::string password;                                 
    int maxMembers{-1};                                   
    int templateId;                                       
    std::map<std::string, std::string> initialProperties; 
}

创建房间参数

在文件 base_type_defines.h 第 337 行定义.

NECustomMessage

using neroom::NECustomMessage

初始值:

 struct tagNECustomMessage {
    std::string roomUuid;   
    std::string senderUuid; 
    std::string data;       
    int commandId = 0;      
}

IM自定义透传消息

在文件 base_type_defines.h 第 858 行定义.

NEDeviceBaseInfo

using neroom::NEDeviceBaseInfo

初始值:

 struct tagDeviceBaseInfo {
    std::string deviceName;     
    std::string deviceId;       
    bool unavailable = true;    
    bool defaultDevice = false; 
    int transportType = 0;      
}

设备基本信息

在文件 base_type_defines.h 第 186 行定义.

NEEmptyCallback

using neroom::NEEmptyCallback = NECallback<>

在文件 base_type_defines.h 第 38 行定义.

NEErrorCode

using neroom::NEErrorCode

初始值:

 enum tagNEErrorCode {
    kNEError = -1,  
    kNENoError = 0, 
}

接口错误码

在文件 error_code_defines.h 第 38 行定义.

NEIMServerConfig

typedef struct neroom::tagNEIMServerConfig neroom::NEIMServerConfig

IM 服务器配置

NEJoinRoomOptions

using neroom::NEJoinRoomOptions

初始值:

 struct tagNEJoinRoomOptions {
    
    bool enableMyAudioDeviceOnJoinRtc = false;
}

加入房间选项

在文件 base_type_defines.h 第 385 行定义.

NEJoinRoomParams

using neroom::NEJoinRoomParams

初始值:

 struct tagNEJoinRoomParams {
    std::string roomUuid;                                 
    std::string userName;                                 
    std::string avatar;                                   
    std::string role;                                     
    std::string password;                                 
    std::map<std::string, std::string> initialProperties; 
}

加入房间时参数

在文件 base_type_defines.h 第 349 行定义.

NEMediaPubType

using neroom::NEMediaPubType

初始值:

 enum tagNEMediaPubType {
    
    kNEMediaPubTypeAudio
}

媒体 Pub 类型，目前仅支持音频

在文件 base_type_defines.h 第 133 行定义.

NEMemberProperty

using neroom::NEMemberProperty

初始值:

 struct tagNEMemberProperty {
    std::list<std::string> whiteboard;  
    std::list<std::string> screenShare; 
}

模板成员属性

在文件 base_type_defines.h 第 258 行定义.

NEMemberVolumeInfo

using neroom::NEMemberVolumeInfo

初始值:

 struct tagNEMemberVolumeInfo {
    std::string userUuid; 
    int volume = 0;       
}

用户音量信息

在文件 base_type_defines.h 第 1000 行定义.

NENetworkType

using neroom::NENetworkType

初始值:

 enum tagNERoomNetworkType {
    kConnectionUnknown = 0,             
    kConnectionEthernet = 1,            
    kConnectionWifi = 2,                
    kConnection2G = 3,                  
    kConnection3G = 4,                  
    kConnection4G = 5,                  
    kConnectionNone = 6                
}

网络类型

自从

v1.31.0

在文件 base_type_defines.h 第 2045 行定义.

NEPermissionStreams

using neroom::NEPermissionStreams

初始值:

 struct tagNEPermissionStreams {
    std::list<std::string> audio;    
    std::list<std::string> video;    
    std::list<std::string> subVideo; 
}

权限流配置

在文件 base_type_defines.h 第 241 行定义.

NEPreviewRoomOptions

using neroom::NEPreviewRoomOptions = struct tagNEPreviewRoomOptions {}

房间预览选项

在文件 base_type_defines.h 第 401 行定义.

NEPreviewRoomParams

using neroom::NEPreviewRoomParams = struct tagNEPreviewRoomParams {}

房间预览参数

在文件 base_type_defines.h 第 396 行定义.

NERectangle

using neroom::NERectangle

初始值:

 struct tagNERectangle {
    tagNERectangle()
        : x(0)
        , y(0)
        , width(0)
        , height(0) {}
    int x;      
    int y;      
    int width;  
    int height; 
}

共享区域,待共享区域相对于整个屏幕或窗口的位置

在文件 base_type_defines.h 第 106 行定义.

NERoleAudioParams

using neroom::NERoleAudioParams

初始值:

 struct tagNERoleAudioParams {
    std::string profile;  
    std::string scenario; 
}

角色所对应的音频参数

在文件 base_type_defines.h 第 206 行定义.

NERoleParams

using neroom::NERoleParams

初始值:

 struct tagNERoleParams {
    NERoleVideoParams video;   
    NERoleAudioParams audio;   
    NERoleScreenParams screen; 
}

角色配置参数

在文件 base_type_defines.h 第 223 行定义.

NERoleScreenParams

using neroom::NERoleScreenParams

初始值:

 struct tagNERoleScreenParams {
    std::string videoProfile;    
    uint8_t preferMotionFPS{24}; 
    uint8_t preferDetailsFPS{5}; 
}

角色所对应的屏幕共享参数

在文件 base_type_defines.h 第 214 行定义.

NERoleVideoParams

using neroom::NERoleVideoParams

初始值:

 struct tagNERoleVideoParams {
    int width{0};  
    int height{0}; 
    int fps{0};    
}

角色所对应的视频参数

在文件 base_type_defines.h 第 197 行定义.

NERoomAudioEqualizationBandFrequency

using neroom::NERoomAudioEqualizationBandFrequency

初始值:

 enum tagNERoomAudioEqualizationBandFrequency {
    kNEVoiceEqualizationBand_31 = 0,  
    kNEVoiceEqualizationBand_62 = 1,  
    kNEVoiceEqualizationBand_125 = 2, 
    kNEVoiceEqualizationBand_250 = 3, 
    kNEVoiceEqualizationBand_500 = 4, 
    kNEVoiceEqualizationBand_1K = 5,  
    kNEVoiceEqualizationBand_2K = 6,  
    kNEVoiceEqualizationBand_4K = 7,  
    kNEVoiceEqualizationBand_8K = 8,  
    kNEVoiceEqualizationBand_16K = 9, 
}

音效均衡波段的中心频率

在文件 base_type_defines.h 第 1958 行定义.

NERoomAudioFrame

using neroom::NERoomAudioFrame

初始值:

 struct tagNERoomAudioFrame {
    NEAudioFormat format;      
    void* data = nullptr;      
    int64_t syncTimestamp = 0; 
}

外部输入的音频帧

在文件 base_type_defines.h 第 1652 行定义.

NERoomBeautyEffectType

using neroom::NERoomBeautyEffectType

美颜类型。

在文件 base_type_defines.h 第 1178 行定义.

NERoomCaptionErrorCode

using neroom::NERoomCaptionErrorCode

初始值:

 enum tagNERoomCaptionErrorCode {
    
    CODE_SUCCESS = 200,
    
    CODE_INVALID_REQUEST = 400,
    
    CODE_NOT_LOGGED_IN = 402,
    
    CODE_INVALID_PARAMS = 601,
    
    CODE_NO_PERMISSION = 611,
    
    CODE_NO_BACKEND_SERVICE = 612
}

字幕状态变更事件错误码

在文件 base_type_defines.h 第 1099 行定义.

NERoomCaptionMessagePtr

using neroom::NERoomCaptionMessagePtr = std::shared_ptr<NERoomCaptionMessage>

等候室成员信息智能指针

在文件 base_type_defines.h 第 1084 行定义.

NERoomCaptionState

using neroom::NERoomCaptionState

初始值:

 enum tagNERoomCaptionState {
    STATE_ENABLE_CAPTION_FAIL = 0,    
    STATE_DISABLE_CAPTION_FAIL = 1,   
    STATE_ENABLE_CAPTION_SUCCESS = 2, 
    STATE_DISABLE_CAPTION_SUCCESS = 3 
}

字幕状态变更事件状态值

在文件 base_type_defines.h 第 1089 行定义.

NERoomCaptionTranslationLanguage

using neroom::NERoomCaptionTranslationLanguage

初始值:

 enum tagNERoomCaptionTranslationLanguage {
    kNone = 0, 
    kChinese,  
    kEnglish,  
    kJapanese  
}

字幕目标翻译语言枚举

在文件 base_type_defines.h 第 1008 行定义.

NERoomCreateAudioEffectOption

using neroom::NERoomCreateAudioEffectOption

初始值:

 struct tagNERoomCreateAudioEffectOption {
    
    std::string path;
    
    int loopCount = 1;
    
    bool sendEnabled = true;
    
    uint32_t sendVolume = 100;
    
    bool playbackEnabled = true;
    
    uint32_t playbackVolume = 100;
}

创建音效的配置项

在文件 base_type_defines.h 第 1717 行定义.

NERoomCreateAudioMixingOption

using neroom::NERoomCreateAudioMixingOption

初始值:

 struct tagNERoomCreateAudioMixingOption {
    
    std::string path;
    
    int loopCount = 1;
    
    bool sendEnabled = true;
    
    uint32_t sendVolume = 100;
    
    bool playbackEnabled = true;
    
    uint32_t playbackVolume = 100;
    
    uint64_t startTimestamp = 0;
 
    
    NERoomRtcAudioStreamType sendWithAudioType = kNERoomRtcAudioStreamTypeMain;
}

创建混音的配置项

在文件 base_type_defines.h 第 1672 行定义.

NERoomEndReason

using neroom::NERoomEndReason

初始值:

 enum {
    kNERoomEndReasonLeaveBySelf,         
    kNERoomEndReasonSyncDataError,       
    kNERoomEndReasonKickSelf,            
    kNERoomEndReasonCloseByMember,       
    kNERoomEndReasonEndOfLife,           
    kNERoomEndReasonAllMembersOut,       
    kNERoomEndReasonByBackend,           
    kNERoomEndReasonKickOut,             
    kNERoomEndReasonLoginStateError,     
    kNERoomEndReasonDisconnectedFromRTC, 
    kNERoomEndReasonUnKnown              
}

房间关闭的原因

在文件 base_type_defines.h 第 320 行定义.

NERoomKitOptions

typedef struct neroom::tagNERoomKitOptions neroom::NERoomKitOptions

组件初始化配置

NERoomKitServerConfig

typedef struct neroom::tagNERoomKitServerConfig neroom::NERoomKitServerConfig

RoomKit 服务器配置

NERoomLanguage

using neroom::NERoomLanguage

初始值:

 enum class tagNERoomLanguage {
    kNEAutomatic, 
    kNEChinese,   
    kNEEnglish,   
    kNEJapanese,  
}

语言类型

在文件 base_type_defines.h 第 2034 行定义.

NERoomLiveConfig

typedef struct neroom::tagNERoomLiveConfig neroom::NERoomLiveConfig

推流任务信息

NERoomLiveInfo

using neroom::NERoomLiveInfo

初始值:

 struct tagNERoomLiveInfo : NERoomLiveRequest {
    std::string taskId;                              
    std::string pushUrl;                             
    std::string pullHlsUrl;                          
    std::string pullHttpUrl;                         
    std::string pullRtmpUrl;                         
    std::string pullRtsUrl;                          
    NERoomLiveState state = kNERoomLiveStateInvalid; 
}

直播信息

在文件 base_type_defines.h 第 953 行定义.

NERoomLiveLayout

using neroom::NERoomLiveLayout

初始值:

 enum {
    kNERoomLiveLayoutNone,       
    kNERoomLiveLayoutGallery,    
    kNERoomLiveLayoutFocus,      
    kNERoomLiveLayoutScreenShare 
}

直播布局类型

在文件 base_type_defines.h 第 897 行定义.

NERoomLiveRequest

using neroom::NERoomLiveRequest

初始值:

 struct tagNERoomLiveRequest {
    std::string title;                                   
    std::string password;                                
    NERoomLiveLayout liveLayout = kNERoomLiveLayoutNone; 
    std::vector<std::string> userUuidList;               
    std::string extentionConfig;                         
    bool enableThirdParties = false;                         
}

直播基础信息

在文件 base_type_defines.h 第 917 行定义.

NERoomLiveState

using neroom::NERoomLiveState

初始值:

 enum {
    kNERoomLiveStateInvalid, 
    kNERoomLiveStateInit,    
    kNERoomLiveStateStarted, 
    kNERoomLiveStateEnded,   
}

直播状态

在文件 base_type_defines.h 第 907 行定义.

NERoomLiveStreamAudioCodecProfile

typedef enum neroom::tagNERoomLiveStreamAudioCodecProfile neroom::NERoomLiveStreamAudioCodecProfile

音频编码规格

NERoomLiveStreamAudioSampleRate

typedef enum neroom::tagNERoomLiveStreamAudioSampleRate neroom::NERoomLiveStreamAudioSampleRate

音频推流采样率

NERoomLiveStreamImageInfo

typedef struct neroom::tagNERoomLiveStreamImageInfo neroom::NERoomLiveStreamImageInfo

图片布局

NERoomLiveStreamLayout

typedef struct neroom::tagNERoomLiveStreamLayout neroom::NERoomLiveStreamLayout

NERoomLiveStreamMode

typedef enum neroom::tagNERoomLiveStreamMode neroom::NERoomLiveStreamMode

直播推流模式

NERoomLiveStreamTaskInfo

typedef struct neroom::tagNERoomLiveStreamTaskInfo neroom::NERoomLiveStreamTaskInfo

推流任务信息

NERoomLiveStreamUserTranscoding

typedef struct neroom::tagNERoomLiveStreamUserTranscoding neroom::NERoomLiveStreamUserTranscoding

直播成员布局

NERoomLiveStreamVideoScaleMode

typedef enum neroom::tagNERoomLiveStreamVideoScaleMode neroom::NERoomLiveStreamVideoScaleMode

直播推流视频和画布的调节属性

NERoomMemberInviteState

using neroom::NERoomMemberInviteState

初始值:

 enum tagNERoomMemberInviteState {
    kInviteStateWaitingCall = 1, 
    kInviteStateCalling = 2,     
    kInviteStateRejected = 3,    
    kInviteStateNotAnswer = 4,   
    kInviteStateError = 5,       
    kInviteStateRemoved = 6,     
    kInviteStateCanceled = 7,    
    kInviteStateWaitingJoin = 8,  
    kInviteStateBusy = 9  
}

成员邀请类型，用于标记成员被邀请过程中的状态

自从

v1.28.0

在文件 base_type_defines.h 第 55 行定义.

NERoomMemberInviteType

using neroom::NERoomMemberInviteType

初始值:

 enum tagNERoomMemberInviteType {
    kRoomMemberInviteTypeUnknown = 0, 
    kRoomMemberInviteTypeSIP = 1,     
    kRoomMemberInviteTypeAPP = 2,     
}

成员邀请类型

在文件 base_type_defines.h 第 70 行定义.

NERoomMemberState

using neroom::NERoomMemberState

初始值:

 enum tagNERoomMemberState {
    kInRoom = 1,   
    kInRtc = 2,    
    kLeaved = 3,   
    kInviting = 4, 
}

成员状态，用于标记成员在房间中的状态

自从

v1.28.0

在文件 base_type_defines.h 第 44 行定义.

NERoomProperty

using neroom::NERoomProperty

初始值:

 struct tagNERoomProperty {
    std::string name;             
    std::list<std::string> roles; 
}

房间属性

在文件 base_type_defines.h 第 250 行定义.

NERoomReverbParam

using neroom::NERoomReverbParam

初始值:

 struct tagNERoomReverbParam {
    float wetGain = 0.0f;   
    float dryGain = 1.0f;   
    float damping = 1.0f;   
    float roomSize = 0.1f;  
    float decayTime = 0.1f; 
    float preDelay = 0.0f;  
}

混响参数

在文件 base_type_defines.h 第 1946 行定义.

NERoomRole

using neroom::NERoomRole

初始值:

 struct tagNERoomRole {
    std::string name;    
    int limit = 0;       
    NERoleParams params; 
}

角色

在文件 base_type_defines.h 第 232 行定义.

NERoomRtcAudioFrameOpMode

using neroom::NERoomRtcAudioFrameOpMode

初始值:

 enum tagNERoomRtcAudioFrameOpMode {
    kNERawAudioFrameOpModeReadOnly = 0,  
    kNERawAudioFrameOpModeReadWrite = 1, 
}

音频帧请求数据的读写模式

在文件 base_type_defines.h 第 1983 行定义.

NERoomRtcAudioFrameRequestFormat

using neroom::NERoomRtcAudioFrameRequestFormat

初始值:

 struct tagNERoomRtcAudioFrameRequestFormat {
    uint32_t channels = 0;   
    uint32_t sampleRate = 0; 
    NERoomRtcAudioFrameOpMode mode = kNERawAudioFrameOpModeReadWrite; 
}

音频帧请求格式

在文件 base_type_defines.h 第 1991 行定义.

NERoomRtcAudioProfileType

using neroom::NERoomRtcAudioProfileType

初始值:

 enum tagNERoomRtcAudioProfileType {
    kNEAudioProfileDefault = 0, 
    kNEAudioProfileStandard = 1,            
    kNEAudioProfileStandardExtend = 2,      
    kNEAudioProfileMiddleQuality = 3,       
    kNEAudioProfileMiddleQualityStereo = 4, 
    kNEAudioProfileHighQuality = 5,         
    kNEAudioProfileHighQualityStereo = 6,   
}

音频属性。设置采样率，码率，编码模式和声道数

在文件 base_type_defines.h 第 2000 行定义.

NERoomRtcAudioRecvStats

using neroom::NERoomRtcAudioRecvStats

初始值:

 struct tagNERoomRtcAudioRecvStats {
    
    NERoomRtcAudioStreamType streamType = kNERoomRtcAudioStreamTypeMain;
    
    int receivedBitRate = 0;
    
    int totalFrozenTime = 0;
    
    int frozenRate = 0;
    
    int audioLossRate = 0;
    
    unsigned int volume = 0;
}

远端用户的音频统计

在文件 base_type_defines.h 第 1480 行定义.

NERoomRtcAudioScenarioType

using neroom::NERoomRtcAudioScenarioType

初始值:

 enum tagNERoomRtcAudioScenarioType {
    
    kNEAudioScenarioDefault = 0,
    kNEAudioScenarioSpeech = 1, 
    kNEAudioScenarioMusic = 2,  
}

音频应用场景。不同的场景设置对应不同的音频采集模式、播放模式

在文件 base_type_defines.h 第 2013 行定义.

NERoomRtcAudioSendStats

using neroom::NERoomRtcAudioSendStats

初始值:

 struct tagNERoomRtcAudioSendStats {
    
    NERoomRtcAudioStreamType streamType = kNERoomRtcAudioStreamTypeMain;
    
    int numChannels = 0;
    
    int sentSampleRate = 0;
    
    int sentBitRate = 0;
    
    int audioLossRate = 0;
    
    int64_t rtt = 0;
    
    unsigned int volume = 0;
    
    unsigned int capVolume = 0;
}

本地音频流上传统计信息

在文件 base_type_defines.h 第 1442 行定义.

NERoomRtcAudioStreamType

using neroom::NERoomRtcAudioStreamType

初始值:

 enum tagNERoomRtcAudioStreamType {
    
    kNERoomRtcAudioStreamTypeMain = 0,
    
    kNERoomRtcAudioStreamTypeSub = 1,
}

音频流类型

在文件 base_type_defines.h 第 1428 行定义.

NERoomRtcChannelProfileType

using neroom::NERoomRtcChannelProfileType

初始值:

 enum tagNERoomRtcChannelProfileType {
    kNEChannelProfileCommunication = 0,    
    kNEChannelProfileLiveBroadcasting = 1, 
}

场景模式

在文件 base_type_defines.h 第 2026 行定义.

NERoomRTCClientRole

using neroom::NERoomRTCClientRole

初始值:

 enum {
    
    kRoomRTCClientRoleBroadcaster,
    
    kRoomRTCClientRoleAudience
}

在文件 base_type_defines.h 第 310 行定义.

NERoomRtcNetWorkQuality

using neroom::NERoomRtcNetWorkQuality

初始值:

 enum tagNERoomRtcNetWorkQuality {
    kNERoomRtcNetworkQualityUnknown = 0,   
    kNERoomRtcNetworkQualityExcellent = 1, 
    kNERoomRtcNetworkQualityGood = 2,      
    kNERoomRtcNetworkQualityPoor = 3,      
    kNERoomRtcNetworkQualityBad = 4,       
    kNERoomRtcNetworkQualityVeryBad = 5,   
    kNERoomRtcNetworkQualityDown = 6,      
}

网络质量类型

在文件 base_type_defines.h 第 978 行定义.

NERoomRtcNetworkQualityInfo

using neroom::NERoomRtcNetworkQualityInfo

初始值:

 struct tagNERoomRtcNetworkQualityInfo {
    std::string userUuid;                                                 
    NERoomRtcNetWorkQuality upStatus = kNERoomRtcNetworkQualityUnknown;   
    NERoomRtcNetWorkQuality downStatus = kNERoomRtcNetworkQualityUnknown; 
}

网络质量统计信息。

在文件 base_type_defines.h 第 991 行定义.

NERoomRtcScreenCaptureSourceData

using neroom::NERoomRtcScreenCaptureSourceData

初始值:

 struct TagNERoomRtcScreenCaptureSourceData {
    
    NERoomRtcScreenCaptureSourceType type;
    
    NERoomSourceID sourceID;
    
    NERoomScreenCaptureStatus status;
    
    NERtcScreenCaptureCustomHLBorderAction action;
    
    NERectangle captureRect;
    
    int level;
}

屏幕共享采集对象发生变化返回的信息

自从

v1.29.0

在文件 base_type_defines.h 第 1896 行定义.

NERoomRtcScreenCaptureSourceType

using neroom::NERoomRtcScreenCaptureSourceType

初始值:

 enum TagNERoomRtcScreenCaptureSourceType {
    
    kRtcScreenCaptureSourceTypeUnknown = -1,
    
    kRtcScreenCaptureSourceTypeWindow = 0,
    
    kRtcScreenCaptureSourceTypeScreen = 1,
    
    kRtcScreenCaptureSourceTypeCustom = 2,
}

在文件 base_type_defines.h 第 1851 行定义.

NERoomRtcStats

using neroom::NERoomRtcStats

通话相关的统计信息

在文件 base_type_defines.h 第 1298 行定义.

NERoomRtcVideoRecvStats

using neroom::NERoomRtcVideoRecvStats

初始值:

 struct tagNERoomRtcVideoRecvStats {
    
    int layerType = 1;
    
    int width = 0;
    
    int height = 0;
    
    int receivedBitRate = 0;
    
    int receivedFrameRate = 0;
    
    int decoderFrameRate = 0;
    
    int renderFrameRate = 0;
    
    int packetLossRate = 0;
    
    int totalFrozenTime = 0;
    
    int frozenRate = 0;
    
    std::string encoderName;
}

远端视频流的统计信息

在文件 base_type_defines.h 第 1572 行定义.

NERoomRtcVideoSendStats

using neroom::NERoomRtcVideoSendStats

初始值:

 struct tagNERoomRtcVideoSendStats {
    
    int layerType = 1;
    
    int width = 0;
    
    int height = 0;
    
    int captureWidth = 0;
    
    int captureHeight = 0;
    
    int captureFrameRate = 0;
    
    int renderFrameRate = 0;
    
    int encoderFrameRate = 0;
    
    int sentFrameRate = 0;
    
    int sentBitRate = 0;
    
    int targetBitRate = 0;
    
    int encoderBitRate = 0;
    
    std::string encoderName;
    
    bool dropBandwidthStrategyEnabled;
}

本地视频流上传统计信息

在文件 base_type_defines.h 第 1510 行定义.

NERoomRtcVideoStreamType

using neroom::NERoomRtcVideoStreamType

初始值:

 enum tagNERoomRtcVideoStreamType {
    kNEVideoStreamMain = 0, 
    kNEVideoStreamSub = 1,  
    kNEVideoStreamCount,    
}

视频流类型

在文件 base_type_defines.h 第 1974 行定义.

NERoomScreenCaptureInfo

using neroom::NERoomScreenCaptureInfo

初始值:

 struct tagNERoomScreenCaptureInfo {
    
    NERoomScreenCaptureSourceType type;
    
    NERoomSourceID sourceID;
    
    std::string title;
    
    std::string sourceName;
    
    std::string processPath;
    
    NERoomThumbImage thumbImage;
    
    NERoomThumbImage icon;
    
    bool primaryMonitor;
}

被共享数据源信息

自从

v1.21.0

在文件 base_type_defines.h 第 1832 行定义.

NERoomScreenCaptureStatus

using neroom::NERoomScreenCaptureStatus

初始值:

 enum tagNERoomScreenCaptureStatus {
    kNERoomScreenCaptureStatusStart = 1,  
    kNERoomScreenCaptureStatusPause = 2,  
    kNERoomScreenCaptureStatusResume = 3, 
    kNERoomScreenCaptureStatusStop = 4,   
    kNERoomScreenCaptureStatusCovered = 5 
}

屏幕分享状态

在文件 base_type_defines.h 第 1661 行定义.

NERoomScreenSharingHighlight

using neroom::NERoomScreenSharingHighlight

初始值:

 struct tagNERoomScreenSharingHighlight {
    bool enable{true};
    
    int width{4};
    
    uint32_t color{0xFF7EDE00};
    
    int length{-1};
}

共享高亮边框选项

自从

v1.21.0

在文件 base_type_defines.h 第 1915 行定义.

NERoomScreenSharingOption

using neroom::NERoomScreenSharingOption

初始值:

 struct tagNERoomScreenSharingOption {
    
    bool enableHighPerformance{true};
    
    NERoomScreenSharingHighlight highlight;
    
    int limitFrameRate{30};
    
    std::string videoProfile;
}

屏幕共享选项

自从

v1.21.0

在文件 base_type_defines.h 第 1932 行定义.

NERoomSize

using neroom::NERoomSize

初始值:

 struct tagNERoomSize {
    
    int width{0};
    
    int height{0};
}

NERoom 通用大小数据结构

自从

v1.21.0

在文件 base_type_defines.h 第 1796 行定义.

NERoomSourceID

using neroom::NERoomSourceID = void*

被共享数据源 ID，Windows 下将转为 HWND，macOS 下为整形。

自从

v1.21.0

在文件 base_type_defines.h 第 1790 行定义.

NERoomTemplate

using neroom::NERoomTemplate

初始值:

 struct tagNERoomTemplate {
    std::list<NERoomRole> roles;       
    NETemplatePermissions permissions; 
}

房间模板配置

在文件 base_type_defines.h 第 305 行定义.

NERoomThumbImage

using neroom::NERoomThumbImage

初始值:

 struct tagNERoomThumbImage {
    char* data{nullptr};
    uint32_t length{0};
    NERoomSize size;
}

缩略图数据

自从

v1.21.0

在文件 base_type_defines.h 第 1807 行定义.

NERoomVideoFrame

using neroom::NERoomVideoFrame

初始值:

 struct tagNERoomVideoFrame {
    NEVideoType format = kNEVideoTypeI420;         
    uint64_t timestamp = 0;                        
    uint32_t width = 0;                            
    uint32_t height = 0;                           
    NEVideoRotation rotation = kNEVideoRotation_0; 
    void* buffer = nullptr;                        
}

外部输入的视频帧

在文件 base_type_defines.h 第 1622 行定义.

NERoomVideoView

using neroom::NERoomVideoView

初始值:

 struct tagNERoomVideoView {
    bool setup = false;                                      
    void* window = nullptr;                                  
    NEVideoScalingMode scalingMode = kVideoScaleFit;         
    NEVideoMirrorMode mirrorMode = kVideoMirrorModeDisabled; 
}

视频画布

在文件 base_type_defines.h 第 1779 行定义.

NERoomVirtualBackgroundSource

using neroom::NERoomVirtualBackgroundSource

初始值:

 struct tagNERoomVirtualBackgroundSource {
    
    NEBackgroundSourceType sourceType = NEBackgroundSourceType::kNEBackgroundColor;
    
    unsigned int color = 0xffffff;
    
    std::string path;
}

自定义背景图像

在文件 base_type_defines.h 第 1154 行定义.

NERoomVirtualBackgroundSourceStateReason

using neroom::NERoomVirtualBackgroundSourceStateReason

初始值:

 enum tagNERoomVirtualBackgroundSourceStateReason {
    kNERoomVirtualBackgroundSourceStateReasonSuccess = 0,                 
    kNERoomVirtualBackgroundSourceStateReasonImageNotExist = 1,           
    kNERoomVirtualBackgroundSourceStateReasonImageFormatNotSupported = 2, 
    kNERoomVirtualBackgroundSourceStateReasonColorFormatNotSupported = 3, 
    kNERoomVirtualBackgroundSourceStateReasonDeviceNotSupported = 4       
}

虚拟背景未成功启用的原因或确认成功的信息

在文件 base_type_defines.h 第 1167 行定义.

NERoomVirtualBackgroundSupportedType

using neroom::NERoomVirtualBackgroundSupportedType

初始值:

 enum tagVirtualBackgroundSupportedType {
    
    kNEVirtualBackgroundSupportFull = 0,
 
    
    kNEVirtualBackgroundSupportHardwareLimit = 1,
 
    
    kNEVirtualBackgroundSupportPerformanceLimit = 2
}

设备支持级别。

在文件 base_type_defines.h 第 1018 行定义.

NERtcScreenCaptureCustomHLBorderAction

using neroom::NERtcScreenCaptureCustomHLBorderAction

初始值:

 enum TagNERtcScreenCaptureCustomHLBorderAction {
    
    kRtcScreenCaptureCustomHLBorderActionSetPos = 0,
    
    kRtcScreenCaptureCustomHLBorderActionSetAbove = 1,
    
    kRtcScreenCaptureCustomHLBorderActionSetBelow = 2,
    
    kRtcScreenCaptureCustomHLBorderActionHide = 3,
    
    kRtcScreenCaptureCustomHLBorderActionShow = 4,
}

在文件 base_type_defines.h 第 1870 行定义.

NERtcServerConfig

typedef struct neroom::tagNERtcServerConfig neroom::NERtcServerConfig

Rtc 服务器配置

NESDKVersions

using neroom::NESDKVersions

初始值:

 struct tagNESDKVersions {
    std::string imVersion;         
    std::string rtcVersion;        
    std::string whiteboardVersion; 
    std::string roomKitVersion;    
}

版本信息

在文件 base_type_defines.h 第 1136 行定义.

NEServerConfig

typedef struct neroom::tagNEServerConfig neroom::NEServerConfig

私有化配置

NETemplateMember

using neroom::NETemplateMember

初始值:

 struct tagNETemplateMember {
    NEMemberProperty properties; 
    NETemplateStreams streams;   
}

模板成员

在文件 base_type_defines.h 第 282 行定义.

NETemplatePermissions

using neroom::NETemplatePermissions

初始值:

 struct tagNETemplatePermissions {
    NETemplateMember member; 
    NETemplateRoom room;     
}

模板权限配置

在文件 base_type_defines.h 第 297 行定义.

NETemplateRoom

using neroom::NETemplateRoom

初始值:

 struct tagNETemplateRoom {
    std::list<NERoomProperty> properties; 
}

模板房间

在文件 base_type_defines.h 第 290 行定义.

NETemplateStream

using neroom::NETemplateStream

初始值:

 struct tagNETemplateStream {
    std::list<std::string> roles; 
}

模板成员流信息

在文件 base_type_defines.h 第 266 行定义.

NETemplateStreams

using neroom::NETemplateStreams

初始值:

 struct taNETemplateStreams {
    NETemplateStream audio;    
    NETemplateStream video;    
    NETemplateStream subVideo; 
}

模板成员流配置

在文件 base_type_defines.h 第 273 行定义.

NEVideoDeviceTransportType

using neroom::NEVideoDeviceTransportType

初始值:

 enum tagNEVideoDeviceTransportType {
    kNEVideoDeviceTransportTypeUnknown = 0, 
    kNEVideoDeviceTransportTypeUSB = 1,     
    kNEVideoDeviceTransportTypeVirtual = 2, 
    kNEVideoDeviceTransportTypeOther = 3,   
}

视频设备链接类型

在文件 base_type_defines.h 第 176 行定义.

NEVideoFramerate

using neroom::NEVideoFramerate

初始值:

 enum {
    kNEVideoFramerateFpsDefault = 0, 
    kNEVideoFramerateFps_7 = 7,      
    kNEVideoFramerateFps_10 = 10,    
    kNEVideoFramerateFps_15 = 15,    
    kNEVideoFramerateFps_24 = 24,    
    kNEVideoFramerateFps_30 = 30,    
    kNEVideoFramerateFps_60 = 60,    
}

视频帧率

在文件 base_type_defines.h 第 884 行定义.

NEVideoMirrorMode

using neroom::NEVideoMirrorMode

初始值:

 enum tagNEVideoMirrorMode {
    kVideoMirrorModeAuto,    
    kVideoMirrorModeEnabled, 
    kVideoMirrorModeDisabled 
}

视频镜像模式

在文件 base_type_defines.h 第 1770 行定义.

NEVideoResolution

using neroom::NEVideoResolution

初始值:

 enum {
    kNEVideoProfileUsingTemplate = -1, 
    kNEVideoProfileLowest = 0,         
    kNEVideoProfileLow = 1,            
    kNEVideoProfileStandard = 2,       
    kNEVideoProfileHD720P = 3,         
    kNEVideoProfileHD1080P = 4,        
    kNEVideoProfile4KUHD = 5,          
    kNEVideoProfile8KUHD = 6,          
    kNEVideoProfileNone = 7,           
    kNEVideoProfileMAX = kNEVideoProfile8KUHD
}

视频分辨率

在文件 base_type_defines.h 第 868 行定义.

NEVideoRotation

using neroom::NEVideoRotation

初始值:

 enum {
    kNEVideoRotation_0 = 0,     
    kNEVideoRotation_90 = 90,   
    kNEVideoRotation_180 = 180, 
    kNEVideoRotation_270 = 270, 
}

视频帧旋转角度

在文件 base_type_defines.h 第 141 行定义.

NEVideoScalingMode

using neroom::NEVideoScalingMode

初始值:

 enum tagNEVideoScalingMode {
    kVideoScaleFit, 
    kVideoScaleFullFill, 
    kVideoScaleCropFill  
}

视频缩放模式

在文件 base_type_defines.h 第 1761 行定义.

NEVideoStats

using neroom::NEVideoStats

初始值:

 struct tagNEVideoStats {
    std::string userUuid;   
    uint32_t layerType = 1; 
    uint32_t width = 0;     
    uint32_t height = 0;    
    uint32_t frameRate = 0; 
    uint32_t bitRate = 0;   
}

视频统计数据

在文件 base_type_defines.h 第 966 行定义.

NEVideoStreamType

using neroom::NEVideoStreamType

初始值:

 enum tagNEVideoStreamType {
    kStreamTypeHigh, 
    kStreamLow       
}

视频流类型

在文件 base_type_defines.h 第 1753 行定义.

NEVideoType

using neroom::NEVideoType

初始值:

 enum tagNEVideoType {
    kNEVideoTypeI420 = 0, 
    kNEVideoTypeNV12 = 1, 
    kNEVideoTypeNV21 = 2, 
    kNEVideoTypeBGRA = 3, 
}

视频帧格式

在文件 base_type_defines.h 第 123 行定义.

NEWaitingRoomManagerPtr

using neroom::NEWaitingRoomManagerPtr = std::shared_ptr<INEWaitRoomManager>

等候室主持人成员信息智能指针

在文件 base_type_defines.h 第 2229 行定义.

NEWaitingRoomMemberPtr

using neroom::NEWaitingRoomMemberPtr = std::shared_ptr<INEWaitingRoomMember>

等候室成员信息智能指针

在文件 base_type_defines.h 第 2217 行定义.

NEWhiteboardServerConfig

typedef struct neroom::tagNEWhiteboardServerConfig neroom::NEWhiteboardServerConfig

白板服务器配置

SharedChatMessagePtr

using neroom::SharedChatMessagePtr = std::shared_ptr<INERoomChatMessage>

聊天室消息智能指针

在文件 base_type_defines.h 第 709 行定义.

SharedMemberPtr

using neroom::SharedMemberPtr = std::shared_ptr<INERoomMember>

房间用户信息智能指针

在文件 base_type_defines.h 第 853 行定义.

枚举类型说明

GetMemberOrientation

enum neroom::GetMemberOrientation

获取成员列表的排序方式

自从

v1.25.0

枚举值
kNERoomGetMemberOriDesc	按照加入时间降序排列
kNERoomGetMemberOriAsc	按照加入时间升序排列

在文件 waiting_room_ctrl_interface.h 第 22 行定义.

NEChatroomType

enum neroom::NEChatroomType

枚举值
kUnknown	未知聊天室
kMeetingRoom	会议中聊天室
kWaitingRoom	等候室聊天室

在文件 base_type_defines.h 第 446 行定义.

NEEncryptionType

enum neroom::NEEncryptionType

RTC 流加密类型

枚举值
kNEEncryptionTypeGMCryptoSM4ECB	国密 SM4-ECB 加密

在文件 base_type_defines.h 第 2058 行定义.

NELogLevel

enum neroom::NELogLevel

日志等级

枚举值
NEVERBOSE
NEDEBUG
NEINFO
NEWARNING
NEERROR

在文件 room_kit_interface.h 第 28 行定义.

NEMessageSearchOrder

enum neroom::NEMessageSearchOrder

检索聊天室消息的排序规则

枚举值
kNEMessageSearchOrderDesc	降序
kNEMessageSearchOrderAsc	升序

在文件 base_type_defines.h 第 421 行定义.

NERecordFileType

enum neroom::NERecordFileType

录制文件类型

枚举值
kNERecordFileUnknown	@biref 未知类型
kNERecordFileTypeAAC	AAC 类型文件
kNERecordFileTypeMP4	MP4 类型文件
kNERecordFileTypeFLV	FLV 类型文件

在文件 base_type_defines.h 第 2081 行定义.

NERoomChatMessageNotificationType

enum neroom::NERoomChatMessageNotificationType

枚举值
NERoomChatMessageNotificationTypeUnknown	未识别的通知类型，可通过 INERoomChatRoomNotificationItem 的 rawData 字段获取原始内容
NERoomChatMessageNotificationTypeMemberJoin	聊天室有成员进入
NERoomChatMessageNotificationTypeMemberLeave	聊天室有成员退出
NERoomChatMessageNotificationTypeMessageRecall	聊天室有消息被撤回

在文件 base_type_defines.h 第 92 行定义.

NERoomChatMessageType

enum neroom::NERoomChatMessageType

房间聊天室消息类型

枚举值
kNERoomMessageTypeText	文本消息
kNERoomMessageTypeCustom	自定义消息
kNERoomMessageTypeFile	文件类型消息
kNERoomMessageTypeImage	图片类型消息
kNERoomMessageTypeNotification	通知类型消息

在文件 base_type_defines.h 第 79 行定义.

NERoomCloudRecordState

enum neroom::NERoomCloudRecordState

房间云录制状态

枚举值
kNERoomRecordingStart	云录制中
kNERoomRecordingStop	未在云录制

在文件 base_type_defines.h 第 2066 行定义.

NERoomScreenCaptureSourceType

enum neroom::NERoomScreenCaptureSourceType

被共享数据源类型

自从

v1.21.0

枚举值
kNERoomScreenCaptureSourceTypeUnknown	未知类型
kNERoomScreenCaptureSourceTypeWindow	应用窗口
kNERoomScreenCaptureSourceTypeScreen	显示器对应的桌面
kNERoomScreenCaptureSourceTypeCustom	自定义

在文件 base_type_defines.h 第 1817 行定义.

NERoomSessionType

enum neroom::NERoomSessionType

枚举值
kNERoomSessionTypeNone
kNERoomSessionTypeP2P

在文件 message_service_interface.h 第 20 行定义.

NERoomSipDeviceInviteProtocolType

enum class neroom::NERoomSipDeviceInviteProtocolType

strong

设备地址呼叫协议，1=ip/uri 2=H.323

自从

v1.32.0

枚举值
kIp
kH323

在文件 base_type_defines.h 第 2254 行定义.

NEWaitingRoomMemberStateChangeReason

enum neroom::NEWaitingRoomMemberStateChangeReason

成员状态变更原因

枚举值
kReasonBySelf	自动进入/自动离开等候室
kReasonPuttedIn	在会议中被管理员移至等候室
kReasonSelfKicked	同账号互踢
kReasonExpelled	在等候室中被管理员移出
kReasonTimeout	超时
kReasonPermit	被管理员准入
kReasonAllKicked	被管理员全部移除

在文件 base_type_defines.h 第 2150 行定义.

NEWaitingRoomState

enum neroom::NEWaitingRoomState

等候室成员状态

自从

v1.25.0

枚举值
kStatusNone	未在等候室
kStatusWaiting	等候中
kStatusAdmitted	被管理准入，加入中
kStatusLeft	已离开

在文件 base_type_defines.h 第 2136 行定义.

tagNEAuthEvent

enum class neroom::tagNEAuthEvent

strong

登录状态

枚举值
kAuthKickOut	被踢出登录
kAuthUnauthorized	授权过期或失败
kAuthForbidden	服务端禁止登录
kAuthAccountTokenError	账号或密码错误
kAuthLoggedIn	登录成功
kAuthLoggedOut	未登录

在文件 auth_service_interface.h 第 23 行定义.

tagNEChatRoomMemberQueryType

enum neroom::tagNEChatRoomMemberQueryType

聊天室成员类型

枚举值
kNormal	固定成员（包括创建者,管理员,普通等级用户,受限用户(禁言+黑名单),即使非在线也可以在列表中看到,有数量限制 ）
kOnlineNormal	仅在线的固定成员
kGuestDesc	非固定成员 (又称临时成员,只有在线时才能在列表中看到,数量无上限) 按照进入聊天室时间倒序排序，进入时间越晚的越靠前
kGuestAsc	非固定成员 (又称临时成员,只有在线时才能在列表中看到,数量无上限) 按照进入聊天室时间顺序排序，进入时间越早的越靠前

在文件 chat_ctrl_interface.h 第 23 行定义.

tagNERoomLiveStreamAudioCodecProfile

enum neroom::tagNERoomLiveStreamAudioCodecProfile

音频编码规格

枚举值
kProfileLCAAC	LC-AAC 规格，表示基本音频编码规格
kProfileHEAAC	HE-AAC 规格，表示高效音频编码规格

在文件 live_ctrl_interface.h 第 40 行定义.

tagNERoomLiveStreamAudioSampleRate

enum neroom::tagNERoomLiveStreamAudioSampleRate

音频推流采样率

枚举值
kRate32000	采样率为 32 kHz
kRate44100	采样率为 44.1 kHz
kRate48000	采样率为 48 kHz

在文件 live_ctrl_interface.h 第 23 行定义.

tagNERoomLiveStreamMode

enum neroom::tagNERoomLiveStreamMode

直播推流模式

枚举值
kModeVideo	推流带视频
kModeAudio	推流纯音频

在文件 live_ctrl_interface.h 第 32 行定义.

tagNERoomLiveStreamVideoScaleMode

enum neroom::tagNERoomLiveStreamVideoScaleMode

直播推流视频和画布的调节属性

枚举值
kScaleFit	视频尺寸等比缩放。优先保证视频内容全部显示。因视频尺寸与显示视窗尺寸不一致造成的视窗未被填满的区域填充背景色
kScaleCropFill	视频尺寸等比缩放。优先保证视窗被填满。因视频尺寸与显示视窗尺寸不一致而多出的视频将被截掉

在文件 live_ctrl_interface.h 第 48 行定义.

函数说明

__declspec()

neroom::__declspec

(

dllimport

)

创建组件实例

销毁组件实例

返回

INERoomKit* 组件对象

void