Class HTMLAudioMedia

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

Memberof

htmlaudio

Hierarchy (View Summary)

Pixi.utils.EventEmitter
- HTMLAudioMedia

Implements

IMedia

Index

Constructors

constructor

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

Properties

parent

parent: Sound

`Static`prefixed

prefixed: string | boolean

Accessors

context

get context(): HTMLAudioContext
Reference to the context.

Returns HTMLAudioContext
Implementation of IMedia.context
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioMedia.d.ts:31

duration

get duration(): number
THe duration of the media in seconds.

Returns number
Implementation of IMedia.duration
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioMedia.d.ts:26

filters

get filters(): PixiSound.Filter[]
The collection of filters, does not apply to HTML Audio.

Returns PixiSound.Filter[]
Implementation of IMedia.filters
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioMedia.d.ts:33
set filters(_filters: PixiSound.Filter[]): void
Collection of global filters
Parameters
- _filters: PixiSound.Filter[]
Returns void
Implementation of IMedia.filters
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioMedia.d.ts:34

isPlayable

get isPlayable(): boolean
If the audio media is playable (ready).

Returns boolean
Implementation of IMedia.isPlayable
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioMedia.d.ts:21

source

get source(): HTMLAudioElement
Get the audio source element.

Returns HTMLAudioElement
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioMedia.d.ts:41

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

create

create(): HTMLAudioInstance
Returns HTMLAudioInstance
Implementation of IMedia.create
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioMedia.d.ts:16

destroy

destroy(): void
Returns void
Implementation of IMedia.destroy
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioMedia.d.ts:35

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(parent: Sound): void
Parameters
- parent: Sound
Returns void
Implementation of IMedia.init
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioMedia.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

load

load(callback?: LoadedCallback): void
Parameters
- Optionalcallback: LoadedCallback
Returns void
Implementation of IMedia.load
- Defined in node_modules/@pixi/sound/lib/htmlaudio/HTMLAudioMedia.d.ts:42

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

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

Class HTMLAudioMedia

Memberof

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns HTMLAudioMedia

Properties

parent

Staticprefixed

Accessors

context

Returns HTMLAudioContext

duration

Returns number

filters

Returns PixiSound.Filter[]

Parameters

Returns void

isPlayable

Returns boolean

source

Returns HTMLAudioElement

Methods

addListener

Type Parameters

Parameters

Returns this

create

Returns HTMLAudioInstance

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)[]

load

Parameters

Returns void

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

Settings

On This Page

`Static`prefixed