forked from alexa-samples/skill-sample-nodejs-audio-player
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README and added package.json and NOTICE.txt.
- Loading branch information
Jamison
committed
Aug 22, 2016
1 parent
1ab6a7e
commit 6d7a750
Showing
4 changed files
with
57 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,3 @@ | ||
| node_modules | ||
| node_modules | ||
| .idea | ||
| *.zip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| Interactive Adventure Game Tool | ||
| Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,87 +1,54 @@ | ||
| # Audio Player Sample Project | ||
|
|
||
| Alexa Skills Kit now allows 3P-developers to build skills supporting Audio Player Interfaces. This sample project will showcase how developers can use long form audio in Alexa Skills. | ||
| The Alexa Skills Kit now allows developers to build skills that play long-form audio content on Alexa devices. This sample project demonstrates how to use the new interfaces for triggering playback of audio and handling audio player input events. | ||
|
|
||
| ## How to Get Started | ||
| ## How to Run the Sample | ||
|
|
||
| Setup AWS and the Amazon Developer Console. | ||
|
|
||
| You can change the name of these resources to whatever you like later, but for now, setup the following items: | ||
| 1. Clone the project and package the skill: | ||
| ```bash | ||
| git clone https://github.com/alexa/skill-sample-nodejs-audio-player.git | ||
| cd skill-sample-nodejs-audio-player/js | ||
| npm install | ||
| zip -r ../audio-player.zip * | ||
| ``` | ||
| 2. Create or login to an [AWS account](https://aws.amazon.com/). In the AWS Console: | ||
|
|
||
| 1. Create or login to an [AWS account](https://aws.amazon.com/). In the AWS Console: | ||
| 1. Create an AWS Role in IAM with access to Lambda and DynamoDB. | ||
|  | ||
|  | ||
|  | ||
|
|
||
| 2. Create an AWS Lambda function named AudioPlayerLambdaFunction being sure to select the role created above and configuring "Alexa Skills Kit" as the "Trigger". | ||
| 2. Create an AWS Lambda function named AudioPlayerLambdaFunction being sure to select the role created above, configuring "Alexa Skills Kit" as the "Trigger" and using the zip file created above as the source. | ||
|  | ||
|
|
||
|  | ||
| 3. Zip the contents in `src/js` and upload in "Lambda function code". | ||
| 4. Review and create the Lambda function. | ||
| 5. After creation, take note of the ARN on the upper right, which you'll configure in the Developer Console below. | ||
| 3. After creation, take note of the ARN on the upper right, which you'll configure in the Developer Console below. | ||
| 3. Create or login to an [Amazon Developer account](https://developer.amazon.com). In the Developer Console: | ||
|
|
||
| 2. Create or login to an [Amazon Developer account](https://developer.amazon.com). In the Developer Console: | ||
| **TODO Change to Prod Account Screenshots** | ||
| 1. [Create an Alexa Skill](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/developing-an-alexa-skill-as-a-lambda-function) named MySkill and using the invocation name "my skill" and select 'Yes' for Audio Player support. | ||
|  | ||
|
|
||
| 2. Copy the contents of `src/InteractionModel` into the Interaction Model tab. | ||
| 2. Copy the contents of `speechAssets/intentSchema.json` and `speechAssets/Utterances.txt` into the intent schema and sample utterances fields on the Interaction Model tab. | ||
|  | ||
|
|
||
| 3. Copy the Lambda ARN from above in the Configuration tab. | ||
|  | ||
|
|
||
| 4. You can start testing the skill on your device or on the simulator now, but you can go ahead and fill in the Publishing Information and accept the Privacy & Compliance information to submit the skill for certification. | ||
|
|
||
| 4. You can start using the skill on your device or in the simulator using the invocation phrase "Alexa, ask my skill to play". | ||
|
|
||
| ## How it Works | ||
|
|
||
| Alexa Skills Kit introduced the 'AudioPlayer' interface which provides directives and requests for streaming audio and monitoring playback progression. You can include AudioPlayer directives within your response to start and stop the playback. Alexa also sends "PlaybackController" requests in response to hardware buttons such as on a remote control. Below you can see how to create these directives. | ||
|
|
||
| With the Node JS Alexa-SDK, one can add an AudioPlayer directive by adding : | ||
| ```javascript | ||
| this.response.audioPlayerPlay(playBehavior, url, token, expectedPreviousToken, offsetInMilliseconds); | ||
| this.response.audioPlayerStop(); | ||
| this.response.audioPlayerClearQueue(clearBehavior); | ||
| ``` | ||
| ##### AudioPlayer Play Directive : | ||
|
|
||
| ```json | ||
| { | ||
| "type": "AudioPlayer.Play", | ||
| "playBehavior": "string - REPLACE_ALL || ENQUEUE || REPLACE_ENQUEUED", | ||
| "audioItem": { | ||
| "stream": { | ||
| "url": " string - HTTPS Stream Required", | ||
| "token": "string", | ||
| "expectedPreviousToken": "string", | ||
| "offsetInMilliseconds": 0 | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ##### AudioPlayer Stop Directive : | ||
|
|
||
| ```json | ||
| { | ||
| "type": "AudioPlayer.Stop" | ||
| } | ||
| ``` | ||
|
|
||
| ##### AudioPlayer ClearQueue Directive : | ||
| ```json | ||
| { | ||
| "type": "AudioPlayer.ClearQueue", | ||
| "clearBehavior" : "string - CLEAR_ENQUEUED || CLEAR_ALL" | ||
| } | ||
| ``` | ||
| Alexa Skills Kit now includes a set of output directives and input events that allow you to control the playback of audio files or streams. There are a few important concepts to get familiar with: | ||
|
|
||
| * **AudioPlayer directives** are used by your skill to start and stop audio playback from content hosted at a publicly accessible secure URL. You send AudioPlayer directives in response to the intents you've configured for your skill, or new events you'll receive when a user controls their device with a dedicated controller (see PlaybackController events below). | ||
| * **PlaybackController events** are sent to your skill when a user selects play/next/prev/pause on dedicated hardware controls on the Alexa device, such as on the Amazon Tap or the Voice Remote for Amazon Echo and Echo Dot. Your skill receives these events if your skill is currently controlling audio on the device (i.e., you were the last to send an AudioPlayer directive). | ||
| * **AudioPlayer events** are sent to your skill at key changes in the status of audio playback, such as when audio has begun playing, been stopped or has finished. You can use them to track what's currently playing or queue up more content. Unlike intents, when you receive an AudioPlayer event, you may only respond with appropriate AudioPlayer directives to control playback. | ||
|
|
||
| In response to AudioPlayer directives, you receive **AudioPlayer Requests**. You can learn more about the [AudioPlayer Interface here](https://drive.corp.amazon.com/view/DevComm/ask-docs/custom-audioplayer-interface-reference.html). (**TODO Change hyperlink**) | ||
| The sample project plays a pre-defined list of audio content defined in `js/audioAssets.js`, allowing the user to control playback with a range of custom and built-in intents. It's organized into several modules: | ||
|
|
||
| ## Audio Assets | ||
| * `index.js` is the main module that handles events from Alexa. In the sample project, we setup the skill and register handlers defined in seperate modules. | ||
| * `constants.js` holds a few constants like the Application ID of the skill and the name of a table in DynamoDB the skill will use to store details about what each user has played. | ||
| * `audioAssets.js` is a list of audio content the skill will play from. | ||
| * `stateHandlers.js` is where the skill handles voice intent and playback control commands. It registers handlers for each of the input events in different states the skill can be in, and defines a `controller` that centralizes the handler code since we perform the same action for several different input events (e.g., we do the same thing when the user tells the skill to stop or if the stop button is pressed on the device). The sample project define three states: | ||
| * **START_MODE** is the default state of the skill, such as when it's invoked without an intent for the first time. | ||
| * **PLAY_MODE** is used when audio is currently being played by the skill. | ||
| * **RESUME_DECISION_MODE** is used to handle the response from the user when they're asked to confirm they'd like to resume playback from a prior use of the skill. | ||
| * `audioEventHandlers.js` is where the skill handles AudioPlayer events. These events are only expected in the PLAY_MODE state and are used to track the user's progress through the content. | ||
|
|
||
| Configure `src/js/audioAssets.js` to add your audio assets and enjoy building your own customized audio player skill. | ||
| You can learn more about the new [AudioPlayer interfaces here](https://drive.corp.amazon.com/view/DevComm/ask-docs/custom-audioplayer-interface-reference.html). (**TODO Change hyperlink**) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| { | ||
| "name": "skill-sample-nodejs-audio-player", | ||
| "version": "1.0.0", | ||
| "description": "An audio player sample skill.", | ||
| "main": "index.js", | ||
| "scripts": { | ||
| "test": "echo \"Error: no test specified\" && exit 1" | ||
| }, | ||
| "keywords": [ | ||
| "alexa", | ||
| "skill", | ||
| "audio player" | ||
| ], | ||
| "author": "Amazon.com", | ||
| "license": "See license in ../LICENSE.txt", | ||
| "dependencies": { | ||
| "alexa-sdk": "^1.0.4" | ||
| }, | ||
| "repository" : { | ||
| "type" : "git", | ||
| "url" : "https://github.com/alexa/skill-sample-nodejs-audio-player" | ||
| } | ||
| } |