voiceroomkit 1.0.6 API
网易云信语聊房组件(voiceroomkit)提供房间管理、麦位管理、音视频通话、伴音等相关能力。
- NEVoiceRoomKit 接口类包含语聊房组件调用的主要方法。
- NEVoiceRoomListener 类用于向应用程序发送状态回调通知。
错误码
在调用 SDK API 的过程中,SDK 可能会返回错误码或状态码,您可以根据错误码或状态码判断当前 SDK 或任务的状态。如果遇到未知的错误码,请联系技术支持排查。
当前 SDK API 的错误码如下:
- 登录事件枚举:NEVoiceRoomAuthEvent
- 房间结束原因枚举:NEVoiceRoomEndReason
语聊房组件核心接口
房间管理
Method | Description |
---|---|
initialize()
|
NEVoiceRoomKit 初始化 |
addAuthListener()
|
添加登录状态监听 |
removeAuthListener()
|
移除登录状态监听 |
addVoiceRoomListener()
|
注册房间监听 |
removeVoiceRoomListener()
|
移除房间监听 |
login()
|
登录 |
logout
|
登出 |
getVoiceRoomList
|
获取房间列表 |
createRoom
|
创建房间 |
getCreateRoomDefaultInfo
|
获取创建房间的默认信息 |
joinRoom
|
加入房间 |
leaveRoom
|
离开房间 |
getRoomInfo
|
获取房间信息 |
endRoom
|
结束房间 |
getIsInitialized()
|
初始化状态 |
成员管理
Method | Description |
---|---|
getLocalMember()
|
获取本端成员信息 |
getAllMemberList()
|
获取房间内所有成员(包括本端) |
banRemoteAudio
|
禁用指定成员音频 |
unbanRemoteAudio
|
解禁指定成员的音频 |
getIsLoggedIn()
|
是否已经登录 |
麦位管理
Method | Description |
---|---|
getSeatInfo
|
获取麦位信息。 |
getSeatRequestList
|
获取麦位申请列表。按照申请时间正序排序,先申请的成员排在列表前面。 |
sendSeatInvitation
|
房主向成员account发送上麦邀请,指定位置为seatIndex,非管理员执行该操作会失败。 |
submitSeatRequest
|
成员申请指定位置为seatIndex的麦位,位置从1开始。 如果当前成员为管理员,则会自动通过申请。 |
cancelSeatRequest
|
取消申请上麦 |
approveSeatRequest
|
同意上麦 |
rejectSeatRequest
|
拒绝上麦 |
kickSeat
|
踢麦 |
leaveSeat
|
下麦 |
openSeats
|
打开麦位 |
closeSeats
|
关闭麦位 |
音频通话
Method | Description |
---|---|
muteMyAudio
|
关闭自己的麦克风 |
unmuteMyAudio
|
打开自己的麦克风 |
enableEarback
|
开启耳返功能。 |
disableEarback()
|
关闭耳返功能。 |
isEarbackEnable()
|
是否开启耳返功能 |
adjustRecordingSignalVolume
|
调节人声音量 |
getRecordingSignalVolume()
|
获取人声音量 |
startAudioMixing
|
开始播放音乐文件。 |
pauseAudioMixing()
|
暂停播放音乐文件及混音。 |
resumeAudioMixing()
|
恢复播放伴奏。 |
stopAudioMixing()
|
停止播放伴奏。 |
setAudioMixingVolume()
|
设置伴奏音量。 |
getAudioMixingVolume()
|
获取伴奏音量 |
playEffect()
|
播放指定音效文件 |
setEffectVolume()
|
设置音效音量 |
getEffectVolume()
|
获取音效音量 |
setPlayingPosition(Integer effectId, Long position)
|
指定播放位置 |
pauseEffect(Integer effectId)
|
暂停播放音效文件 |
resumeEffect(Integer effectId)
|
继续播放音效文件 |
stopAllEffect()
|
停止所有音效 |
stopEffect()
|
停止指定id的音效 |
消息互动
Method | Description |
---|---|
sendTextMessage
|
发送聊天室消息 |
sendBatchGift
|
批量发送礼物 |