nugu-agent/com.skt.nugu.sdk.agent/DefaultAudioPlayerAgent

DefaultAudioPlayerAgent

class DefaultAudioPlayerAgent( mediaPlayer: MediaPlayerInterface, messageSender: MessageSender, focusManager: SeamlessFocusManagerInterface, contextManager: ContextManagerInterface, playbackRouter: PlaybackRouter, playSynchronizer: PlaySynchronizerInterface, directiveSequencer: DirectiveSequencerInterface, directiveGroupProcessor: DirectiveGroupProcessorInterface, channelName: String, enableDisplayLifeCycleManagement: Boolean, audioPlayerTemplateHandler: AudioPlayerTemplateHandler?) : CapabilityAgent, SupportedInterfaceContextProvider, ChannelObserver, AudioPlayerAgentInterface, PlaybackHandler, MediaPlayerControlInterface.PlaybackEventListener, AudioPlayerLyricsDirectiveHandler.VisibilityController, AudioPlayerLyricsDirectiveHandler.PagingController, PlayStackManagerInterface.PlayContextProvider

Constructors

fun DefaultAudioPlayerAgent( mediaPlayer: MediaPlayerInterface, messageSender: MessageSender, focusManager: SeamlessFocusManagerInterface, contextManager: ContextManagerInterface, playbackRouter: PlaybackRouter, playSynchronizer: PlaySynchronizerInterface, directiveSequencer: DirectiveSequencerInterface, directiveGroupProcessor: DirectiveGroupProcessorInterface, channelName: String, enableDisplayLifeCycleManagement: Boolean, audioPlayerTemplateHandler: AudioPlayerTemplateHandler?)

Types

AudioInfo

inner class AudioInfo( val payload: DefaultAudioPlayerAgent.PlayPayload, val directive: Directive, val playServiceId: String) : PlaySynchronizerInterface.SynchronizeObject

Companion

object Companion

LifeCycleScheduler

inner class LifeCycleScheduler

AudioPlayer's release rule:

PauseReason

enum PauseReason : Enum<DefaultAudioPlayerAgent.PauseReason>

PlayPayload

data class PlayPayload( val sourceType: DefaultAudioPlayerAgent.SourceType?, val playServiceId: String, val cacheKey: String?, val audioItem: AudioItem, val playStackControl: PlayStackControl?)

SourceType

enum SourceType : Enum<DefaultAudioPlayerAgent.SourceType>

Functions

addListener

open override fun addListener(listener: AudioPlayerAgentInterface.Listener, requestCurrentState: Boolean)

Add a listener to be called when a state changed.

addOnDurationListener

open override fun addOnDurationListener(listener: AudioPlayerAgentInterface.OnDurationListener, requestCurrentState: Boolean)

Add a listener to be called when duration retrieved

addOnPlaybackListener

open override fun addOnPlaybackListener(listener: AudioPlayerAgentInterface.OnPlaybackListener)

Add a playback listener

controlPage

open override fun controlPage(playServiceId: String, direction: Direction): Boolean

displayCardCleared

open override fun displayCardCleared(templateId: String)

Notifies the display that has been cleared.

displayCardRendered

open override fun displayCardRendered(templateId: String, controller: AudioPlayerDisplayInterface.Controller?)

Notifies the display that has been rendered.

displayCardRenderFailed

open override fun displayCardRenderFailed(templateId: String)

Notifies the display that has been render failed.

getOffset

open override fun getOffset(unit: TimeUnit): Long

Gets the current playback offset

getPlayContext

open override fun getPlayContext(): PlayStackManagerInterface.PlayContext?

hide

open override fun hide(playServiceId: String): Boolean

open override fun next()

Starts next playback if available

notifyUserInteractionOnDisplay

open override fun notifyUserInteractionOnDisplay(templateId: String)

This should be called when occur interaction(input event such as touch, drag, etc...) for display

onButtonPressed

open override fun onButtonPressed(button: PlaybackButton)

Called on playback button is pressed.

onFocusChanged

open override fun onFocusChanged(newFocus: FocusState)

onPlaybackError

open override fun onPlaybackError( id: SourceId, type: ErrorType, error: String)

onPlaybackFinished

open override fun onPlaybackFinished(id: SourceId)

onPlaybackPaused

open override fun onPlaybackPaused(id: SourceId)

onPlaybackResumed

open override fun onPlaybackResumed(id: SourceId)

onPlaybackStarted

open override fun onPlaybackStarted(id: SourceId)

onPlaybackStopped

open override fun onPlaybackStopped(id: SourceId)

pause

open override fun pause()

Pauses playback

play

open override fun play()

Starts or resumes playback.

open override fun prev()

Starts previous playback if available

provideState

open override fun provideState( contextSetter: ContextSetterInterface, namespaceAndName: NamespaceAndName, contextType: ContextType, stateRequestToken: Int)

removeListener