Class AudioPlayer

Emulates the behavior of the audio player

Hierarchy

AudioPlayer

Index

Constructors

constructor

Methods

Constructors

constructor

new AudioPlayer(_alexa: VirtualAlexa): AudioPlayer

- Defined in audioPlayer/AudioPlayer.ts:47
internal

Parameters
- _alexa: VirtualAlexa
Returns AudioPlayer

Methods

directivesReceived

directivesReceived(directives: any[]): Promise<void>

- Defined in audioPlayer/AudioPlayer.ts:139
internal

Parameters
- directives: any[]
Returns Promise<void>

isPlaying

isPlaying(): boolean

- Defined in audioPlayer/AudioPlayer.ts:58
Convenience method to check if the AudioPlayer is playing

Returns boolean

playbackFinished

playbackFinished(): Promise<any>

- Defined in audioPlayer/AudioPlayer.ts:76
Returns Promise<any>

playbackNearlyFinished

playbackNearlyFinished(): Promise<any>

- Defined in audioPlayer/AudioPlayer.ts:72
Returns Promise<any>

playbackOffset

playbackOffset(offset: number): void

- Defined in audioPlayer/AudioPlayer.ts:66
Emulates a certain amount of a track being played back

Parameters
- offset: number
Returns void

playbackStarted

playbackStarted(): Promise<any>

- Defined in audioPlayer/AudioPlayer.ts:86
Returns Promise<any>

playbackStopped

playbackStopped(): Promise<any>

- Defined in audioPlayer/AudioPlayer.ts:91
Returns Promise<any>

playerActivity

playerActivity(): AudioPlayerActivity

- Defined in audioPlayer/AudioPlayer.ts:100
The current state of the AudioPlayer

Returns AudioPlayerActivity

playing

playing(): AudioItem

- Defined in audioPlayer/AudioPlayer.ts:108
The currently playing track

Returns AudioItem

resume

resume(): Promise<void>

- Defined in audioPlayer/AudioPlayer.ts:115
Emulates the device begin playback again after finishing handling an utterance

Returns Promise<void>

suspend

suspend(): Promise<void>

- Defined in audioPlayer/AudioPlayer.ts:125
Emulates the device stopping playback while handling an utterance

Returns Promise<void>

suspended

suspended(): boolean

- Defined in audioPlayer/AudioPlayer.ts:134
Is the AudioPlayer stopped due to handling an utterance

Returns boolean

Generated using TypeDoc