Class HTMLAudioContext

The fallback version of WebAudioContext which uses <audio> instead of WebAudio API.

Memberof

htmlaudio

Hierarchy (View Summary)

Pixi.utils.EventEmitter
- HTMLAudioContext

Implements

IMediaContext

Index

Constructors

constructor

new HTMLAudioContext(): HTMLAudioContext
Returns HTMLAudioContext
Inherited from EventEmitter.constructor

Properties

muted

muted: boolean

Current muted status of the context

paused

paused: boolean

Current paused status

speed

speed: number

Current global speed from 0 to 1

volume

volume: number

Current volume from 0 to 1

`Static`prefixed

prefixed: string | boolean

Accessors

audioContext

get audioContext(): AudioContext
HTML Audio does not support audioContext

Returns AudioContext
Implementation of IMediaContext.audioContext
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioContext.d.ts:32

filters

get filters(): PixiSound.Filter[]
HTML Audio does not support filters, this is non-functional API.

Returns PixiSound.Filter[]
Implementation of IMediaContext.filters
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioContext.d.ts:25
set filters(_filters: PixiSound.Filter[]): void
Collection of global filter
Parameters
- _filters: PixiSound.Filter[]
Returns void
Implementation of IMediaContext.filters
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioContext.d.ts:26

Methods

addListener

addListener<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

destroy

destroy(): void
Destroy and don't use after this

Returns void
Implementation of IMediaContext.destroy
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioContext.d.ts:44

emit

emit<T extends string | symbol>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends string | symbol>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

refresh

refresh(): void
Internal trigger when volume, mute or speed changes

Returns void
Implementation of IMediaContext.refresh
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioContext.d.ts:19

refreshPaused

refreshPaused(): void
Internal trigger paused changes

Returns void
Implementation of IMediaContext.refreshPaused
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioContext.d.ts:21

removeAllListeners

removeAllListeners(event?: string | symbol): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

toggleMute

toggleMute(): boolean
Toggles the muted state.

Returns boolean
The current muted state.
Implementation of IMediaContext.toggleMute
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioContext.d.ts:37

togglePause

togglePause(): boolean
Toggles the paused state.

Returns boolean
The current paused state.
Implementation of IMediaContext.togglePause
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioContext.d.ts:42

Class HTMLAudioContext

Memberof

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns HTMLAudioContext

Properties

muted

paused

speed

volume

Staticprefixed

Accessors

audioContext

Returns AudioContext

filters

Returns PixiSound.Filter[]

Parameters

Returns void

Methods

addListener

Type Parameters

Parameters

Returns this

destroy

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ((...args: any[]) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

refresh

Returns void

refreshPaused

Returns void

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

toggleMute

Returns boolean

togglePause

Returns boolean

Settings

On This Page

`Static`prefixed