AudioPlayerDelegate

@objc public protocol AudioPlayerDelegate: class

The Audio Player delegate protocol defines the event methods available for a Audio.

All Optional Callbacks

  • event occurs on Buffering of Audio Start.

    Declaration

    Swift

    optional func onBufferingStart()

  • event occurs on Buffering of Audio Complete.

    Declaration

    Swift

    optional func onBufferingComplete()

  • event occurs asynchronously when audio buffering is in progress.

    Declaration

    Swift

    optional func onBufferingProgress(progress: Int)

    Parameters

    progress

    current Buffer Progerss

  • event occurs continously when Audio streaming is going on.

    Declaration

    Swift

    optional func onCurrentPlayTime(progress: Int)

    Parameters

    progress

    current playing time of Audio.

  • event occurs when Audio streaming start.

    Declaration

    Swift

    optional func onStreamingStarted(duration: Int)

    Parameters

    duration

    total duration of audio.

  • event occurs when Audio streaming completed.

    Declaration

    Swift

    optional func onStreamCompleted()

  • event occurs when Audio is shared with TV for the first time.

    Declaration

    Swift

    optional func onPlayerInitialized()

  • event occurs when different type of media is shared with TV. (Audio is shared after photo/video share)

    Declaration

    Swift

    optional func onPlayerChange(playerType: String)

    Parameters

    playerType

    current player type (photo/audio/video)

  • event occurs when paused audio is played.

    Declaration

    Swift

    optional func onPlay()

  • event occurs on audio pause.

    Declaration

    Swift

    optional func onPause()

  • event occurs on audio stop.

    Declaration

    Swift

    optional func onStop()

  • event occurs on Player mute.

    Declaration

    Swift

    optional func onMute()

  • event occurs on Player unMute.

    Declaration

    Swift

    optional func onUnMute()

  • event occurs when Player plays next content.

    Declaration

    Swift

    optional func onNext()

  • event occurs when Player plays previous content.

    Declaration

    Swift

    optional func onPrevious()

  • provides the status of play controls like volume, mute/unmute and mode of player like single or repeat all - parameter volLevel: player volume level - parameter muteStatus: player mute status - parameter shuffleStatus: player shuffle status - parameter mode: player mode single or repeat all

    Declaration

    Swift

    optional func onControlStatus(volLevel: Int, muteStatus: Bool, shuffleStatus: Bool, mode: String)

    Parameters

    volLevel

    player volume level
    muteStatus

    player mute status
    shuffleStatus

    player shuffle status
    mode

    player mode single or repeat all

  • event occurs on player volume change.

    Declaration

    Swift

    optional func onVolumeChange(volLevel: Int)

    Parameters

    volLevel

    player volume to be set.

  • event occurs on audio addition in TV queue(player list).

    Declaration

    Swift

    optional func onAddToList(enqueuedItem: [String: AnyObject])

    Parameters

    enqueuedItem

    enqueued audio item.

  • event occurs on audio remove from TV queue(player list).

    Declaration

    Swift

    optional func onRemoveFromList(dequeuedItem: [String: AnyObject])

    Parameters

    dequeuedItem

    dequeued audio Item.

  • event occurs on TV queue(player list) deletion.

    Declaration

    Swift

    optional func onClearList()

  • event occurs when player list(TV queue) is recieved.

    Declaration

    Swift

    optional func onGetList(queueList: [String: AnyObject])

    Parameters

    queueList

    play list of TV

  • event occurs when player list is shuffled.

    Declaration

    Swift

    optional func onShuffle(status: Bool)

    Parameters

    status

    shuffle status(true/false)

  • event occurs on player list repeat.

    Declaration

    Swift

    optional func onRepeat(mode: String)

    Parameters

    mode

    specify repeat all/repeat single audio

  • occurs when new audio is shared with TV.

    Declaration

    Swift

    optional func onCurrentPlaying(currentItem: [String: AnyObject])

    Parameters

    currentItem

    current shared item.

  • occurs when TV Application/widget goes into background.

    Declaration

    Swift

    optional func onApplicationSuspend()

  • occurs when TV Application/widget comes in foreground.

    Declaration

    Swift

    optional func onApplicationResume()

  • occurs when error is occured in playing Audio

    Declaration

    Swift

    optional func onError(error: NSError)

    Parameters

    error

    eror details