AskNavidrome Alexa Skill Documentation - TEST==¶
+AskNavidrome Alexa Skill Documentation¶
AskNavidrome is an Alexa skill which allows you to play music hosted on a SubSonic API compatible media server, like Navidrome.
This allows to you stream your own music collection to your Echo devices without the restrictions you would normally face with regular streaming services like Amazon Music or Spotify. AskNavidrome allows you to:
@@ -102,43 +102,43 @@ behind a reverse proxy, the web service also needs to be publicly accessible on -NaviSonicPlayMusicByArtist
Play music by a specific artist
Play Where is my Mind by The Pixies
NaviSonicPlayAlbumByArtist
Play a specific album by a specific artist
Play The Blue Album by The Beatles
NaviSonicPlaySongByArtist
Play a specific song by a specific artist
Play the song Help by The Beatles
NaviSonicPlayPlaylist
Play a playlist
Play the playlist work music
NaviSonicPlayMusicByGenre
Play music with a specific genre
Play jazz music
NaviSonicPlayMusicRandom
Play a random mix of songs
Play random songs
NaviSonicPlayFavouriteSongs
Play your starred / favourite songs
Play my favourite songs
NaviSonicSongDetails
Give details on the playing track
What is playing
NaviSonicStarSong
Star / favourite a song
Star this song
NaviSonicUnstarSong
Unstar / unfavourite a song
Unstar this song
The following control intents are also supported:
-
-
Next / Skip
-Previous / Back
-Pause
-Resume
+- +
- +
- +
Due to the way that Alexa skills operate there are some limitations. Full music Alexa skills require a catalog of content to be provided and this defeats the purpose of being able to search and stream from your own server directly. Because of this a custom skill type is used along with the AudioPlayer interface, @@ -450,8 +450,1625 @@ the entries will contain any errors that were thrown.
Code Documentation¶
AskNavidrome main¶
+AskNavidrome main¶
+Classes:
+| + | Check if device supports audio play. |
+
| + | Handle general exceptions |
+
| + | Handle HelpIntent |
+
| + | Handle LaunchRequest and NavigateHomeIntent |
+
| + | Intercept all requests |
+
| + | Intercept all responses |
+
| + | Handle NaviSonicPlayAlbumByArtist |
+
| + | Handle the NaviSonicPlayFavouriteSongs intent |
+
| + | Handle NaviSonicPlayMusicByArtist |
+
| + | Play songs from the given genere |
+
| + | Handle the NaviSonicPlayMusicRandom intent |
+
| + | Handle NaviSonicPlayPlaylist |
+
| + | Handle the NaviSonicPlaySongByArtist intent |
+
| + | Handle NaviSonicSongDetails Intent |
+
| + | Handle NaviSonicStarSong Intent |
+
| + | Handle NaviSonicUnstarSong Intent |
+
| + | Handle NextIntent |
+
| + | Handler for stopping audio. |
+
| + | AudioPlayer.PlaybackFailed Directive received. |
+
| + | AudioPlayer.PlaybackFinished Directive received. |
+
| + | AudioPlayer.PlaybackNearlyFinished Directive received. |
+
| + | AudioPlayer.PlaybackStarted Directive received. |
+
| + | AudioPlayer.PlaybackStopped Directive received. |
+
| + | Handle PreviousIntent |
+
| + | Handler for resuming audio on different events. |
+
| + | Close session for skill events or when session ends. |
+
| + | Handle System.ExceptionEncountered |
+
Functions:
+| + | View the contents of play_queue.buffer |
+
| + | View the contents of play_queue.history |
+
| + | View the contents of play_queue.queue |
+
-
+
- +class app.CheckAudioInterfaceHandler¶ +
Check if device supports audio play.
+This can be used as the first handler to be checked, before invoking +other handlers, thus making the skill respond to unsupported devices +without doing much processing.
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
- +can_handle(handler_input: HandlerInput) bool¶ +
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput) Response¶ +
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.GeneralExceptionHandler¶ +
Handle general exceptions
+Handles exceptions and prints error information +in the log
+Methods:
++ +
+can_handle(handler_input, exception)Checks if the handler can support the exception raised during dispatch.
handle(handler_input, exception)Process the handler input and exception.
-
+
- +can_handle(handler_input: HandlerInput, exception: Exception) bool¶ +
Checks if the handler can support the exception raised +during dispatch.
+-
+
- Parameters: +
-
+
handler_input (HandlerInput) – Handler Input instance.
+exception (Exception) – Exception raised during dispatch.
+
+- Returns: +
Boolean whether handler can handle exception or not.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput, exception: Exception) Response¶ +
Process the handler input and exception.
+-
+
- Parameters: +
-
+
handler_input (HandlerInput) – Handler Input instance.
+exception (Exception) – Exception raised during dispatch.
+
+- Returns: +
Optional response object to serve as dispatch return.
+
+- Return type: +
Union[None, Response]
+
+
-
+
- +class app.HelpHandler¶ +
Handle HelpIntent
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
- +can_handle(handler_input: HandlerInput) bool¶ +
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput) Response¶ +
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.LaunchRequestHandler¶ +
Handle LaunchRequest and NavigateHomeIntent
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
- +can_handle(handler_input: HandlerInput) bool¶ +
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput) Response¶ +
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.LoggingRequestInterceptor¶ +
Intercept all requests
+Intercepts all requests sent to the skill and prints them in the log
+Methods:
++ +
+process(handler_input)Process the input before the Handler is run.
-
+
- +process(handler_input: HandlerInput)¶ +
Process the input before the Handler is run.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance.
+
+- Return type: +
None
+
+
-
+
- +class app.LoggingResponseInterceptor¶ +
Intercept all responses
+Intercepts all responses sent from the skill and prints them in the log
+Methods:
++ +
+process(handler_input, response)Process the input and the response after the Handler is run.
-
+
- +process(handler_input: HandlerInput, response: Response)¶ +
Process the input and the response after the Handler is run.
+-
+
- Parameters: +
-
+
handler_input (HandlerInput) – Handler Input instance.
+response (Union[None,
ask_sdk_model.response.Response]) – Execution result of the Handler on +handler input.
+
+- Return type: +
None
+
+
-
+
+
Handle NaviSonicPlayAlbumByArtist
+Play a given album by a given artist
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
+
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
+
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
+
Handle the NaviSonicPlayFavouriteSongs intent
+Play all starred / liked songs, songs are automatically shuffled.
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
+
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
+
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
+
Handle NaviSonicPlayMusicByArtist
+Play a selection of songs for the given artist
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
+
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
+
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
+
Play songs from the given genere
+50 tracks from the given genere are shuffled and played
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
+
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
+
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
+
Handle the NaviSonicPlayMusicRandom intent
+Play a random selection of music.
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
+
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
+
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
+
Handle NaviSonicPlayPlaylist
+Play the given playlist
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
+
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
+
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
+
Handle the NaviSonicPlaySongByArtist intent
+Play the given song by the given artist if it exists in the +collection.
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
+
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
+
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
+
Handle NaviSonicSongDetails Intent
+Returns information on the track that is currently playing
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
+
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
+
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
+
Handle NaviSonicStarSong Intent
+Star / favourite the current song
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
+
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
+
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
+
Handle NaviSonicUnstarSong Intent
+Star / favourite the current song
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
+
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
+
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.NextPlaybackHandler¶ +
Handle NextIntent
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
- +can_handle(handler_input: HandlerInput) bool¶ +
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput) Response¶ +
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.PausePlaybackHandler¶ +
Handler for stopping audio.
+Handles Stop, Cancel and Pause Intents and PauseCommandIssued event.
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
- +can_handle(handler_input: HandlerInput) bool¶ +
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput) Response¶ +
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.PlaybackFailedEventHandler¶ +
AudioPlayer.PlaybackFailed Directive received.
+Logging the error and restarting playing with no output speech.
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
- +can_handle(handler_input: HandlerInput) bool¶ +
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput) Response¶ +
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.PlaybackFinishedHandler¶ +
AudioPlayer.PlaybackFinished Directive received.
+Confirming that the requested audio file completed playing. +Do not send any specific response.
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
- +can_handle(handler_input: HandlerInput) bool¶ +
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput) Response¶ +
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.PlaybackNearlyFinishedHandler¶ +
AudioPlayer.PlaybackNearlyFinished Directive received.
+Replacing queue with the URL again. This should not happen on live streams.
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
- +can_handle(handler_input: HandlerInput) bool¶ +
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput) Response¶ +
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.PlaybackStartedHandler¶ +
AudioPlayer.PlaybackStarted Directive received.
+Confirming that the requested audio file began playing. +Do not send any specific response.
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
- +can_handle(handler_input: HandlerInput) bool¶ +
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput) Response¶ +
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.PlaybackStoppedHandler¶ +
AudioPlayer.PlaybackStopped Directive received.
+Confirming that the requested audio file stopped playing. +Do not send any specific response.
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
- +can_handle(handler_input: HandlerInput) bool¶ +
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput) Response¶ +
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.PreviousPlaybackHandler¶ +
Handle PreviousIntent
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
- +can_handle(handler_input: HandlerInput) bool¶ +
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput) Response¶ +
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.ResumePlaybackHandler¶ +
Handler for resuming audio on different events.
+Handles PlayAudio Intent, Resume Intent.
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
- +can_handle(handler_input: HandlerInput) bool¶ +
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput) Response¶ +
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.SkillEventHandler¶ +
Close session for skill events or when session ends.
+Handler to handle session end or skill events (SkillEnabled, +SkillDisabled etc.)
+Methods:
++ +
+can_handle(handler_input)Returns true if Request Handler can handle the Request inside Handler Input.
handle(handler_input)Handles the Request inside handler input and provides a Response for dispatcher to return.
-
+
- +can_handle(handler_input: HandlerInput) bool¶ +
Returns true if Request Handler can handle the Request +inside Handler Input.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Boolean value that tells the dispatcher if the +current request can be handled by this handler.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput) Response¶ +
Handles the Request inside handler input and provides a +Response for dispatcher to return.
+-
+
- Parameters: +
handler_input (HandlerInput) – Handler Input instance with +Request Envelope containing Request.
+
+- Returns: +
Response for the dispatcher to return or None
+
+- Return type: +
Union[Response, None]
+
+
-
+
- +class app.SystemExceptionHandler¶ +
Handle System.ExceptionEncountered
+Handles exceptions and prints error information +in the log
+Methods:
++ +
+can_handle(handler_input, exception)Checks if the handler can support the exception raised during dispatch.
handle(handler_input, exception)Process the handler input and exception.
-
+
- +can_handle(handler_input: HandlerInput, exception: Exception) bool¶ +
Checks if the handler can support the exception raised +during dispatch.
+-
+
- Parameters: +
-
+
handler_input (HandlerInput) – Handler Input instance.
+exception (Exception) – Exception raised during dispatch.
+
+- Returns: +
Boolean whether handler can handle exception or not.
+
+- Return type: +
bool
+
+
-
+
- +handle(handler_input: HandlerInput, exception: Exception) Response¶ +
Process the handler input and exception.
+-
+
- Parameters: +
-
+
handler_input (HandlerInput) – Handler Input instance.
+exception (Exception) – Exception raised during dispatch.
+
+- Returns: +
Optional response object to serve as dispatch return.
+
+- Return type: +
Union[None, Response]
+
+
-
+
- +app.view_buffer()¶ +
View the contents of play_queue.buffer
+Creates a tabulated page contining the contents of the play_queue.buffer deque.
+
-
+
- +app.view_history()¶ +
View the contents of play_queue.history
+Creates a tabulated page contining the contents of the play_queue.history deque.
+
-
+
- +app.view_queue()¶ +
View the contents of play_queue.queue
+Creates a tabulated page contining the contents of the play_queue.queue deque.
+
AskNavidrome controller¶
@@ -1184,7 +2801,7 @@ is workingTable of Contents
-
-
- AskNavidrome Alexa Skill Documentation - TEST==
-
+
- AskNavidrome Alexa Skill Documentation
- Requirements
- About the AskNavidrome Skill
- Supported Intents @@ -1200,7 +2817,7 @@ is working
- Troubleshooting
- Code Documentation
-
-
- AskNavidrome main +
- AskNavidrome main
- AskNavidrome controller
- AskNavidrome media queue
- AskNavidrome subsonic API @@ -1243,7 +2860,7 @@ is working modules |
-
+
- AskNavidrome Alexa Skill Documentation
app