AudioPlayer

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:52

Event-driven AudioPlayer class for framework-agnostic audio control

Example

// Basic usage
const player = new AudioPlayer();
await player.load('song.mp3');
player.setLoop(10.0, 20.5);
player.play();

// Event handling
player.on('timeupdate', (time) => console.log('Current time:', time));
player.on('loopchange', (loop) => console.log('Loop changed:', loop));

Constructors

Constructor

new AudioPlayer(options?): AudioPlayer

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:57

Create a new AudioPlayer instance

Parameters

options?

Configuration options

Returns

AudioPlayer

Accessors

audioBuffer

Get Signature

get audioBuffer(): any

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:97

Get current audio buffer

Returns

any

The loaded audio buffer

---

audioContext

Get Signature

get audioContext(): any

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:86

Get or create Web Audio API context

Returns

any

The audio context

---

state

Get Signature

get state(): object

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:105

Get current playback state

Returns

object

Current state information

currentTime

currentTime: any

duration

duration: any

isPaused

isPaused: any

isPlaying

isPlaying: any

loop

loop: any

volume

volume: any

Methods

clearLoop()

clearLoop(): void

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:270

Clear loop region (play entire track)

Returns

void

---

dispose()

dispose(): void

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:350

Clean up resources (important for web apps)

Returns

void

---

getCurrentTime()

getCurrentTime(): any

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:304

Get current playback time

Returns

any

Current time in seconds

---

load()

load(source): Promise<void>

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:121

Load audio from various sources

Parameters

source

any

URL, File object, or AudioBuffer

Returns

Promise<void>

Promise that resolves when audio is loaded

---

off()

off(event, callback): void

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:337

Remove event listener

Parameters

event

any

Event name

callback

any

Callback function to remove

Returns

void

---

on()

on(event, callback): void

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:325

Add event listener

Parameters

event

any

Event name (play, pause, stop, timeupdate, etc.)

callback

any

Event callback function

Returns

void

---

pause()

pause(): void

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:203

Pause playback

Returns

void

---

play()

play(): void

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:159

Start playback

Returns

void

Throws

If no audio is loaded

---

seek()

seek(time): void

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:280

Seek to specific time

Parameters

time

any

Time in seconds

Returns

void

Throws

If no audio is loaded

---

setLoop()

setLoop(start, end): void

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:245

Set loop region

Parameters

start

any

Start time in seconds

end

any

End time in seconds

Returns

void

Throws

If no audio is loaded

---

setVolume()

setVolume(volume): void

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:229

Set volume level

Parameters

volume

any

Volume level (0.0 to 1.0)

Returns

void

---

stop()

stop(): void

Defined in: packages/pleco-xa/src/scripts/analysis/AudioPlayer.ts:217

Stop playback and reset position

Returns

void