NEKaraokeKit Class Reference
NEKaraokeKit
@objcMembers
public class NEKaraokeKit : NSObjectextension NEKaraokeKit: NEAuthListenerextension NEKaraokeKit: NERoomListenerextension NEKaraokeKit: NESeatEventListener-
单例初始化
Declaration
Swift
public static func shared() -> NEKaraokeKitReturn Value
单例对象
-
本端成员信息 加入房间后获取
Declaration
Swift
public var localMember: NEKaraokeMember? { get } -
所有成员信息(包含本端) 加入房间后获取
Declaration
Swift
public var allMemberList: [NEKaraokeMember] { get } -
NEKaraokeKit 初始化
Declaration
Swift
public func initialize(config: NEKaraokeKitConfig, callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
config初始化配置
callback回调
-
初始化状态
Declaration
Swift
public var isInitialized: Bool -
添加房间监听
Declaration
Swift
public func addKaraokeListener(_ listener: NEKaraokeListener)Parameters
listener事件监听
-
移除房间监听
Declaration
Swift
public func removeKaraokeListener(_ listener: NEKaraokeListener)Parameters
listener事件监听
-
主播开播详情
Declaration
Swift
public var liveDetail: NEKaraokeRoomInfo { get } -
是否登录
Declaration
Swift
var isLoggedIn: Bool { get } -
添加登录监听
Declaration
Swift
func addAuthListener(_ listener: NEKaraokeAuthListener)Parameters
listener监听器
-
移除登录监听
Declaration
Swift
func removeAuthListener(_ listener: NEKaraokeAuthListener)Parameters
listener监听器
-
登录
Declaration
Swift
func login(_ account: String, token: String, callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
account账号
token令牌
callback回调
-
退出登录
Declaration
Swift
func logout(callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
callback回调
-
Declaration
Swift
public func onAuthEvent(evt: NEAuthEvent) -
发送文字聊天消息
Declaration
Swift
func sendTextMessage(_ content: String, callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
content发送的聊天内容
callback回调
-
发送礼物
Declaration
Swift
func sendGift(_ giftId: Int, callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
giftId礼物Id
-
成员属性变更
Declaration
Swift
public func onMemberPropertiesChanged(member: NERoomMember, properties _: [String : String]) -
Declaration
Swift
public func onMemberJoinRtcChannel(members: [NERoomMember]) -
成员进入房间
Declaration
Swift
public func onMemberJoinRoom(members: [NERoomMember]) -
成员离开房间
Declaration
Swift
public func onMemberLeaveRoom(members: [NERoomMember]) -
房间结束
Declaration
Swift
public func onRoomEnded(reason: NERoomEndReason) -
Rtc频道错误
Declaration
Swift
public func onRtcChannelError(code: Int) -
本端音频输出设备变更通知，如切换到扬声器、听筒、耳机等
Declaration
Swift
public func onRtcAudioOutputDeviceChanged(device: NEAudioOutputDevice) -
聊天室消息
Declaration
Swift
public func onReceiveChatroomMessages(messages: [NERoomChatMessage]) -
Declaration
Swift
public func onMemberAudioMuteChanged(member: NERoomMember, mute: Bool, operateBy: NERoomMember?) -
Declaration
Swift
public func onRtcAudioEffectFinished(effectId: UInt32) -
Declaration
Swift
public func onRtcAudioEffectTimestampUpdate(effectId: UInt32, timeStampMS: UInt64) -
开始唱歌
Declaration
Swift
func requestPlaySong(orderId: Int64, chorusId: String?, ext: [String: Any]? = nil, callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
orderId点歌台id
chorusId合唱id
ext额外参数
callback回调
-
邀请合唱
Declaration
Swift
func inviteChorus(orderId: Int64, callback: NEKaraokeCallback<NEKaraokeSongModel>? = nil)Parameters
orderId点歌编号
callback回调
-
取消合唱邀请
Declaration
Swift
func cancelInviteChorus(_ chorusId: String, callback: NEKaraokeCallback<NEKaraokeSongModel>? = nil)Parameters
chorusId合唱Id
callback回调
-
拒绝合唱
Declaration
Swift
func rejectInviteChorus(_ chorusId: String, callback: NEKaraokeCallback<NEKaraokeSongModel>? = nil)Parameters
chorusId合唱Id
callback回调
-
加入合唱
Declaration
Swift
func joinChorus(chorusId: String, callback: NEKaraokeCallback<NEKaraokeSongModel>? = nil)Parameters
chorusId合唱Id
callback回调
-
已准备完成
Declaration
Swift
func chorusReady(chorusId: String, callback: NEKaraokeCallback<NEKaraokeSongModel>? = nil)Parameters
chorusId合唱id
callback回调
-
暂停歌曲
Declaration
Swift
func requestPausePlayingSong(_ callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
callback回调
-
恢复演唱
Declaration
Swift
func requestResumePlayingSong(_ callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
callback回调
-
停止演唱
Declaration
Swift
func requestStopPlayingSong(_ callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
callback回调
-
放弃演唱
Declaration
Swift
func abandonSong(orderId: Int64, callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
orderId点歌编号
callback回调
-
切歌
Declaration
Swift
func nextSong(orderId: Int64, callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
orderId点歌编号
callback回调
-
获取当前房间内歌曲信息
Declaration
Swift
func requestPlayingSongInfo(_ callback: NEKaraokeCallback<NEKaraokeSongModel>? = nil)Parameters
callback回调
-
切换伴奏和原声
Declaration
Swift
@discardableResult func switchAccompaniment(_ enableAccompniment: Bool) -> Int -
是否是原唱
Declaration
Swift
var isOriginalSongPlaying: Bool { get } -
调音台使用的音效Id
Declaration
Swift
var currentSongIdForAudioEffect: Int { get } -
点歌台接口 点歌
Declaration
Swift
func orderSong(_ songinfo: NEKaraokeOrderSongModel, callback: NEKaraokeCallback<NEKaraokeOrderSongModel>? = nil) -
获取已点列表
Declaration
Swift
func getOrderedSongs(callback: NEKaraokeCallback<[NEKaraokeOrderSongModel]>? = nil) -
删除歌曲
Declaration
Swift
func deleteSong(orderId: Int64, callback: NEKaraokeCallback<AnyObject>? = nil) -
置顶歌曲
Declaration
Swift
func topSong(orderId: Int64, callback: NEKaraokeCallback<AnyObject>? = nil) -
查询房间列表
Declaration
Swift
func getKaraokeRoomList(liveState: NEKaraokeLiveState, pageNum: Int, pageSize: Int, callback: NEKaraokeCallback<NEKaraokeRoomList>? = nil)Parameters
type房间类型（1：互动直播 2：语聊房 3：Karaoke）
live直播状态
pageNum页码
pageSize页大小
callback房间列表回调
-
创建房间并进入房间
Declaration
Swift
func createRoom(_ params: NECreateKaraokeParams, options _: NECreateKaraokeOptions, callback: NEKaraokeCallback<NEKaraokeRoomInfo>? = nil)Parameters
params房间参数
options房间配置
callback回调
-
加入房间
Declaration
Swift
func joinRoom(_ params: NEJoinKaraokeParams, options _: NEJoinKaraokeOptions, callback: NEKaraokeCallback<NEKaraokeRoomInfo>? = nil)Parameters
params加入房间时参数
options加入房间时配置
callback回调
-
离开房间
Declaration
Swift
func leaveRoom(_ callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
callback回调
-
结束房间
Declaration
Swift
func endRoom(_ callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
callback回调
-
踢人
Declaration
Swift
func kickMemberOut(_ account: String, callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
account被踢的用户Id
callback回调
-
关闭自己的麦克风
Declaration
Swift
func muteMyAudio(_ callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
callback回调
-
打开自己的麦克风
Declaration
Swift
func unmuteMyAudio(_ callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
callback回调
-
playSong(originPath:accompanyPath: volume: anchorAccount: chorusAccount: startTimeStamp: anchor: mode: callback: ) 开始唱歌
Declaration
Swift
func playSong(originPath: String, accompanyPath: String, volume: Int, anchorAccount: String, chorusAccount: String?, startTimeStamp: Int64, anchor: Bool, mode: NEKaraokeSongMode, callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
originPath原唱地址
accompanyPath伴音地址
volume播放音量
anchorUuid主唱账号
chorusUid副唱账号
startTimeStamp延迟播放时间 单位/毫秒
anchor是否是主唱
mode演唱模式
callback回调
-
调节播放歌曲的音量
Declaration
Swift
@discardableResult func adjustPlayingSongVolume(_ volume: UInt32) -> Int -
调节人声音
Declaration
Swift
@discardableResult func adjustRecordingSignalVolume(_ volume: UInt32) -> Int -
变调
Declaration
Swift
@discardableResult func setLocalVoicePitch(_ pitch: Double) -> Int -
音效混响
Declaration
Swift
@discardableResult func setLocalVoiceReverbParam(_ param: NEKaraokeReverbParam) -> Int -
音效均衡
Declaration
Swift
@discardableResult func setLocalVoiceEqualization(_ bandFrequency: NEKaraokeAudioEqualizationBandFrequency, bandGain: Int) -> Int -
开启耳返
Declaration
Swift
@discardableResult func enableEarBack(volume: UInt32) -> Int -
关闭耳返
Declaration
Swift
@discardableResult func disableEarBack() -> Int -
获取当前播放音乐长度
Declaration
Swift
@discardableResult func getEffectDuration() -> UInt64 -
设置音乐播放位置
Declaration
Swift
@discardableResult func setPlayingPosition(position: UInt64) -> Int -
获取实时Token
Declaration
Swift
func getSongToken(callback: NEKaraokeCallback<NEKaraokeDynamicToken>? = nil)Parameters
callback回调
-
申请上麦
Declaration
Swift
func requestSeat(_ callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
callback回调
-
取消申请上麦
Declaration
Swift
func cancelRequestSeat(_ callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
callback回调
-
同意申请上麦
Declaration
Swift
func approveRequestSeat(account: String, callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
account同意上麦的用户Id
callback回调
-
拒绝申请上麦
Declaration
Swift
func rejectRequestSeat(account: String, callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
account被拒绝上麦的用户Id
callback回调
-
踢下麦
Declaration
Swift
func kickSeat(account: String, callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
account被踢下麦的用户Id
callback回调
-
下麦
Declaration
Swift
func leaveSeat(_ callback: NEKaraokeCallback<AnyObject>? = nil)Parameters
callback回调
-
获取麦位信息
Declaration
Swift
func getSeatInfo(_ callback: NEKaraokeCallback<NEKaraokeSeatInfo>? = nil)Parameters
callback回调
-
获取请求麦位列表
Declaration
Swift
func getSeatRequestList(_ callback: NEKaraokeCallback<[NEKaraokeSeatRequestItem]>? = nil)Parameters
callback回调
-
Declaration
Swift
public func onSeatRequestSubmitted(_ seatIndex: Int, user: String) -
Declaration
Swift
public func onSeatRequestCancelled(_ seatIndex: Int, user: String) -
Declaration
Swift
public func onSeatRequestApproved(_ seatIndex: Int, user: String, operateBy: String) -
Declaration
Swift
public func onSeatRequestRejected(_ seatIndex: Int, user: String, operateBy: String) -
Declaration
Swift
public func onSeatLeave(_ seatIndex: Int, user: String) -
Declaration
Swift
public func onSeatKicked(_ seatIndex: Int, user: String, operateBy: String) -
Declaration
Swift
public func onSeatListChanged(_ seatItems: [NESeatItem])