Class HTMLAudioInstance

Instance which wraps the <audio> element playback.

Memberof

htmlaudio

Hierarchy (View Summary)

Pixi.utils.EventEmitter
- HTMLAudioInstance

Implements

IMediaInstance

Index

Constructors

constructor

new HTMLAudioInstance(parent: HTMLAudioMedia): HTMLAudioInstance
Parameters
- parent: HTMLAudioMedia
  Parent element
Returns HTMLAudioInstance
Overrides EventEmitter.constructor
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:41

Properties

`Readonly`id

id: number

The current unique ID for this instance.

`Static` `Readonly`PADDING

PADDING: number

Extra padding, in seconds, to deal with low-latecy of HTMLAudio.

`Static`prefixed

prefixed: string | boolean

Accessors

filters

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

Returns PixiSound.Filter[]
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:90
set filters(_filters: PixiSound.Filter[]): void
Parameters
- _filters: PixiSound.Filter[]
Returns void
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:91

loop

get loop(): boolean
If the sound instance should loop playback

Returns boolean
Implementation of IMediaInstance.loop
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:82
set loop(loop: boolean): void
If the current instance is set to loop
Parameters
- loop: boolean
Returns void
Implementation of IMediaInstance.loop
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:83

muted

get muted(): boolean
true if the sound is muted

Returns boolean
Implementation of IMediaInstance.muted
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:85
set muted(muted: boolean): void
Set the muted state of the instance
Parameters
- muted: boolean
Returns void
Implementation of IMediaInstance.muted
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:86

paused

get paused(): boolean
Pauses the sound.

Returns boolean
Implementation of IMediaInstance.paused
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:51
set paused(paused: boolean): void
If the instance is paused, if the sound or global context is paused, this could still be false.
Parameters
- paused: boolean
Returns void
Implementation of IMediaInstance.paused
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:52

progress

get progress(): number
The current playback progress from 0 to 1.

Returns number
Implementation of IMediaInstance.progress
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:49

speed

get speed(): number
Set the instance speed from 0 to 1

Returns number
Implementation of IMediaInstance.speed
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:76
set speed(speed: number): void
Current speed of the instance. This is not the actual speed since it takes into account the global context and the sound volume.
Parameters
- speed: number
Returns void
Implementation of IMediaInstance.speed
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:77

volume

get volume(): number
Get the set the volume for this instance from 0 to 1

Returns number
Implementation of IMediaInstance.volume
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:79
set volume(volume: number): void
Current volume of the instance. This is not the actual volume since it takes into account the global context and the sound volume.
Parameters
- volume: number
Returns void
Implementation of IMediaInstance.volume
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:80

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
Don't use after this.

Returns void
Implementation of IMediaInstance.destroy
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:109

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

init

init(media: HTMLAudioMedia): void
Initialize the instance.
Parameters
- media: HTMLAudioMedia
  Same as constructor
Returns void
Implementation of IMediaInstance.init
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:67

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
Implementation of IMediaInstance.off
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
Implementation of IMediaInstance.on
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
Implementation of IMediaInstance.once
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

play

play(options: PlayOptions): void
Start playing the sound/
Parameters
- options: PlayOptions
Returns void
Implementation of IMediaInstance.play
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:97

refresh

refresh(): void
Call whenever the loop, speed or volume changes

Returns void
Implementation of IMediaInstance.refresh
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:93

refreshPaused

refreshPaused(): void
Handle changes in paused state, either globally or sound or instance

Returns void
Implementation of IMediaInstance.refreshPaused
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:95

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

set

set(
name: "paused" | "speed" | "volume" | "muted" | "loop",
value: number | boolean,
): this
Set a property by name, this makes it easy to chain values
Parameters
- name: "paused" | "speed" | "volume" | "muted" | "loop"
  Name of the property to set
- value: number | boolean
  Value to set property to
Returns this
Implementation of IMediaInstance.set
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:47

stop

stop(): void
Stop the sound playing

Returns void
Implementation of IMediaInstance.stop
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:74

toString

toString(): string
To string method for instance.

Returns string
The string representation of instance.
Implementation of IMediaInstance.toString
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioInstance.d.ts:114

Class HTMLAudioInstance

Memberof

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns HTMLAudioInstance

Properties

Readonlyid

Static ReadonlyPADDING

Staticprefixed

Accessors

filters

Returns PixiSound.Filter[]

Parameters

Returns void

loop

Returns boolean

Parameters

Returns void

muted

Returns boolean

Parameters

Returns void

paused

Returns boolean

Parameters

Returns void

progress

Returns number

speed

Returns number

Parameters

Returns void

volume

Returns number

Parameters

Returns void

Methods

addListener

Type Parameters

Parameters

Returns this

destroy

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

init

Parameters

Returns void

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

play

`Readonly`id

`Static` `Readonly`PADDING

`Static`prefixed