netease_roomkit library

Classes

MERoomVideoStrategyContext
视频订阅策略：订阅上下文
NEAuthService
用户鉴权服务
NEChatroomHistoryMessageSearchOption
查询聊天室历史消息选项
NEChatroomMember
NEConnectedDevice
多设备入会的设备信息
NECreateAudioEffectOption
NECreateAudioMixingOption
NECreateRoomOptions
NECreateRoomParams
创建房间参数
NECustomMessage
NECustomSessionMessage
NEDomainInfo
NEDomainItem
NEErrorCode
NEIMServerConfig
IM 服务器配置项
NEInjectedAuthorization
跨应用加房间所需的鉴权信息，包含房间所属的AppKey以及身份验证信息。
NEInRoomDeviceListItem
房间内的设备列表信息
NEJoinRoomOptions
加入房间选项
NEJoinRoomParams
加入房间参数
NELeaveRoomType
离开房间的类型定义
NEMemberVolumeInfo
用户音量信息
NEMessageChannelCallback
NEMessageChannelService
消息通道服务
NEMixPushConfig
服务器配置
NENosService
NEPreviewRoomContext
当前预览房间的上下文
NEPreviewRoomEventCallback
预览房间事件监听器
NEPreviewRoomOptions
预览房间选项
NEPreviewRoomParams
预览房间参数
NEPreviewRoomRtcController
NERecordFileInfo
NERoomAnnotationController
批注控制器
NERoomAppInviteController
SIP外呼控制器
NERoomBaseController
NERoomBaseRtcController
NERoomCaptionErrorCode
字幕状态变更事件错误码
NERoomCaptionMessage
字幕消息对象
NERoomCaptionState
字幕状态变更事件状态值
NERoomCaptionTranslationConfig
字幕翻译配置
NERoomChatController
NERoomChatCustomMessage
房间自定义消息
NERoomChatEventType
聊天室消息操作类型
NERoomChatFileMessage
房间文件消息
NERoomChatImageMessage
房间图片消息
NERoomChatMessage
房间消息基类
NERoomChatNotificationMessage
房间通知消息
NERoomChatTextMessage
房间文本消息
NERoomContext
当前房间的上下文
NERoomContextProvider
An InheritedWidget which provides NERoomContext instance
NERoomEventCallback
房间事件监听器
NERoomFocusStrategy
视频订阅策略：焦点订阅
NERoomGetMessagesHistoryParam
查询消息的参数
NERoomKit
RoomKit 入口类
NERoomKitLoader
NERoomKitOptions
提供初始化配置 appKey appKey useAssetServerConfig 是否读取私有化配置文件，默认为false serverConfig 服务器配置项 serverUrl 服务器配置项 extras 预留字段 apnsCerName APNS推送证书名称（仅iOS有效） mixPushConfig 通知推送配置
NERoomKitServerConfig
RoomKit 服务器配置
NERoomLanguage
组件支持的语言类型
NERoomLiveConfig
音视频流编码参数等设置
NERoomLiveController
NERoomLiveInfo
NERoomLiveRequest
NERoomLiveStreamImageInfo
图片布局
NERoomLiveStreamLayout
直播布局
NERoomLiveStreamTaskInfo
直播推流任务的配置
NERoomLiveStreamUserTranscoding
直播成员布局
NERoomMember
房间成员
NERoomRecentSession
最近联系人消息变更
NERoomRecord
NERoomRecordConfig
开启录制请求配置
NERoomRecordMode
录制模式
NERoomRole
房间角色
NERoomRtcAudioProfile
NERoomRtcAudioScenario
NERoomRtcChannelProfile
通信场景
NERoomRtcClientRole
RTC 用户角色
NERoomRtcController
NERoomRtcLastmileProbeConfig
网络探测配置
NERoomRtcMediaPublishType
房间RTC媒体发布类型
NERoomRtcNetworkQualityInfo
NERoomRtcStats
NERoomRtcStatsCallback
统计数据监听器
NERoomRtcTransportType
云代理模式
NERoomSeatController
NERoomService
房间服务
NERoomSIPCallInfo
呼叫的服务器响应结果
NERoomSIPController
SIP外呼控制器
NERoomSystemDevice
房间呼叫设备
NERoomUserVideoStreamSubscriber
be responsible for subscribe/unsubscribe video (sub)stream
NERoomUserVideoStreamSubscriberProvider
NERoomUserVideoView
user video view widget it automatically subscribe and unsubscribe video stream for user
NERoomUserVideoViewListener
视频渲染事件监听器
NERoomVideoConfig
NERoomVideoOrderStrategy
视频订阅策略：视频跟随模式
NERoomVideoStrategy
视频订阅策略
NERoomVideoStrategyRegistry
NERoomVideoSubStreamConfiguration
本地辅流发送配置
NERoomVirtualBackgroundSource
NERoomVirtualBackgroundSourceStateReason
NERoomVirtualBackgroundType
NERoomWhiteboardBaseController
NERoomWhiteboardController
白板控制器
NERtcServerConfig
RTC 服务器配置
NERtcVideoRenderer
视频渲染画布
NERtcVideoRendererEventListener
视频渲染事件监听器
NERtcVideoRendererFactory
视频画布创建工厂
NERtcVideoView
视频渲染视图
NESDKVersions
版本信息 imVersion IM版本 rtcVersion rtc版本 whiteboardVersion 白板版本 roomKitVersion platform roomKit版本 fltRoomKitVersion flutter roomKit版本
NESeatEventCallback
麦位监听器
NESeatInitParams
麦位配置信息，用于创建房间时进行麦位初始化。 @property seatCount 麦位数量 @property seatRequestApprovalMode 麦位申请审批模式, 参考NESeatRequestApprovalMode @property seatInvitationConfirmMode 麦位邀请确认模式, 参考NESeatInvitationConfirmMode
NESeatInvitationConfirmMode
麦位邀请确认模式。
NESeatRequestApprovalMode
麦位申请审批模式。
NEServerConfig
服务器配置
NEWaitingRoomConstants
NEWaitingRoomController
等候室功能控制器
NEWaitingRoomHost
等候室主持人对象
NEWaitingRoomInfo
等候室房间信息
NEWaitingRoomMember
等候室成员对象
NEWhiteboardAppConfig
白板共享配置
NEWhiteboardServerConfig
G2 白板 服务器配置
NEWhiteboardView
NormalStrategy
视频订阅策略：常规订阅
SubscribeCacheUser
视频订阅用户缓存对象

Enums

NEAudioDumpType
房间音频dump文件类型
NEAudioOutputDevice
本地音频输出设备
NEAuthEvent
登录鉴权事件
NEChatroomMemberQueryType
房间音频dump文件类型
NEChatroomMessageSearchOrder
聊天室消息搜索顺序
NEChatroomType
聊天室消息 tag，默认内置等候室和聊天室
NEClientType
用户的终端类型
NEEncryptionMode
NEMessageSearchOrder
搜索顺序
NERoomAudioAINSMode
智能降噪类型枚举
NERoomBeautyEffectType
NERoomCameraPosition
NERoomCaptionTranslationLanguage
字幕目标翻译语言枚举
NERoomChatMessageType
房间消息类型枚举
NERoomCloudRecordState
房间云录制状态
NERoomEndReason
房间结束原因枚举
NERoomLiveLayout
NERoomLiveState
NERoomLiveStreamAudioCodecProfile
直播推流音频编码规格
NERoomLiveStreamAudioSampleRate
直播推流音频采样率
NERoomLiveStreamMode
直播推流模式
NERoomLiveStreamVideoScaleMode
直播推流视频和画布的适应属性
NERoomMemberInviteState
成员子状态，用于标记成员被邀请的状态
NERoomRtcAudioStreamType
音频流类型
NERoomSessionTypeEnum
会话消息类型
NERtcAudioProfile
音频属性。设置采样率，码率，编码模式和声道数
NERtcAudioScenario
音频应用场景
NERtcServerRecordMode
服务器录制模式
NERtcVideoViewFitType
视频画布缩放方式
NEVideoStreamLayerCount
视频流模式
NEVideoStreamType
订阅视频流类型

Functions

convertToNEChatroomType(ChatroomType type) → NEChatroomType
createMessage(RoomMessage? message) → NERoomChatMessage?
stringToReason(String reason) → NERoomEndReason

Typedefs

ChatroomMessageAttachmentProgressCallback = void Function(String messageUuid, int transferred, int total)
CustomMessageReceiveCallback = void Function(NECustomMessage throughMessage)
IM自定义透传消息回调 throughMessage 透传消息
MemberAppStateChanged = void Function(NERoomMember member, NERoomMember? operateBy)
MemberAudioConnectStateChanged = void Function(NERoomMember member, bool isAudioConnected)
MemberAudioMuteChangedCallback = void Function(NERoomMember member, bool mute, NERoomMember? operateBy)
MemberChatBanChangedCallback = void Function(NERoomMember? member, bool banned, int duration, String? notifyExt, NERoomMember? operateBy)
MemberExtChangedCallback = void Function(NERoomMember member, String? ext)
MemberJoinChatroomCallback = void Function(List<NERoomMember> members)
MemberJoinRoomCallback = void Function(List<NERoomMember> members)
MemberJoinRtcChannelCallback = void Function(List<NERoomMember> members)
MemberLeaveChatroomCallback = void Function(List<NERoomMember> members)
MemberLeaveRoomCallback = void Function(List<NERoomMember> members)
MemberLeaveRtcChannelCallback = void Function(List<NERoomMember> members)
MemberNameChangedCallback = void Function(NERoomMember member, String name, NERoomMember? operateBy)
MemberPropertiesChangedCallback = void Function(NERoomMember member, Map<String, String> properties)
MemberPropertiesDeletedCallback = void Function(NERoomMember member, Map<String, String> properties)
MemberRoleChangedCallback = void Function(NERoomMember member, NERoomRole oldRole, NERoomRole newRole)
MemberScreenShareStateChangedCallback = void Function(NERoomMember member, bool isSharing, NERoomMember? operateBy)
MemberSIPStateChanged = void Function(NERoomMember member, NERoomMember? operateBy)
MemberSystemAudioShareStateChangedCallback = void Function(NERoomMember member, bool isSharing, NERoomMember? operateBy)
MemberVideoMuteChangedCallback = void Function(NERoomMember member, bool mute, NERoomMember? operateBy)
MemberWhiteboardShareStateChangedCallback = void Function(NERoomMember member, bool isSharing, NERoomMember? operateBy)
NetworkQualityCallback = void Function(List<NERoomRtcNetworkQualityInfo> stats)
通话中所有用户的网络状态回调 stats 网络质量统计信息
OnAudioHasHowling = void Function(bool flag)
检测到啸叫回调。 当声源与扩音设备之间因距离过近时，可能会产生啸叫。 当 SDK 检测到有啸叫信号产生的时候，自动触发该回调直至啸叫停止。
OnCaptionStateChanged = void Function(int state, int code, String? message)
开启/关闭字幕状态变更通知
OnMemberConnectedDeviceListChanged = void Function(NERoomMember member)
成员多设备连接状态变化回调
OnReceiveCaptionMessages = void Function(String? channel, List<NERoomCaptionMessage> captionMessages)
接收到字幕消息
OnRoomMultiDeviceEnableChanged = void Function(bool enabled)
房间多设备入会状态变化回调
OnRtcAudioEffectFinished = void Function(int effectId)
音效播放完成通知
ReceiveChatroomMessagesCallback = void Function(List<NERoomChatMessage> messages)
RoomAnnotationChangedCallback = void Function(bool enabled, NERoomMember? operateBy)
RoomBlacklistStateChanged = void Function(bool isEnable)
RoomCloudRecordStateChanged = void Function(NERoomCloudRecordState state, NERoomMember? operateBy)
RoomConnectStateChanged = void Function(int state)
RoomEndCallback = void Function(NERoomEndReason reason, String? extra)
RoomExtChangedCallback = void Function(String ext)
RoomLiveStateChangedCallback = void Function(NERoomLiveState state)
RoomLockStateChangedCallback = void Function(bool isLocked)
RoomMaxMembersChangedCallback = void Function(int maxMembers)
RoomNameChangedCallback = void Function(String name)
RoomPropertiesChangedCallback = void Function(Map<String, String> properties)
RoomPropertiesDeletedCallback = void Function(Map<String, String> properties)
RoomRemainingSecondsRenewCallback = void Function(int duration)
RtcAudioMixingStateChangedCallback = void Function(int reason)
RtcAudioOutputDeviceChangedCallback = void Function(NEAudioOutputDevice device)
RtcChannelDisconnectCallback = void Function(String? channel, int reason)
RtcChannelErrorCallback = void Function(String? channel, int code)
RtcLastmileProbeResultCallback = void Function(NERoomRtcLastmileProbeResult result)
RtcLastmileQualityCallback = void Function(NERoomRtcNetworkStatusType status)
RtcLocalAudioVolumeIndicationCallback = void Function(String? channel, int volume, bool enableVad)
RtcRemoteAudioVolumeIndicationCallback = void Function(String? channel, List<NEMemberVolumeInfo> volumes, int totalVolume)
RtcStatsCallback = void Function(NERoomRtcStats stats)
当前通话统计回调,SDK 定期向 App 报告当前通话的统计信息，每 2 秒触发一次 stats 通话相关的统计信息
RtcVirtualBackgroundSourceEnabledCallback = void Function(bool enabled, int reason)
SeatInvitationAcceptedCallback = void Function(int seatIndex, String user, bool isAutoAgree)
SeatInvitationCancelledCallback = void Function(int seatIndex, String user, String operateBy)
SeatInvitationReceivedCallback = void Function(int seatIndex, String user, String operateBy)
SeatInvitationRejectedCallback = void Function(int seatIndex, String user)
SeatKickedCallback = void Function(int seatIndex, String user, String operateBy)
SeatLeaveCallback = void Function(int seatIndex, String user)
SeatListChangedCallback = void Function(List<NESeatItem> seatItems)
SeatManagerAddedCallback = void Function(List<String?> managers)
SeatManagerRemovedCallback = void Function(List<String?> managers)
SeatRequestApprovedCallback = void Function(int seatIndex, String user, String operateBy, bool isAutoAgree)
SeatRequestCancelledCallback = void Function(int seatIndex, String user)
SeatRequestRejectedCallback = void Function(int seatIndex, String user, String operateBy)
SeatRequestSubmittedCallback = void Function(int seatIndex, String user)
SessionMessageAllDeletedCallback = void Function(String sessionId, NERoomSessionTypeEnum sessionType)
删除所有消息回调
SessionMessageDeletedCallback = void Function(NECustomSessionMessage? sessionCustomMessage)
IM删除消息回调 sessionChangeMessage 自定义会话消息
SessionMessageReceivedCallback = void Function(NECustomSessionMessage sessionCustomMessage)
IM自定义消息回调 sessionCustomMessage 自定义会话消息
SessionMessageRecentChangedCallback = void Function(List<NERoomRecentSession> recentSessionChangeMessageList)
IM自定义消息回调 sessionCustomMessage 自定义会话消息
WhiteboardErrorCallback = void Function(int code, String? msg)
WhiteboardShowFileChooserCallback = Future<String?> Function(List<String?> types)