Method Detail

• initialize

   abstract Unit initialize(Context context, NEVoiceRoomKitConfig config, NEVoiceRoomCallback<Unit> callback)

  NEVoiceRoomKit 初始化

  Parameters:

  context - 上下文

  config - 初始化配置 NEVoiceRoomKitConfig

  callback - 回调

• addAuthListener

   abstract Unit addAuthListener(NEVoiceRoomAuthListener listener)

  添加登录状态监听

  Parameters:

  listener - 监听器

• removeAuthListener

   abstract Unit removeAuthListener(NEVoiceRoomAuthListener listener)

  移除登录状态监听

  Parameters:

  listener - 监听器

• addVoiceRoomListener

   abstract Unit addVoiceRoomListener(NEVoiceRoomListener listener)

  注册房间监听 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  listener - 监听器

• removeVoiceRoomListener

   abstract Unit removeVoiceRoomListener(NEVoiceRoomListener listener)

  移除房间监听 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  listener - 监听器

• login

   abstract Unit login(String account, String token, NEVoiceRoomCallback<Unit> callback)

  登录

  Parameters:

  account - NERoom登录账号

  token - NERoom token

  callback - 回调 <br>相关回调：登录成功后，会触发NEVoiceRoomAuthListener.onVoiceRoomAuthEvent回调

• logout

   abstract Unit logout(NEVoiceRoomCallback<Unit> callback)

  登出

  Parameters:

  callback - 回调 <br>相关回调：登出成功后，会触发NEVoiceRoomAuthListener.onVoiceRoomAuthEvent回调

• getVoiceRoomList

   abstract Unit getVoiceRoomList(NEVoiceRoomLiveState liveState, Integer liveType, Integer pageNum, Integer pageSize, NEVoiceRoomCallback<NEVoiceRoomList> callback)

  获取房间列表 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  liveState - 直播状态 (直播状态) NEVoiceRoomLiveState

  liveType - 直播类型，2表示语聊房，5表示一起听

  pageNum - 页码

  pageSize - 页大小,一页包含多少条

  callback - 回调

• createRoom

   abstract Unit createRoom(NECreateVoiceRoomParams params, NECreateVoiceRoomOptions options, NEVoiceRoomCallback<NEVoiceRoomInfo> callback)

  创建房间 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  params - 创建房间参数配置NECreateVoiceRoomParams

  options - 进入房间时的必要配置NECreateVoiceRoomOptions

  callback - 回调 <br>注意事项：只有房主能执行该操作

• getCreateRoomDefaultInfo

   abstract Unit getCreateRoomDefaultInfo(NEVoiceRoomCallback<NEVoiceCreateRoomDefaultInfo> callback)

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

  Parameters:

  callback - 回调

• joinRoom

   abstract Unit joinRoom(NEJoinVoiceRoomParams params, NEJoinVoiceRoomOptions options, NEVoiceRoomCallback<NEVoiceRoomInfo> callback)

  加入房间 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  params - 加入房间参数配置NEJoinVoiceRoomParams

  options - 进入房间时的必要配置NEJoinVoiceRoomOptions

  callback - 回调 <br>相关回调：加入房间成功后，会触发NEVoiceRoomListener.onMemberJoinRoom回调

• leaveRoom

   abstract Unit leaveRoom(NEVoiceRoomCallback<Unit> callback)

  离开房间 <br>使用前提：该方法仅在调用joinRoom方法加入房间成功后调用有效

  Parameters:

  callback - 回调 <br>相关回调：离开房间成功后，会触发NEVoiceRoomListener.onMemberLeaveRoom回调

• getRoomInfo

   abstract Unit getRoomInfo(Long liveRecordId, NEVoiceRoomCallback<NEVoiceRoomInfo> callback)

  获取房间信息

  Parameters:

  liveRecordId - 直播Id

  callback - 回调

• endRoom

   abstract Unit endRoom(NEVoiceRoomCallback<Unit> callback)

  结束房间 房主权限 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  callback - 回调 <br>相关回调：离开房间成功后，会触发NEVoiceRoomListener.onRoomEnded回调 <br>注意事项：只有房主能执行该操作

• getSeatInfo

   abstract Unit getSeatInfo(NEVoiceRoomCallback<NEVoiceRoomSeatInfo> callback)

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

  Parameters:

  callback - 回调。

• getSeatRequestList

   abstract Unit getSeatRequestList(NEVoiceRoomCallback<List<NEVoiceRoomSeatRequestItem>> callback)

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

  Parameters:

  callback - 回调。

• sendSeatInvitation

   abstract Unit sendSeatInvitation(Integer seatIndex, String account, NEVoiceRoomCallback<Unit> callback)

  房主向成员account发送上麦邀请，指定位置为seatIndex，非管理员执行该操作会失败。 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  seatIndex - 麦位位置。

  account - 麦上的用户ID。

  callback - 回调。 <br>相关回调：邀请上麦后，观众同意后（组件默认自动接收邀请），房间内所有成员会触发NEVoiceRoomListener.onSeatInvitationAccepted回调和NEVoiceRoomListener.onSeatListChanged回调

• submitSeatRequest

   abstract Unit submitSeatRequest(Integer seatIndex, Boolean exclusive, NEVoiceRoomCallback<Unit> callback)

  成员申请指定位置为seatIndex的麦位，位置从1开始。 如果当前成员为管理员，则会自动通过申请。 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  seatIndex - 麦位位置。

  exclusive - 是否独占的。

  callback - 回调。 <br>相关回调：申请上麦后，房间内所有成员会触发NEVoiceRoomListener.onSeatRequestSubmitted回调和NEVoiceRoomListener.onSeatListChanged回调

• cancelSeatRequest

   abstract Unit cancelSeatRequest(NEVoiceRoomCallback<Unit> callback)

  取消申请上麦 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  callback - 回调 <br>相关回调：取消申请上麦后，房间内所有成员会触发NEVoiceRoomListener.onSeatRequestCancelled回调和NEVoiceRoomListener.onSeatListChanged回调 <br>注意事项：只有非房主能执行该操作

• approveSeatRequest

   abstract Unit approveSeatRequest(String account, NEVoiceRoomCallback<Unit> callback)

  同意上麦 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  account - 被同意上麦的用户account

  callback - 回调 <br>相关回调：房主同意申请上麦后，房间内所有成员会触发NEVoiceRoomListener.onSeatRequestApproved回调和NEVoiceRoomListener.onSeatListChanged回调 <br>注意事项：只有房主能执行该操作

• rejectSeatRequest

   abstract Unit rejectSeatRequest(String account, NEVoiceRoomCallback<Unit> callback)

  拒绝上麦 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  account - 被拒绝上麦的用户account

  callback - 回调 <br>相关回调：房主拒绝申请上麦后，房间内所有成员会触发NEVoiceRoomListener.onSeatRequestRejected回调和NEVoiceRoomListener.onSeatListChanged回调 <br>注意事项：只有房主能执行该操作

• kickSeat

   abstract Unit kickSeat(String account, NEVoiceRoomCallback<Unit> callback)

  踢麦 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  account - 被踢用户的uid

  callback - 回调 <br>相关回调：房主踢麦后，房间内所有成员会触发NEVoiceRoomListener.onSeatKicked回调和NEVoiceRoomListener.onSeatListChanged回调 <br>注意事项：只有房主能执行该操作

• leaveSeat

   abstract Unit leaveSeat(NEVoiceRoomCallback<Unit> callback)

  下麦 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  callback - 回调 <br>相关回调：房主踢麦后，房间内所有成员会触发NEVoiceRoomListener.onSeatLeave回调和NEVoiceRoomListener.onSeatListChanged回调

• banRemoteAudio

   abstract Unit banRemoteAudio(String account, NEVoiceRoomCallback<Unit> callback)

  禁用指定成员音频 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  account - 成员

  callback - 回调 <br>注意事项：只有房主能执行该操作 <br>相关回调：禁用指定成员音频后，房间内所有成员会触发NEVoiceRoomListener.onMemberAudioBanned回调

• unbanRemoteAudio

   abstract Unit unbanRemoteAudio(String account, NEVoiceRoomCallback<Unit> callback)

  解禁指定成员的音频 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  account - 成员

  callback - 回调 <br>注意事项：只有房主能执行该操作 <br>相关回调：解禁指定成员的音频后，房间内所有成员会触发NEVoiceRoomListener.onMemberAudioBanned回调

• openSeats

   abstract Unit openSeats(List<Integer> seatIndices, NEVoiceRoomCallback<Unit> callback)

  打开麦位 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  seatIndices - 麦位序号

  callback - 回调 <br>注意事项：只有房主能执行该操作 <br>相关回调：打开麦位后，房间内所有成员会触发NEVoiceRoomListener.onSeatListChanged回调

• closeSeats

   abstract Unit closeSeats(List<Integer> seatIndices, NEVoiceRoomCallback<Unit> callback)

  关闭麦位 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  callback - 回调 <br>注意事项：只有房主能执行该操作 <br>相关回调：关闭麦位后，房间内所有成员会触发NEVoiceRoomListener.onSeatListChanged回调

• sendTextMessage

   abstract Unit sendTextMessage(String content, NEVoiceRoomCallback<Unit> callback)

  发送聊天室消息 <br>使用前提：该方法仅在调用login方法登录成功后调用有效

  Parameters:

  content - 消息内容

  callback - 回调 <br>相关回调：调用改方法后，房间内其他成员都会触发NEVoiceRoomListener.onReceiveTextMessage回调

• muteMyAudio

   abstract Unit muteMyAudio(NEVoiceRoomCallback<Unit> callback)

  关闭自己的麦克风 <br>使用前提：该方法仅在调用login方法登录成功且上麦成功后调用有效

  Parameters:

  callback - 回调 <br>相关回调：调用该方法后，本端和其他上麦用户会触发NEVoiceRoomListener.onMemberAudioMuteChanged回调

• unmuteMyAudio

   abstract Unit unmuteMyAudio(NEVoiceRoomCallback<Unit> callback)

  打开自己的麦克风 <br>使用前提：该方法仅在调用login方法登录成功且上麦成功后调用有效

  Parameters:

  callback - 回调 <br>相关回调：调用该方法后，本端和其他上麦用户会触发NEVoiceRoomListener.onMemberAudioMuteChanged回调

• enableEarback

   abstract Integer enableEarback(Integer volume)

  开启耳返功能。 <br>开启耳返功能后，必须连接上耳机或耳麦，才能正常使用耳返功能。

  Parameters:

  volume - 设置耳返音量，可设置为 0~100，默认为 100。

• disableEarback

   abstract Integer disableEarback()

  关闭耳返功能。

• isEarbackEnable

   abstract Boolean isEarbackEnable()

  是否开启耳返功能

• adjustRecordingSignalVolume

   abstract Integer adjustRecordingSignalVolume(Integer volume)

  调节人声音量 <br>使用前提：该方法仅在调用login方法登录成功且上麦成功后调用有效

  Parameters:

  volume - 音量 范围0-100 默认100

• getRecordingSignalVolume

   abstract Integer getRecordingSignalVolume()

  获取人声音量

• startAudioMixing

   abstract Integer startAudioMixing(NEVoiceRoomCreateAudioMixingOption option)

  开始播放音乐文件。 该方法指定本地或在线音频文件来和录音设备采集的音频流进行混音。 支持的音乐文件类型包括 MP3、M4A、AAC、3GP、WMA 和 WAV 格式，支持本地文件或在线 URL。

  Parameters:

  option - 创建混音任务配置的选项，包括混音任务类型、混音文件全路径或 URL 等，详细信息请参考 audio.

• pauseAudioMixing

   abstract Integer pauseAudioMixing()

  暂停播放音乐文件及混音。

• resumeAudioMixing

   abstract Integer resumeAudioMixing()

  恢复播放伴奏。 该方法恢复混音，继续播放伴奏。请在房间内调用该方法。

• stopAudioMixing

   abstract Integer stopAudioMixing()

  停止播放伴奏。 该方法停止混音，停止播放伴奏。请在房间内调用该方法。

• setAudioMixingVolume

   abstract Integer setAudioMixingVolume(Integer volume)

  设置伴奏音量。 该方法调节混音里伴奏的音量大小。 setAudioMixingSendVolume setAudioMixingPlaybackVolume

  Parameters:

  volume - 伴奏发送音量。取值范围为 0~200。默认 100，即原始文件音量。

• getAudioMixingVolume

   abstract Integer getAudioMixingVolume()

  获取伴奏音量

• playEffect

   abstract Integer playEffect(Integer effectId, NEVoiceRoomCreateAudioEffectOption option)

  播放指定音效文件。 该方法播放指定的本地或在线音效文件。 支持的音效文件类型包括 MP3、M4A、AAC、3GP、WMA 和 WAV 格式，支持本地 SD 卡中的文件和在线 URL

  Parameters:

  effectId - 指定音效的 ID。每个音效均应有唯一的 ID。

  option - 音效相关参数，包括混音任务类型、混音文件路径等。

• setEffectVolume

   abstract Integer setEffectVolume(Integer effectId, Integer volume)

  设置音效音量 setEffectPlaybackVolume setEffectSendVolume

  Parameters:

  effectId - Int

  volume - Int 默认 100

• getEffectVolume

   abstract Integer getEffectVolume()

  获取音效音量

• stopAllEffect

   abstract Integer stopAllEffect()

  停止所有音效

• stopEffect

   abstract Integer stopEffect(Integer effectId)

  停止指定id的音效

  Parameters:

  effectId - 音效Id

• sendGift

   abstract Unit sendGift(Integer giftId, NEVoiceRoomCallback<Unit> callback)

  发送礼物

  Parameters:

  giftId - 礼物id

  callback - 发送礼物的回调 <br>相关回调：发送礼物成功后，房间内所有人会收到NEVoiceRoomListener.onReceiveGift回调

• setPlayingPosition

   abstract Integer setPlayingPosition(Integer effectId, Long position)

  指定播放位置 <br>使用前提：该方法仅在调用login方法登录成功且上麦成功调用有效

  Parameters:

  effectId - 音效文件id

  position - 播放位置

• pauseEffect

   abstract Integer pauseEffect(Integer effectId)

  暂停播放音效文件

  Parameters:

  effectId - 音效文件id

• resumeEffect

   abstract Integer resumeEffect(Integer effectId)

  继续播放音效文件

  Parameters:

  effectId - 音效文件id

• enableAudioVolumeIndication

   abstract Integer enableAudioVolumeIndication(Boolean enable, Integer interval)

  启用说话者音量提示。 该方法允许 SDK 定期向 App 反馈本地发流用户和瞬时音量最高的远端用户（最多 3 位）的音量相关信息， 即当前谁在说话以及说话者的音量。启用该方法后，只要房间内有发流用户，无论是否有人说话， SDK 都会在加入房间后根据预设的时间间隔触发 NEVoiceRoomListener.onRtcAudioVolumeIndication 回调

  Parameters:

  enable - 是否启用说话者音量提示。

  interval - 指定音量提示的时间间隔。单位为毫秒。必须设置为 100 毫秒的整数倍值，建议设置为 200 毫秒以上。

• sendBatchGift

   abstract Unit sendBatchGift(Integer giftId, Integer giftCount, List<String> userUuids, NEVoiceRoomCallback<Unit> callback)

  批量发送礼物

  Parameters:

  giftId - 礼物Id

  giftCount - 礼物数量

  userUuids - 发送礼物的对象

  callback - 回调 <br>相关回调：发送礼物成功后，房间内所有人会收到NEVoiceRoomListener.onReceiveBatchGift回调

• getLocalMember

   abstract NEVoiceRoomMember getLocalMember()

  本端成员信息 NEVoiceRoomMember 加入房间后获取

• getAllMemberList

   abstract List<NEVoiceRoomMember> getAllMemberList()

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

• getIsInitialized

   abstract Boolean getIsInitialized()

  初始化状态

  true 已初始化 false 未初始化

• getIsLoggedIn

   abstract Boolean getIsLoggedIn()

  是否已经登录