Class BaseSound

Class containing all the shared state and behavior of a sound object, independent of the implementation.

Hierarchy (View Summary)

EventEmitter
- BaseSound
  - HTML5AudioSound
  - WebAudioSound

Constructors

constructor

new BaseSound(
    manager: BaseSoundManager,
    key: string,
    config?: SoundConfig,
): BaseSound
Parameters
- manager: BaseSoundManager
  Reference to the current sound manager instance.
- key: string
  Asset key for the sound.
- Optionalconfig: SoundConfig
  An optional config object containing default sound settings.
Returns BaseSound
Overrides EventEmitter.constructor
- Defined in types/phaser.d.ts:105216

Properties

`Readonly`currentMarker

currentMarker: SoundMarker

Currently playing marker. 'null' if whole sound is playing.

`Readonly`duration

duration: number

A value representing the duration, in seconds. It could be total sound duration or a marker duration.

`Readonly`isPaused

isPaused: boolean

Flag indicating if sound is currently paused.

`Readonly`isPlaying

isPlaying: boolean

Flag indicating if sound is currently playing.

`Readonly`key

key: string

Asset key for the sound.

manager

manager: BaseSoundManager

Local reference to the sound manager.

`Readonly`markers

markers: { [key: string]: SoundMarker }

Object containing markers definitions.

pendingRemove

pendingRemove: boolean

Flag indicating if destroy method was called on this sound.

`Readonly`totalDuration

totalDuration: number

The total duration of the sound in seconds.

`Readonly`totalRate

totalRate: number

A property that holds the value of sound's actual playback rate, after its rate and detune values has been combined with global rate and detune values.

Methods

addListener

addListener(event: string | symbol, fn: Function, context?: any): this
Add a listener for a given event.
Parameters
- event: string | symbol
  The event name.
- fn: Function
  The listener function.
- Optionalcontext: any
  The context to invoke the listener with. Default this.
Returns this
Inherited from EventEmitter.addListener
- Defined in types/phaser.d.ts:9645

addMarker

addMarker(marker: SoundMarker): boolean
Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object. This allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.
Parameters
- marker: SoundMarker
  Marker object.
Returns boolean
- Defined in types/phaser.d.ts:105277

applyConfig

applyConfig(): void
Method used internally for applying config values to some of the sound properties.

Returns void
- Defined in types/phaser.d.ts:105323

calculateRate

calculateRate(): void
Method used internally to calculate total playback rate of the sound.

Returns void
- Defined in types/phaser.d.ts:105340

destroy

destroy(): void
Destroys this sound and all associated events and marks it for removal from the sound manager.

Returns void
Overrides EventEmitter.destroy
- Defined in types/phaser.d.ts:105345

emit

emit(event: string | symbol, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Parameters
- event: string | symbol
  The event name.
- ...args: any[]
  Additional arguments that will be passed to the event handler.
Returns boolean
Inherited from EventEmitter.emit
- Defined in types/phaser.d.ts:9629

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 types/phaser.d.ts:9610

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
  The event name.
Returns number
Inherited from EventEmitter.listenerCount
- Defined in types/phaser.d.ts:9622

listeners

listeners(event: string | symbol): Function[]
Return the listeners registered for a given event.
Parameters
- event: string | symbol
  The event name.
Returns Function[]
Inherited from EventEmitter.listeners
- Defined in types/phaser.d.ts:9616

off

off(event: string | symbol, fn?: Function, context?: any, once?: boolean): this
Remove the listeners of a given event.
Parameters
- event: string | symbol
  The event name.
- Optionalfn: Function
  Only remove the listeners that match this function.
- Optionalcontext: any
  Only remove the listeners that have this context.
- Optionalonce: boolean
  Only remove one-time listeners.
Returns this
Inherited from EventEmitter.off
- Defined in types/phaser.d.ts:9671

on

on(event: string | symbol, fn: Function, context?: any): this
Add a listener for a given event.
Parameters
- event: string | symbol
  The event name.
- fn: Function
  The listener function.
- Optionalcontext: any
  The context to invoke the listener with. Default this.
Returns this
Inherited from EventEmitter.on
- Defined in types/phaser.d.ts:9637

once

once(event: string | symbol, fn: Function, context?: any): this
Add a one-time listener for a given event.
Parameters
- event: string | symbol
  The event name.
- fn: Function
  The listener function.
- Optionalcontext: any
  The context to invoke the listener with. Default this.
Returns this
Inherited from EventEmitter.once
- Defined in types/phaser.d.ts:9653

pause

pause(): boolean
Pauses the sound. This only works if the sound is currently playing.

You can inspect the isPlaying and isPaused properties to check the state.

Returns boolean
- Defined in types/phaser.d.ts:105306

play

play(markerName?: string | SoundConfig, config?: SoundConfig): boolean
Play this sound, or a marked section of it.

It always plays the sound from the start. If you want to start playback from a specific time you can set 'seek' setting of the config object, provided to this call, to that value.
Parameters
- OptionalmarkerName: string | SoundConfig
  If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object. Default ''.
- Optionalconfig: SoundConfig
  Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.
Returns boolean
- Defined in types/phaser.d.ts:105299

removeAllListeners

removeAllListeners(event?: string | symbol): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: string | symbol
  The event name.
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in types/phaser.d.ts:9677

removeListener

removeListener(
    event: string | symbol,
    fn?: Function,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Parameters
- event: string | symbol
  The event name.
- Optionalfn: Function
  Only remove the listeners that match this function.
- Optionalcontext: any
  Only remove the listeners that have this context.
- Optionalonce: boolean
  Only remove one-time listeners.
Returns this
Inherited from EventEmitter.removeListener
- Defined in types/phaser.d.ts:9662

removeMarker

removeMarker(markerName: string): SoundMarker
Removes a marker from the sound.
Parameters
- markerName: string
  The name of the marker to remove.
Returns SoundMarker
- Defined in types/phaser.d.ts:105289

resetConfig

resetConfig(): void
Method used internally for resetting values of some of the config properties.

Returns void
- Defined in types/phaser.d.ts:105328

resume

resume(): boolean
Resumes the sound. This only works if the sound is paused and not already playing.

You can inspect the isPlaying and isPaused properties to check the state.

Returns boolean
- Defined in types/phaser.d.ts:105313

shutdown

shutdown(): void
Removes all listeners.

Returns void
Inherited from EventEmitter.shutdown
- Defined in types/phaser.d.ts:9600

stop

stop(): boolean
Stop playing this sound.

Returns boolean
- Defined in types/phaser.d.ts:105318

update

update(time: number, delta: number): void
Update method called automatically by sound manager on every game step.
Parameters
- time: number
  The current timestamp as generated by the Request Animation Frame or SetTimeout.
- delta: number
  The delta time elapsed since the last frame.
Returns void
- Defined in types/phaser.d.ts:105335

updateMarker

updateMarker(marker: SoundMarker): boolean
Updates previously added marker.
Parameters
- marker: SoundMarker
  Marker object with updated values.
Returns boolean
- Defined in types/phaser.d.ts:105283

Class BaseSound

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BaseSound

Properties

ReadonlycurrentMarker

Readonlyduration

ReadonlyisPaused

ReadonlyisPlaying

Readonlykey

manager

Readonlymarkers

pendingRemove

ReadonlytotalDuration

ReadonlytotalRate

Methods

addListener

Parameters

Returns this

addMarker

Parameters

Returns boolean

applyConfig

Returns void

calculateRate

Returns void

destroy

Returns void

emit

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

listenerCount

Parameters

Returns number

listeners

Parameters

Returns Function[]

off

Parameters

Returns this

on

Parameters

Returns this

once

Parameters

Returns this

pause

Returns boolean

play

Parameters

Returns boolean

removeAllListeners

Parameters

Returns this

removeListener

Parameters

Returns this

removeMarker

Parameters

Returns SoundMarker

resetConfig

Returns void

resume

Returns boolean

shutdown

Returns void

stop

Returns boolean

update

Parameters

Returns void

updateMarker

`Readonly`currentMarker

`Readonly`duration

`Readonly`isPaused

`Readonly`isPlaying

`Readonly`key

`Readonly`markers

`Readonly`totalDuration

`Readonly`totalRate