NEVoiceRoomKit class abstract

VoiceRoomKit入口

Constructors

NEVoiceRoomKit()

Properties

allMemberList → List<NEVoiceRoomMember>?

所有成员（包括本端）加入房间后获取

no setter

hashCode → int

The hash code for this object.

no setter, inherited

isInitialized → bool

初始化状态

no setter

isLoggedIn → Future<bool>

是否已经登录

no setter

localMember → NEVoiceRoomMember?

本端成员信息

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addAuthListener(NEVoiceRoomAuthEventCallback callback) → void

添加登录状态监听 @param callback 监听器

addVoiceRoomListener(NEVoiceRoomEventCallback callback) → void

注册房间监听
使用前提：该方法仅在调用login方法登录成功后调用有效 @param callback 监听器

adjustRecordingSignalVolume(int volume) → Future<VoidResult>

调节人声音量
使用前提：该方法仅在调用login方法登录成功且上麦成功后调用有效 @param volume 音量 范围0-100 默认100 @return 0：方法调用成功。其他：方法调用失败

approveSeatRequest(String account) → Future<VoidResult>

同意上麦
使用前提：该方法仅在调用login方法登录成功后调用有效 @param account 被同意上麦的用户account
相关回调：房主同意申请上麦后，房间内所有成员会触发NEVoiceRoomEventCallback.seatRequestApprovedCallback回调和NEVoiceRoomEventCallback.seatListChangedCallback回调
注意事项：只有房主能执行该操作

banRemoteAudio(String account) → Future<VoidResult>

禁用指定成员音频
使用前提：该方法仅在调用login方法登录成功后调用有效 @param account 成员
注意事项：只有房主能执行该操作
相关回调：禁用指定成员音频后，房间内所有成员会触发NEVoiceRoomEventCallback.memberAudioBannedCallback回调

cancelSeatRequest() → Future<VoidResult>

取消申请上麦
使用前提：该方法仅在调用login方法登录成功后调用有效
相关回调：取消申请上麦后，房间内所有成员会触发NEVoiceRoomEventCallback.seatRequestCancelledCallback回调和NEVoiceRoomEventCallback.seatListChangedCallback回调
注意事项：只有非房主能执行该操作

closeSeats(List<int> seatIndices) → Future<VoidResult>

关闭麦位
使用前提：该方法仅在调用login方法登录成功后调用有效
注意事项：只有房主能执行该操作
相关回调：关闭麦位后，房间内所有成员会触发NEVoiceRoomEventCallback.seatListChangedCallback回调

createRoom(NECreateVoiceRoomParams params, NECreateVoiceRoomOptions options) → Future<NEResult<NEVoiceRoomInfo>>

创建房间
使用前提：该方法仅在调用login方法登录成功后调用有效 @param params 创建房间参数配置NECreateVoiceRoomParams @param options 进入房间时的必要配置NECreateVoiceRoomOptions
注意事项：只有房主能执行该操作

disableEarback() → Future<VoidResult>

关闭耳返功能。 @return 0：方法调用成功。其他：方法调用失败

enableEarback(int volume) → Future<VoidResult>

开启耳返功能。
开启耳返功能后，必须连接上耳机或耳麦，才能正常使用耳返功能。 @param volume 设置耳返音量，可设置为 0~100，默认为 100。 @return 0：方法调用成功。其他：方法调用失败

endRoom() → Future<VoidResult>

结束房间 房主权限
使用前提：该方法仅在调用login方法登录成功后调用有效
相关回调：离开房间成功后，会触发NEVoiceRoomEventCallback.roomEndedCallback回调
注意事项：只有房主能执行该操作

getAudioMixingVolume() → int

获取伴奏音量 @return 伴奏音量

getCreateRoomDefaultInfo() → Future<NEResult<NEVoiceCreateRoomDefaultInfo>>

获取创建房间的默认信息
使用前提：该方法仅在调用login方法登录成功后调用有效

getEffectVolume() → int

获取音效音量 @return 音效音量

getRecordingSignalVolume() → int

获取人声音量 @return 人声音量

getSeatInfo() → Future<NEResult<NEVoiceRoomSeatInfo>>

获取麦位信息。
使用前提：该方法仅在调用login方法登录成功后调用有效

getSeatRequestList() → Future<NEResult<List<NEVoiceRoomSeatRequestItem>>>

获取麦位申请列表。按照申请时间正序排序，先申请的成员排在列表前面。
使用前提：该方法仅在调用login方法登录成功后调用有效

getVoiceRoomList(NEVoiceRoomLiveState liveState, int pageNum, int pageSize) → Future<NEResult<NEVoiceRoomList>>

获取房间列表
使用前提：该方法仅在调用login方法登录成功后调用有效 @param liveState 直播状态 (直播状态) NEVoiceRoomLiveState @param pageNum 页码 @param pageSize 页大小,一页包含多少条

initialize(NEVoiceRoomKitOptions options) → Future<VoidResult>

初始化 options 初始化参数

isEarbackEnable() → bool

是否开启耳返功能 @return true 开启 false 关闭

joinRoom(NEJoinVoiceRoomParams params, NEJoinVoiceRoomOptions options) → Future<NEResult<NEVoiceRoomInfo>>

加入房间
使用前提：该方法仅在调用login方法登录成功后调用有效 @param params 加入房间参数配置NEJoinVoiceRoomParams @param options 进入房间时的必要配置NEJoinVoiceRoomOptions
相关回调：加入房间成功后，会触发NEVoiceRoomEventCallback.memberJoinRoomCallback回调

kickSeat(String account) → Future<VoidResult>

踢麦
使用前提：该方法仅在调用login方法登录成功后调用有效 @param account 被踢用户的uid
相关回调：房主踢麦后，房间内所有成员会触发NEVoiceRoomEventCallback.seatKickedCallback回调和NEVoiceRoomEventCallback.seatListChangedCallback回调
注意事项：只有房主能执行该操作

leaveRoom() → Future<VoidResult>

离开房间
使用前提：该方法仅在调用joinRoom方法加入房间成功后调用有效
相关回调：离开房间成功后，会触发NEVoiceRoomEventCallback.memberLeaveRoomCallback回调

leaveSeat() → Future<VoidResult>

下麦
使用前提：该方法仅在调用login方法登录成功后调用有效
相关回调：房主踢麦后，房间内所有成员会触发NEVoiceRoomEventCallback.seatLeaveCallback回调和NEVoiceRoomEventCallback.seatListChangedCallback回调

login(String account, String token) → Future<VoidResult>

登录

logout() → Future<VoidResult>

登出
相关回调：登出成功后，会触发NEVoiceRoomAuthListener.onVoiceRoomAuthEvent回调

muteMyAudio() → Future<VoidResult>

关闭自己的麦克风
使用前提：该方法仅在调用login方法登录成功且上麦成功后调用有效
相关回调：调用该方法后，本端和其他上麦用户会触发NEVoiceRoomEventCallback.memberAudioMuteChangedCallback回调

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

openSeats(List<int> seatIndices) → Future<VoidResult>

打开麦位
使用前提：该方法仅在调用login方法登录成功后调用有效 @param seatIndices 麦位序号
注意事项：只有房主能执行该操作
相关回调：打开麦位后，房间内所有成员会触发NEVoiceRoomEventCallback.seatListChangedCallback回调

pauseAudioMixing() → Future<VoidResult>

暂停播放音乐文件及混音。 @return 0：方法调用成功。其他：方法调用失败

playEffect(int effectId, NEVoiceRoomCreateAudioEffectOption option) → Future<VoidResult>

播放指定音效文件。 该方法播放指定的本地或在线音效文件。 支持的音效文件类型包括 MP3、M4A、AAC、3GP、WMA 和 WAV 格式，支持本地 SD 卡中的文件和在线 URL @param effectId 指定音效的 ID。每个音效均应有唯一的 ID。 @param option 音效相关参数，包括混音任务类型、混音文件路径等。 @return 0：方法调用成功。其他：方法调用失败

rejectSeatRequest(String account) → Future<VoidResult>

拒绝上麦
使用前提：该方法仅在调用login方法登录成功后调用有效 @param account 被拒绝上麦的用户account
相关回调：房主拒绝申请上麦后，房间内所有成员会触发NEVoiceRoomEventCallback.seatRequestRejectedCallback回调和NEVoiceRoomEventCallback.seatListChangedCallback回调
注意事项：只有房主能执行该操作

removeAuthListener(NEVoiceRoomAuthEventCallback callback) → void

移除登录状态监听 @param callback 监听器

removeVoiceRoomListener(NEVoiceRoomEventCallback callback) → void

移除房间监听
使用前提：该方法仅在调用login方法登录成功后调用有效 @param callback 监听器

resumeAudioMixing() → Future<VoidResult>

恢复播放伴奏。 该方法恢复混音，继续播放伴奏。请在房间内调用该方法。 @return 0：方法调用成功。其他：方法调用失败

sendSeatInvitation(int seatIndex, String account) → Future<VoidResult>

房主向成员account发送上麦邀请，指定位置为seatIndex，非管理员执行该操作会失败。
使用前提：该方法仅在调用login方法登录成功后调用有效 @param seatIndex 麦位位置。 @param account 麦上的用户ID。
相关回调：邀请上麦后，观众同意后（组件默认自动接收邀请），房间内所有成员会触发NEVoiceRoomEventCallback.seatInvitationAcceptedCallback回调和NEVoiceRoomEventCallback.seatListChangedCallback回调

sendTextMessage(String content) → Future<VoidResult>

发送聊天室消息
使用前提：该方法仅在调用login方法登录成功后调用有效 @param content 消息内容
相关回调：调用改方法后，房间内其他成员都会触发NEVoiceRoomEventCallback.receiveTextMessageCallback回调

setAudioMixingVolume(int volume) → Future<VoidResult>

设置伴奏音量。 该方法调节混音里伴奏的音量大小。 setAudioMixingSendVolume setAudioMixingPlaybackVolume @param volume 伴奏发送音量。取值范围为 0~200。默认 100，即原始文件音量。 @return 0：方法调用成功。其他：方法调用失败

setEffectVolume(int effectId, int volume) → Future<VoidResult>

设置音效音量 @param effectId Int @param volume Int 默认 100 @return 0：方法调用成功。其他：方法调用失败

startAudioMixing(NEVoiceRoomCreateAudioMixingOption option) → Future<VoidResult>

开始播放音乐文件。 该方法指定本地或在线音频文件来和录音设备采集的音频流进行混音。 支持的音乐文件类型包括 MP3、M4A、AAC、3GP、WMA 和 WAV 格式，支持本地文件或在线 URL。 @param option 创建混音任务配置的选项，包括混音任务类型、混音文件全路径或 URL 等，详细信息请参考 audio.NERtcCreateAudioMixingOption。 @return 0：方法调用成功。其他：方法调用失败

stopAllEffect() → Future<VoidResult>

停止所有音效 @return 0：方法调用成功。其他：方法调用失败

stopAudioMixing() → Future<VoidResult>

停止播放伴奏。 该方法停止混音，停止播放伴奏。请在房间内调用该方法。 @return 0：方法调用成功。其他：方法调用失败

stopEffect(int effectId) → Future<VoidResult>

停止指定id的音效 @param effectId 音效Id @return 0：方法调用成功。其他：方法调用失败

submitSeatRequest(int seatIndex, bool exclusive) → Future<VoidResult>

成员申请指定位置为seatIndex的麦位，位置从1开始。 如果当前成员为管理员，则会自动通过申请。
使用前提：该方法仅在调用login方法登录成功后调用有效 @param seatIndex 麦位位置。 @param exclusive 是否独占的。
相关回调：申请上麦后，房间内所有成员会触发NEVoiceRoomEventCallback.seatRequestSubmittedCallback回调和NEVoiceRoomEventCallback.seatListChangedCallback回调

toString() → String

A string representation of this object.

inherited

unbanRemoteAudio(String account) → Future<VoidResult>

解禁指定成员的音频
使用前提：该方法仅在调用login方法登录成功后调用有效 @param account 成员
注意事项：只有房主能执行该操作
相关回调：解禁指定成员的音频后，房间内所有成员会触发NEVoiceRoomEventCallback.memberAudioBannedCallback回调

unmuteMyAudio() → Future<VoidResult>

打开自己的麦克风
使用前提：该方法仅在调用login方法登录成功且上麦成功后调用有效
相关回调：调用该方法后，本端和其他上麦用户会触发NEVoiceRoomEventCallback.memberAudioMuteChangedCallback回调

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

instance → NEVoiceRoomKit

获取全局唯一的 NEVoiceRoomKit 实例

no setter