Class: AlexaRuby::AudioPlayer

Inherits:
Object
  • Object
show all
Defined in:
lib/alexa_ruby/response/audio_player.rb

Overview

AudioPlayer class encapsulates all Alexa audio player directives

Instance Method Summary collapse

Instance Method Details

#play_directive(params) ⇒ Hash

Build an AudioPlayer.Play directive

Parameters:

  • params (Hash) —

    optional request parameters: url [String] streaming URL token [String] streaming service token offset [Integer] playback offset

Returns:

  • (Hash) —

    AudioPlayer.Play directive

Raises:

  • (ArgumentError) —

    if audio URL isn’t valid



12
13
14
15
16
17
18
19
20
21
 
# File 'lib/alexa_ruby/response/audio_player.rb', line 12

def play_directive(params)
  url = params[:url]
  if invalid_url?(url)
    raise ArgumentError, 'Audio URL must be a valid ' \
                          'SSL-enabled (HTTPS) endpoint'
  end
  token = token(params[:token])
  offset = params[:offset] || 0
  build_directive('AudioPlayer.Play', url, token, offset)
end

#stop_directive ⇒ Hash

Build AudioPlayer.Stop directive

Returns:

  • (Hash) —

    AudioPlayer.Stop directive



26
27
28
 
# File 'lib/alexa_ruby/response/audio_player.rb', line 26

def stop_directive
  build_directive('AudioPlayer.Stop')
end