AudioPlayer

ug-js-sdk

---

ug-js-sdk / AudioPlayer

Class: AudioPlayer

Defined in: playback-manager/audio-player/AudioPlayer.ts:8

Extends

• EventEmitter

Implements

• IAudioPlayer

Constructors

Constructor

new AudioPlayer(): AudioPlayer

Defined in: playback-manager/audio-player/AudioPlayer.ts:41

Returns

AudioPlayer

Overrides

EventEmitter.constructor

Properties

logger

protected logger: ILogger

Defined in: core/EventEmitter.ts:5

Implementation of

IAudioPlayer.logger

Inherited from

EventEmitter.logger

Methods

on()

on<K>(event, callback): void

Defined in: core/EventEmitter.ts:11

Type Parameters

K

K extends string

Parameters

event

K

callback

any

Returns

void

Implementation of

IAudioPlayer.on

Inherited from

EventEmitter.on

---

off()

off<K>(event, callback): void

Defined in: core/EventEmitter.ts:18

Type Parameters

K

K extends string

Parameters

event

K

callback

any

Returns

void

Implementation of

IAudioPlayer.off

Inherited from

EventEmitter.off

---

emit()

emit<K>(event, data?): Promise<void>

Defined in: core/EventEmitter.ts:28

Type Parameters

K

K extends string

Parameters

event

K

data?

unknown

Returns

Promise<void>

Implementation of

IAudioPlayer.emit

Inherited from

EventEmitter.emit

---

removeAllListeners()

removeAllListeners(event?): void

Defined in: core/EventEmitter.ts:73

Parameters

event?

string

Returns

void

Implementation of

IAudioPlayer.removeAllListeners

Inherited from

EventEmitter.removeAllListeners

---

initialize()

initialize(): Promise<void>

Defined in: playback-manager/audio-player/AudioPlayer.ts:61

Returns

Promise<void>

Implementation of

IAudioPlayer.initialize

---

reset()

reset(): void

Defined in: playback-manager/audio-player/AudioPlayer.ts:112

Returns

void

Implementation of

IAudioPlayer.reset

---

enqueue()

enqueue(audioData): void

Defined in: playback-manager/audio-player/AudioPlayer.ts:116

Parameters

audioData

string

Returns

void

Implementation of

IAudioPlayer.enqueue

---

markComplete()

markComplete(): void

Defined in: playback-manager/audio-player/AudioPlayer.ts:131

Returns

void

Implementation of

IAudioPlayer.markComplete

---

play()

play(): Promise<void>

Defined in: playback-manager/audio-player/AudioPlayer.ts:362

Returns

Promise<void>

Implementation of

IAudioPlayer.play

---

pause()

pause(): Promise<void>

Defined in: playback-manager/audio-player/AudioPlayer.ts:445

Returns

Promise<void>

Implementation of

IAudioPlayer.pause

---

resume()

resume(): Promise<void>

Defined in: playback-manager/audio-player/AudioPlayer.ts:454

Returns

Promise<void>

Implementation of

IAudioPlayer.resume

---

stop()

stop(): Promise<void>

Defined in: playback-manager/audio-player/AudioPlayer.ts:466

Returns

Promise<void>

Implementation of

IAudioPlayer.stop

---

getCurrentTime()

getCurrentTime(): number

Defined in: playback-manager/audio-player/AudioPlayer.ts:472

Returns

number

Implementation of

IAudioPlayer.getCurrentTime

---

getQueueLength()

getQueueLength(): number

Defined in: playback-manager/audio-player/AudioPlayer.ts:479

Returns

number

Implementation of

IAudioPlayer.getQueueLength

---

getRemainingAudioSeconds()

getRemainingAudioSeconds(): number

Defined in: playback-manager/audio-player/AudioPlayer.ts:487

Get the total remaining audio playback time in seconds. Includes both queued buffers and currently scheduled (playing) audio.

Returns

number

Implementation of

IAudioPlayer.getRemainingAudioSeconds

---

flush()

flush(): Promise<void>

Defined in: playback-manager/audio-player/AudioPlayer.ts:569

Returns

Promise<void>

---

resetAboutToComplete()

resetAboutToComplete(): void

Defined in: playback-manager/audio-player/AudioPlayer.ts:604

Returns

void

Implementation of

IAudioPlayer.resetAboutToComplete

---

getFrameStats()

getFrameStats(): object

Defined in: playback-manager/audio-player/AudioPlayer.ts:611

Get frame statistics for debugging

Returns

object

totalFramesExtracted

totalFramesExtracted: number

totalFramesDecoded

totalFramesDecoded: number

totalFramesFailed

totalFramesFailed: number

extractorRemainingBufferSize

extractorRemainingBufferSize: number

---

dispose()

dispose(): void

Defined in: playback-manager/audio-player/AudioPlayer.ts:629

Dispose of all resources and clean up. Should be called when the audio player is no longer needed.

Returns

void

Implementation of

IAudioPlayer.dispose

---

destroy()

destroy(): void

Defined in: playback-manager/audio-player/AudioPlayer.ts:681

Destroy the audio player and clean up resources

Returns

void

Deprecated

Use dispose() instead