audio-director
Advanced tools
Manage browser audio sources and playback
npm install audio-director
https://lab.miguelmota.com/audio-director
objectClass reprensenting a Player
Kind: global class
StringPromisePromisePromisePromisePromisePromisePromisePromisePromisePromiseAudioBufferPromisePromisePromisePromisePromisePromiseBooleanBooleanPromiseNumberPromiseNumberPromiseNumberPromiseNumberPromiseNumberStringObjectCreate a Player
Listen for player events
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| eventName | String | name of even |
| callback | function | called when the event occurs |
Example
player.on(Player.EventTypes.PLAY, () => {
})
Example
player.on(Player.EventTypes.PLAYBACK_RATE, () => {
})
StringGet currently playing audio source url
Kind: instance method of Player
Example
const url = player.getCurrentUrl()
PromiseEmpties queue
Kind: instance method of Player
Example
player.emptyQueue()
PromiseEnqueues an audio source to play
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| source | DataView | Uint8Array | AudioBuffer | ArrayBuffer | String | an audio source to play |
Example
const url = 'https://example.com/audio.mp3'
player.enqueue(url)
Example
player.enqueue(audioBuffer)
Example
player.enqueue(arrayBuffer)
Example
player.enqueue(blob)
PromiseDeques an audio source from queue
Kind: instance method of Player
Example
player.deque()
PromisePlays current audio source in queue
Kind: instance method of Player
Example
player.play()
PromiseStart playing audio sources in queue
Kind: instance method of Player
Example
player.playQueue()
PromiseStop playing current audio source
Kind: instance method of Player
Example
player.stop()
PromisePause playing current audio source
Kind: instance method of Player
Example
player.pause()
PromiseReplay current audio source
Kind: instance method of Player
Example
player.replay()
PromisePlay an audio Blob
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| blob | Blob | audio blob |
Example
const blob = new Blob([dataView], {
type: 'audio/wav'
})
player.playBlob(blob)
PromisePlay an AudioBuffer
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| audioBuffer | AudioBuffer | an AudioBuffer |
Example
player.playAudioBuffer(audioBuffer)
AudioBufferReturn current audio buffer playing
Kind: instance method of Player
Example
player.getCurrentAudioBuffer()
PromisePlay an MP3 url
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| url | String | MP3 url |
Example
const url = 'https://example.com/audio.mp3'
player.playUrl(url)
PromiseGet the binary audio data from an audio source url in ArrayBuffer form
Kind: instance method of Player
Returns: Promise - arrayBuffer
| Param | Type | Description |
|---|---|---|
| url | String | audio source url |
Example
const url = 'https://example.com/audio.mp3'
player.getAudioDataFromUrl()
.then(arrayBuffer => {
})
PromisePlay next audio source in queue
Kind: instance method of Player
Example
player.next()
PromisePlay previous audio source in queue
Kind: instance method of Player
Example
player.previous()
PromiseEnable to disable random playback
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| enabled | Boolean | boolean to enable random playback |
Example
player.setRandom(true)
PromiseEnable to disable repeat mode. Repeat mode replays the audio sources once the entire queue has finished playing.
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| enabled | Boolean | boolean to enable repeat mode |
Example
player.setRepeat(true)
BooleanReturn true if there's an audio source to play next in queue
Kind: instance method of Player
Returns: Boolean - hasNext
Example
const hasNext = player.hasNext()
BooleanReturn true if there's a previous audio source in queue
Kind: instance method of Player
Returns: Boolean - hasPrevious
Example
const hasPrevious = player.hasPrevious()
PromiseSet the plaback rate speed, range 0.75-2
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| playbackRate | Number | new playback rate |
Example
player.setPlaybackRate(2)
NumberGet the current plaback rate speed
Kind: instance method of Player
Returns: Number - playback rate speed
Example
const playbackRate = player.getPlaybackRate()
PromiseSet volume, range 0-1
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| volume | Number | volume value |
Example
player.setVolume(0.9)
NumberGet current volume value
Kind: instance method of Player
Returns: Number - volume - current volume value
Example
player.getVolume()
PromiseSet the maximum volume limit. For example if max volume is set to 0.6, then when volume is scaled from 0-0.6, meaning that volume level at 1 will play at 0.6
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| maxVolume | Number | max volume, range 0-1 |
Example
player.setMaxVolume(0.8)
NumberGet max volume value
Kind: instance method of Player
Returns: Number - maxVolume - max volume value
Example
player.getMaxVolume()
PromiseSet volume level to muted
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| enabled | Boolean | boolean to enable mute |
Example
player.setMuted(true)
NumberReturn elapsed time in seconds since the audio source started playing
Kind: instance method of Player
Returns: Number - time - current time
Example
player.getCurrentTime()
PromiseSeek to a specified time in audio source
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| seconds | Number | number of seconds to seek to |
Example
const seconds = 45
player.seekTo(seconds)
NumberGet duration of audio source
Kind: instance method of Player
Returns: Number - duration - duration of audio source
Example
player.getDuration()
StringGet current state of player
Kind: instance method of Player
Returns: String - - current state
Example
const currentState = player.getCurrentState()
console.log(currentState) // 'playing'
ObjectReturn event types
Kind: static property of Player
Returns: Object - eventTypes - all player event types
Example
const EventTypes = Player.EventTypes
{
LOG: 'log',
ERROR: 'error',
READY: 'ready',
PLAY: 'play',
REPLAY: 'replay',
PAUSE: 'pause',
STOP: 'pause',
NEXT: 'next',
PREVIOUS: 'previous',
RANDOM: 'random',
REPEAT: 'repeat',
PLAYBACK_RATE: 'playbackRate',
VOLUME: 'volume',
MAX_VOLUME: 'maxVolume',
MUTED: 'muted',
ENDED: 'ended',
ENQUEUE: 'enqueue',
DEQUE: 'deque',
EMPTY_QUEUE: 'emptyQueue',
STATE_CHANGE: 'stateChange'
}
objectClass reprensenting a Player
Kind: global namespace Example
const player = new Player()
object
StringPromisePromisePromisePromisePromisePromisePromisePromisePromisePromiseAudioBufferPromisePromisePromisePromisePromisePromiseBooleanBooleanPromiseNumberPromiseNumberPromiseNumberPromiseNumberPromiseNumberStringObjectCreate a Player
Listen for player events
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| eventName | String | name of even |
| callback | function | called when the event occurs |
Example
player.on(Player.EventTypes.PLAY, () => {
})
Example
player.on(Player.EventTypes.PLAYBACK_RATE, () => {
})
StringGet currently playing audio source url
Kind: instance method of Player
Example
const url = player.getCurrentUrl()
PromiseEmpties queue
Kind: instance method of Player
Example
player.emptyQueue()
PromiseEnqueues an audio source to play
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| source | DataView | Uint8Array | AudioBuffer | ArrayBuffer | String | an audio source to play |
Example
const url = 'https://example.com/audio.mp3'
player.enqueue(url)
Example
player.enqueue(audioBuffer)
Example
player.enqueue(arrayBuffer)
Example
player.enqueue(blob)
PromiseDeques an audio source from queue
Kind: instance method of Player
Example
player.deque()
PromisePlays current audio source in queue
Kind: instance method of Player
Example
player.play()
PromiseStart playing audio sources in queue
Kind: instance method of Player
Example
player.playQueue()
PromiseStop playing current audio source
Kind: instance method of Player
Example
player.stop()
PromisePause playing current audio source
Kind: instance method of Player
Example
player.pause()
PromiseReplay current audio source
Kind: instance method of Player
Example
player.replay()
PromisePlay an audio Blob
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| blob | Blob | audio blob |
Example
const blob = new Blob([dataView], {
type: 'audio/wav'
})
player.playBlob(blob)
PromisePlay an AudioBuffer
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| audioBuffer | AudioBuffer | an AudioBuffer |
Example
player.playAudioBuffer(audioBuffer)
AudioBufferReturn current audio buffer playing
Kind: instance method of Player
Example
player.getCurrentAudioBuffer()
PromisePlay an MP3 url
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| url | String | MP3 url |
Example
const url = 'https://example.com/audio.mp3'
player.playUrl(url)
PromiseGet the binary audio data from an audio source url in ArrayBuffer form
Kind: instance method of Player
Returns: Promise - arrayBuffer
| Param | Type | Description |
|---|---|---|
| url | String | audio source url |
Example
const url = 'https://example.com/audio.mp3'
player.getAudioDataFromUrl()
.then(arrayBuffer => {
})
PromisePlay next audio source in queue
Kind: instance method of Player
Example
player.next()
PromisePlay previous audio source in queue
Kind: instance method of Player
Example
player.previous()
PromiseEnable to disable random playback
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| enabled | Boolean | boolean to enable random playback |
Example
player.setRandom(true)
PromiseEnable to disable repeat mode. Repeat mode replays the audio sources once the entire queue has finished playing.
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| enabled | Boolean | boolean to enable repeat mode |
Example
player.setRepeat(true)
BooleanReturn true if there's an audio source to play next in queue
Kind: instance method of Player
Returns: Boolean - hasNext
Example
const hasNext = player.hasNext()
BooleanReturn true if there's a previous audio source in queue
Kind: instance method of Player
Returns: Boolean - hasPrevious
Example
const hasPrevious = player.hasPrevious()
PromiseSet the plaback rate speed, range 0.75-2
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| playbackRate | Number | new playback rate |
Example
player.setPlaybackRate(2)
NumberGet the current plaback rate speed
Kind: instance method of Player
Returns: Number - playback rate speed
Example
const playbackRate = player.getPlaybackRate()
PromiseSet volume, range 0-1
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| volume | Number | volume value |
Example
player.setVolume(0.9)
NumberGet current volume value
Kind: instance method of Player
Returns: Number - volume - current volume value
Example
player.getVolume()
PromiseSet the maximum volume limit. For example if max volume is set to 0.6, then when volume is scaled from 0-0.6, meaning that volume level at 1 will play at 0.6
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| maxVolume | Number | max volume, range 0-1 |
Example
player.setMaxVolume(0.8)
NumberGet max volume value
Kind: instance method of Player
Returns: Number - maxVolume - max volume value
Example
player.getMaxVolume()
PromiseSet volume level to muted
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| enabled | Boolean | boolean to enable mute |
Example
player.setMuted(true)
NumberReturn elapsed time in seconds since the audio source started playing
Kind: instance method of Player
Returns: Number - time - current time
Example
player.getCurrentTime()
PromiseSeek to a specified time in audio source
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| seconds | Number | number of seconds to seek to |
Example
const seconds = 45
player.seekTo(seconds)
NumberGet duration of audio source
Kind: instance method of Player
Returns: Number - duration - duration of audio source
Example
player.getDuration()
StringGet current state of player
Kind: instance method of Player
Returns: String - - current state
Example
const currentState = player.getCurrentState()
console.log(currentState) // 'PLAYING'
ObjectReturn event types
Kind: static property of Player
Returns: Object - eventTypes - all player event types
Example
const EventTypes = Player.EventTypes
{
LOG: 'log',
ERROR: 'error',
READY: 'ready',
PLAY: 'play',
REPLAY: 'replay',
PAUSE: 'pause',
STOP: 'pause',
NEXT: 'next',
PREVIOUS: 'previous',
RANDOM: 'random',
REPEAT: 'repeat',
PLAYBACK_RATE: 'playbackRate',
VOLUME: 'volume',
MAX_VOLUME: 'maxVolume',
MUTED: 'muted',
ENDED: 'ended',
ENQUEUE: 'enqueue',
DEQUE: 'deque',
EMPTY_QUEUE: 'emptyQueue',
STATE_CHANGE: 'stateChange'
}
Standard audio player
const {Player} = require('audio-director')
const player = new Player()
// add audio source(s) to play queue. Converts input to AudioBuffer.
player.enqueue(dataView|typedArray|arrayBuffer|url)
.then(audioBuffer => {
player.play()
})
YouTube player
const {YoutubePlayer} = require('audio-director')
const player = new YoutubePlayer()
const url = 'https://www.youtube.com/watch?v=_5joTyy3CCo&list=RDQMc4l8l2aQrNo'
player.enqueue(url)
.then(() => player.play())
https://github.com/miguelmota/audio-director
FAQs
Manage browser audio sources and playback
We found that audio-director demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ruby Central’s incident report on the RubyGems.org access dispute sparks backlash from former maintainers and renewed debate over project governance.
Research
/Security News
Socket researchers uncover how threat actors weaponize Discord across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.
Security News
Socket now integrates with Bun 1.3’s Security Scanner API to block risky packages at install time and enforce your organization’s policies in local dev and CI.