Class GeoXpWebAudio

GeoXpWebAudio is a plugin for GeoXpCore to manage audio content on web browsers

Index

Constructors

Methods

isPlaying load off on once play playSystemSound reload setMute setVolume silence stop stopAll test unload unlock

Constructors

constructor

new GeoXpWebAudio(
geoXpCore: GeoXpCore,
config: GeoXpWebAudioConfig,
): GeoXpWebAudio
Constructor for GeoXpWebAudio Class
Parameters
- geoXpCore: GeoXpCore
  GeoXpCore instance reference
- config: GeoXpWebAudioConfig
  GeoXpWebAudio configuration
Returns GeoXpWebAudio
GeoXpWebAudio singleton instance
- Defined in index.ts:61

Methods

isPlaying

isPlaying(overlap?: boolean): boolean
Checks if any sound is playing
Parameters
- overlap: boolean = false
  [overlap = false] if true, excludes overlapping audios
Returns boolean
Sound is playing
- Defined in index.ts:360

load

load(spotId: string, autoPlay?: boolean, volume?: number, fadeIn?: number): void
Loads spot content
Parameters
- spotId: string
  reference spot id
- autoPlay: boolean = false
  [autoPlay = false] play sound as soon as it loads
- volume: number = 1
  [volume = 1] playback volume from 0 to 1
- OptionalfadeIn: number
  [fadeIn = null] fade in time [ms]
Returns void
- Defined in index.ts:188

off

off<K>(
eventName: Key<K, GeoXpWebAudioEvent>,
listener: Listener<K, GeoXpWebAudioEvent>,
): void
Event wrapper off
Type Parameters
- K
Parameters
- eventName: Key<K, GeoXpWebAudioEvent>
  'playing' | 'stopped' | 'ended' | 'ready'
- listener: Listener<K, GeoXpWebAudioEvent>
  event listener
Returns void
- Defined in index.ts:434

on

on<K>(
eventName: Key<K, GeoXpWebAudioEvent>,
listener: Listener<K, GeoXpWebAudioEvent>,
): void
Event wrapper on
Type Parameters
- K
Parameters
- eventName: Key<K, GeoXpWebAudioEvent>
  'playing' | 'stopped' | 'ended' | 'ready'
- listener: Listener<K, GeoXpWebAudioEvent>
  event listener
Returns void
- Defined in index.ts:406

once

once<K>(
eventName: Key<K, GeoXpWebAudioEvent>,
listener: Listener<K, GeoXpWebAudioEvent>,
): void
Event wrapper once
Type Parameters
- K
Parameters
- eventName: Key<K, GeoXpWebAudioEvent>
  'playing' | 'stopped' | 'ended' | 'ready'
- listener: Listener<K, GeoXpWebAudioEvent>
  event listener
Returns void
- Defined in index.ts:420

play

play(spotId: string, volume?: number, fadeIn?: number): void
Plays spot content if loaded, else load() then play().
Parameters
- spotId: string
  reference spot id
- volume: number = 1
  [volume = 1] playback volume from 0 to 1
- OptionalfadeIn: number
  [fadeIn = null] fade in time [ms]
Returns void
- Defined in index.ts:264

playSystemSound

playSystemSound(url: string, forceHtml5?: boolean): void
Plays system sound
Parameters
- url: string
  url of sound to play
- OptionalforceHtml5: boolean
  force use html5 audio
Returns void
- Defined in index.ts:377

reload

reload(config: GeoXpWebAudioConfig): void
Resets GeoXpWebAudio to provided options
Parameters
- config: GeoXpWebAudioConfig
  GeoXpWebAudio configuration
Returns void
- Defined in index.ts:93

setMute

setMute(muted: boolean): void
Mutes all sounds
Parameters
- muted: boolean
  Mute or unmute
Returns void
- Defined in index.ts:151

setVolume

setVolume(volume: number): void
Sets the volume for all audios
Parameters
- volume: number
  Set volume 0 to 1
Returns void
- Defined in index.ts:136

silence

silence(): void
Plays silence

Returns void
- Defined in index.ts:121

stop

stop(spotId: string, fadeOut?: number): void
Stops specific spot content
Parameters
- spotId: string
  reference spot id
- OptionalfadeOut: number
  [fadeOut = null] fade out time [ms]
Returns void
- Defined in index.ts:316

stopAll

stopAll(): void
Stops all sounds imediately

Returns void
- Defined in index.ts:143

test

test(): void
Plays test sound

Returns void
- Defined in index.ts:114

unload

unload(): void
Clears instance sounds and buffer

Returns void
- Defined in index.ts:105

unlock

unlock(): void
Unlocks web audio

Returns void
- Defined in index.ts:128