nugu-agent/com.skt.nugu.sdk.agent.audioplayer/AudioPlayerAgentInterface

AudioPlayerAgentInterface

interface AudioPlayerAgentInterface : AudioPlayerDisplayInterface

Interface for AudioPlayer Capability Agent

Types

data class Context( val audioItemId: String, val templateId: String, val audioItemTemplate: String?, val offset: Long, val dialogRequestId: String)

Listener

interface Listener

Interface of a listener to be called when there has been an change of state

OnDurationListener

interface OnDurationListener

OnPlaybackListener

interface OnPlaybackListener

Listener to be called when occur a playback event.

RepeatMode

enum RepeatMode : Enum<AudioPlayerAgentInterface.RepeatMode>

RequestCommandHandler

interface RequestCommandHandler

State

enum State : Enum<AudioPlayerAgentInterface.State>

StopReason

enum StopReason : Enum<AudioPlayerAgentInterface.StopReason>

Functions

addListener

abstract fun addListener(listener: AudioPlayerAgentInterface.Listener, requestCurrentState: Boolean = false)

Add a listener to be called when a state changed.

addOnDurationListener

abstract fun addOnDurationListener(listener: AudioPlayerAgentInterface.OnDurationListener, requestCurrentState: Boolean = false)

Add a listener to be called when duration retrieved

addOnPlaybackListener

abstract fun addOnPlaybackListener(listener: AudioPlayerAgentInterface.OnPlaybackListener)

Add a playback listener

displayCardCleared

abstract fun displayCardCleared(templateId: String)

Notifies the display that has been cleared.

displayCardRendered

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

Notifies the display that has been rendered.

displayCardRenderFailed

abstract fun displayCardRenderFailed(templateId: String)

Notifies the display that has been render failed.

getOffset

abstract fun getOffset(unit: TimeUnit = TimeUnit.SECONDS): Long

Gets the current playback offset

abstract fun next()

Starts next playback if available

notifyUserInteractionOnDisplay

abstract fun notifyUserInteractionOnDisplay(templateId: String)

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

pause

abstract fun pause()

Pauses playback

play

abstract fun play()

Starts or resumes playback.

abstract fun prev()

Starts previous playback if available

removeListener

abstract fun removeListener(listener: AudioPlayerAgentInterface.Listener)

Remove a listener

removeOnDurationListener

abstract fun removeOnDurationListener(listener: AudioPlayerAgentInterface.OnDurationListener)

Remove a listener

removeOnPlaybackListener

abstract fun removeOnPlaybackListener(listener: AudioPlayerAgentInterface.OnPlaybackListener)

Remove a playback listener

requestFavoriteCommand

abstract fun requestFavoriteCommand(current: Boolean)

Request the favorite command if supported.

requestRepeatCommand

abstract fun requestRepeatCommand(current: AudioPlayerAgentInterface.RepeatMode)

Request the repeat command if supported.

requestShuffleCommand

abstract fun requestShuffleCommand(current: Boolean)

Request the shuffle command if supported

seek

abstract fun seek(offsetInMilliseconds: Long)

Seeks to specified time position

setElementSelected

abstract fun setElementSelected( templateId: String, token: String, postback: String? = null, callback: DisplayInterface.OnElementSelectedCallback? = null): String

Each element has it's own token.

setLyricsPresenter

abstract fun setLyricsPresenter(presenter: LyricsPresenter?)

Set a presenter for lyrics

setRenderer

abstract fun setRenderer(renderer: AudioPlayerDisplayInterface.Renderer?)

Set a renderer to interact with the display agent.

setRequestCommandHandler

abstract fun setRequestCommandHandler(handler: AudioPlayerAgentInterface.RequestCommandHandler)

stop

abstract fun stop()

Stops playback

Inheritors

DefaultAudioPlayerAgent