## SamplePlayer(ac, source, options) ⇒ player Create a sample player. **Kind**: global function **Returns**: player - the player | Param | Type | Description | | --- | --- | --- | | ac | AudioContext | the audio context | | source | ArrayBuffer | Object.<String, ArrayBuffer> | | | options | Onject | (Optional) an options object | **Example** ```js var SamplePlayer = require('sample-player') var ac = new AudioContext() var snare = SamplePlayer(ac, ) snare.play() ``` * [SamplePlayer(ac, source, options)](#SamplePlayer) ⇒ player * [~player](#SamplePlayer..player) : object * [.play](#SamplePlayer..player.play) * [.start(name, when, options)](#SamplePlayer..player.start) ⇒ AudioNode * [.stop(when, nodes)](#SamplePlayer..player.stop) ⇒ Array * [.connect(destination)](#SamplePlayer..player.connect) ⇒ AudioPlayer ### SamplePlayer~player : object **Kind**: inner namespace of [SamplePlayer](#SamplePlayer) * [~player](#SamplePlayer..player) : object * [.play](#SamplePlayer..player.play) * [.start(name, when, options)](#SamplePlayer..player.start) ⇒ AudioNode * [.stop(when, nodes)](#SamplePlayer..player.stop) ⇒ Array * [.connect(destination)](#SamplePlayer..player.connect) ⇒ AudioPlayer #### player.play An alias for `player.start` **Kind**: static property of [player](#SamplePlayer..player) **See**: player.start **Since**: 0.3.0 #### player.start(name, when, options) ⇒ AudioNode Start a sample buffer. The returned object has a function `stop(when)` to stop the sound. **Kind**: static method of [player](#SamplePlayer..player) **Returns**: AudioNode - an audio node with a `stop` function | Param | Type | Description | | --- | --- | --- | | name | String | the name of the buffer. If the source of the SamplePlayer is one sample buffer, this parameter is not required | | when | Float | (Optional) when to start (current time if by default) | | options | Object | additional sample playing options | **Example** ```js var sample = player(ac, ).connect(ac.destination) sample.start() sample.start(5, { gain: 0.7 }) // name not required since is only one AudioBuffer ``` **Example** ```js var drums = player(ac, { snare: , kick: , ... }).connect(ac.destination) drums.start('snare') drums.start('snare', 0, { gain: 0.3 }) ``` #### player.stop(when, nodes) ⇒ Array Stop some or all samples **Kind**: static method of [player](#SamplePlayer..player) **Returns**: Array - an array of ids of the stoped samples | Param | Type | Description | | --- | --- | --- | | when | Float | (Optional) an absolute time in seconds (or currentTime if not specified) | | nodes | Array | (Optional) an array of nodes or nodes ids to stop | **Example** ```js var longSound = player(ac, ).connect(ac.destination) longSound.start(ac.currentTime) longSound.start(ac.currentTime + 1) longSound.start(ac.currentTime + 2) longSound.stop(ac.currentTime + 3) // stop the three sounds ``` #### player.connect(destination) ⇒ AudioPlayer Connect the player to a destination node **Kind**: static method of [player](#SamplePlayer..player) **Chainable** **Returns**: AudioPlayer - the player | Param | Type | Description | | --- | --- | --- | | destination | AudioNode | the destination node | **Example** ```js var sample = player(ac, ).connect(ac.destination) ```