AudioPlayer functionality (Continue PR #88)

[fremail]

Continuing PR #88 I added app.audioPlayer(event, func)
It allows to add an event handler to these AudioPlayer events:

• PlaybackStarted
• PlaybackFinished
• PlaybackStopped
• PlaybackNearlyFinished
• PlaybackFailed

Also this function supports async responses (similar to intent()).

[coveralls]

Coverage increased (+1.9%) to 87.153% when pulling d624ee2 on fremail:continue-88 into e2b8c6c on matt-kruse:master.

[coveralls]

Coverage increased (+1.9%) to 87.153% when pulling 5faa7ad on fremail:continue-88 into e2b8c6c on matt-kruse:master.

[dblock]

I think this is almost there, nice work. Lets finish it up, see my comments.

[dblock]

Maybe add a link to audio player support on some amazon site to explain what this is somewhere?

[fremail]

Added this link: https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/custom-audioplayer-interface-reference#audioplayer-requests

[wschaeferiii]

Hey @fremail , thank you for fixing my sloppy code and adding the AudioPlayer Event Request feature!

I would love to use the feature, however having issues issues with my app listening to AudioPlayer events. When the Alexa sends a audioplayer request (I can log the request_json, so I know its sent), the try / catch block with the var requestType = request.type() isn't even firing in my code.

Am I missing something here?

[dblock]

@wschaeferiii I know it's a continuation of this code, but just open a new issue for any bug you encounter against 2.4.0, hopefully with a test that reproduces the problem.

[fremail]

@wschaeferiii it's hard to suspect why it doesn't work for you. Please create an issue with a code example. Or point me to the issue please.

[dblock]

for the following events ...

And space things out a bit, add an empty line above and below.

[dblock]

I would say "The following example [explain what this does]."

[dblock]

Maybe add something that actually works as long as it's a 1-liner, like fetch some audio clip from some public website?

[fremail]

I don't have ideas what it could be

[dblock]

Which parts are required? Sounds like it's url and playBehavior. So maybe it shouldn't be method that takes 5 parameters but only those 2 and additional options that just get merged? This way you don't need the switch(arguments.length) at all.

[fremail]

expectedPreviousToken is required only in case of playBehavior is ENQUEUE. Otherwise we don't need it.
Other params are required in all responses: look at the table there

We can try to assign default values to the arguments and make as you wrote, but I don't sure it'd be convenient.

[dblock]

I still think this is not future-proof. Every time Amazon adds something to audioplay we'll be throwing more parameters in here. What do you think about leaving this to the user and not being too smart about it?

this.audioPlayerPlay = function (playBehavior, audioItem) {

}

this.audioPlayerPlayStream = function (playBehavior, stream) {
  
}

[dblock]

There should be a cleaner way to do this one without the big if.

audioPlayerDirective = {}
if () { ... }
self.response....

[fremail]

Agree. I'll rewrite this function

[dblock]

I think pre shouldn't take the 4th parameter since request.context is a thing. You can access that inside pre.

[fremail]

It was added by @wschaeferiii. Really I don't know reasons to add it.

[dblock]

Lets remove code that we don't know why it's there :)

[coveralls]

Coverage increased (+0.3%) to 85.512% when pulling a42d46c on fremail:continue-88 into e2b8c6c on matt-kruse:master.

[coveralls]

Coverage decreased (-0.2%) to 85.091% when pulling acd32a8 on fremail:continue-88 into e2b8c6c on matt-kruse:master.

[fremail]

Interesting.. when you expand readme file, test coverage decreases.

[dblock]

Merge, excellent work @fremail and @wschaeferiii.

[dblock]

Btw, just used this in artsy/elderfield#56 and it worked out beautifully.