@curiousmedia/vo-player

VOPlayer

VO Controller designed for handling Springroll 2.0 voVolume state, and for playing only one sound instance at a time with CreateJS Sound

You can pass in a single UID String to the player to play or an Array of String UIDs and Numbers to play the Voiceover sequentially

with the Numbers being a delay in between Voiceover audio files.

* VOPlayer
* new VOPlayer(volume)
* .volume
* .volume
* .instance
* .chain
* .play(audio)
* .pause()
* .resume()
* .stop()
* .handleInstanceComplete(event)
* .handleChainComplete()

$3

Constructor

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| volume | Number | 1 | volume to play the sound instances at defaults to 1 |

$3

Set the volume for this and the current instance playing

| Param | Type | Description |
| --- | --- | --- |
| volume | Number | volume to set |

$3

Return the current volume level set on the VOPlayer

$3

Return the current instance of VO playing

$3

Return the current chain instance

$3

Stop the current instance and play the new audio instance

| Param | Type | Description |
| --- | --- | --- |
| audio | String/Array | audio string UID name or Array of UID names and numbers for delay if needed |

$3

Pause the current VO instance

$3

Resume the current VO instance

$3

Stop the currently playing instance

$3

(Private) Handles what to do when an instance 'complete' event is called

| Param | Type |
| --- | --- |
| event | Event |

$3

Handle the completion of the chain