Audio Description Options
Here is a list of the configuration options:
| Property | Description | Default |
|---|---|---|
| type | Possible options are vertical, horizontal, spectrum, vu | vu |
| pitch | The pitch of the voice. | 1 |
| rate | The rate of the voice | 1 |
| volume | The volume of the voice. A percentage value enables using the player volume first. | 0.8 |
| minVolume | The min volume set to use the player volume before using the configured volume | 0.5 |
| volumeOffset | The offset of the player volume to set the describe volume to | 0.1 |
volumeLevel
Player API Methods
| Mathod | Description | Arguments |
|---|---|---|
| getVoices | Gets a list of the available voices in the browser. | |
| setVoice | Sets the selected voice to use for describing. | |
| enableDescription | enable / disable describing | |
| descriptionsEnabled | if description is enabled | |
| setDescribeVolume | externally set the describe volume up to 1. | |
| getDescribeVolume | get the current describe volume. |
Player Events
| Mathod | Description | Arguments |
|---|---|---|
| describechange | When the cue for describing changes. | the current cue |
| describestart | when describing has started. | |
| describeend | When describing has ended. | |
| describeerror | The error when trying to describe. | error The error message. |