NEKaraokeListener

@objc
public protocol NEKaraokeListener : NSObjectProtocol

SDK API的通用回调接口。SDK提供的接口多为异步实现，在调用这些接口时，需要提供一个该接口的实现作为回调参数

  • 成员进入房间回调

    Declaration

    Swift

    @objc
optional func onMemberJoinRoom(_ members: [NEKaraokeMember])

    Parameters

    members

    成员列表

  • 成员离开房间回调

    Declaration

    Swift

    @objc
optional func onMemberLeaveRoom(_ members: [NEKaraokeMember])

    Parameters

    members

    成员列表

  • 房间结束回调

    Declaration

    Swift

    @objc
optional func onRoomEnded(_ reason: NEKaraokeEndReason)

    Parameters

    reason

    房间结束原因

  • Rtc频道错误回调

    Declaration

    Swift

    @objc
optional func onRtcChannelError(_ code: Int)

    Parameters

    code

    错误码

  • 本地音乐文件播放结束

    Declaration

    Swift

    @objc
optional func onSongPlayingCompleted()

  • 本端音频输出设备变更通知，如切换到扬声器、听筒、耳机等

    Declaration

    Swift

    @objc
optional func onAudioOutputDeviceChanged(_ device: NEKaraokeAudioOutputDevice)

    Parameters

    device

    音频输出类型

  • 音效播放进度更新

    Declaration

    Swift

    @objc
optional func onRtcAudioEffectTimestampUpdate(effectId: UInt32, timeStampMS: UInt64)

    Parameters

    effectId

    音效Id
    timeStampMS

    播放进度

  • 成员音频关闭回调

    添加监听后，成员音频状态变更会触发此方法

    Declaration

    Swift

    @objc
optional func onMemberAudioMuteChanged(_ member: NEKaraokeMember,
                                       mute: Bool, operateBy: NEKaraokeMember?)

    Parameters

    member

    成员信息
    mute

    是否关闭

  • 聊天室消息回调

    添加监听后，收到聊天室消息会触发此方法

    Declaration

    Swift

    @objc
optional func onReceiveTextMessage(_ message: NEKaraokeChatTextMessage)

    Parameters

    message

    文本消息

  • 接收到合唱回调

    Declaration

    Swift

    @objc
optional func onReceiveChorusMessage(_ actionType: NEKaraokeChorusActionType,
                                     songModel: NEKaraokeSongModel)

    Parameters

    actionType

    合唱状态
    songModel

    消息模型

  • 接收到发送礼物的回调

    Declaration

    Swift

    @objc
optional func onReceiveGift(giftModel: NEKaraokeGiftModel)

    Parameters

    giftModel

    礼物模型

  • 当前歌曲播放进度

    Declaration

    Swift

    @objc
optional func onSongPlayingPosition(_ postion: UInt64)

    Parameters

    postion

    歌曲播放进度

  • 音频帧数据

    Declaration

    Swift

    @objc
optional func onRecordingAudioFrame(frame: NEKaraokeAudioFrame)

    Parameters

    frame

    音频帧数据

  • 成员[user]提交了位置为[seatIndex]的麦位申请

    Declaration

    Swift

    @objc
optional func onSeatRequestSubmitted(_ seatIndex: Int, account: String)

    Parameters

    seatIndex

    麦位位置，-1表示未指定位置
    account

    申请人的用户ID

  • 成员[user]取消了位置为[seatIndex]的麦位申请

    Declaration

    Swift

    @objc
optional func onSeatRequestCancelled(_ seatIndex: Int, account: String)

    Parameters

    seatIndex

    麦位位置，-1表示未指定位置
    account

    申请人的用户ID

  • 管理员通过了成员[user]的麦位申请，位置为[seatIndex]

    Declaration

    Swift

    @objc
optional func onSeatRequestApproved(_ seatIndex: Int, account: String, operateBy: String)

    Parameters

    seatIndex

    麦位位置
    account

    申请人的用户ID
    operateBy

    同意该申请的用户ID

  • 管理员拒绝了成员[user]的麦位申请，位置为[seatIndex]

    Declaration

    Swift

    @objc
optional func onSeatRequestRejected(_ seatIndex: Int, account: String, operateBy: String)

    Parameters

    seatIndex

    麦位位置，-1表示未指定位置
    account

    申请人的用户ID
    operateBy

    拒绝该申请的用户ID

  • 成员下麦，位置为[seatIndex]

    Declaration

    Swift

    @objc
optional func onSeatLeave(_ seatIndex: Int, account: String)

    Parameters

    seatIndex

    麦位位置
    account

    下麦成员

  • 成员[user]被[operateBy]从位置为[seatIndex]的麦位踢掉

    Declaration

    Swift

    @objc
optional func onSeatKicked(_ seatIndex: Int, account: String, operateBy: String)

    Parameters

    seatIndex

    麦位位置
    account

    成员
    operateBy

    操作人

  • 麦位变更通知

    Declaration

    Swift

    @objc
optional func onSeatListChanged(_ seatItems: [NEKaraokeSeatItem])

    Parameters

    seatItems

    麦位列表

  • 已点列表的更新

    Declaration

    Swift

    @objc
optional func onSongListChanged()

  • 点歌

    Declaration

    Swift

    @objc
optional func onSongOrdered(_ song: NEKaraokeOrderSongModel?)

    Parameters

    song

    歌曲

  • 已点列表的删除

    Declaration

    Swift

    @objc
optional func onSongDeleted(_ song: NEKaraokeOrderSongModel?)

    Parameters

    song

    歌曲

  • 已点列表的置顶

    Declaration

    Swift

    @objc
optional func onSongTopped(_ song: NEKaraokeOrderSongModel?)

    Parameters

    song

    歌曲

  • 切歌

    Declaration

    Swift

    @objc
optional func onNextSong(_ song: NEKaraokeOrderSongModel?)

    Parameters

    song

    被切歌曲