Class GeoXpWeb

constructor

• new GeoXpWeb(
      config: GeoXpWebConfig,
      options?: { throwErrors?: boolean },
  ): GeoXpWeb

• Constructor for GeoXpWeb Class

  Parameters

  • config: GeoXpWebConfig

    GeoXpWeb configuration
  • Optionaloptions: { throwErrors?: boolean }

    Options for GeoXpWeb

    • OptionalthrowErrors?: boolean

      Whether errors should be throw or not. Throw is default behavior

  Returns GeoXpWeb

  GeoXpWeb singleton instance

Readonlyaudio

Readonlycore

Readonlygeolocation

Optional Readonlystorage

off

• off<K>(
      eventName: Key<K, GeoXpWebEvent>,
      listener: Listener<K, GeoXpWebEvent>,
  ): void

• Event wrapper off

  Type Parameters

  • K

  Parameters

  • eventName: Key<K, GeoXpWebEvent>

    'incoming' | 'active' | 'inactive' | 'visited' | 'last' | 'complete' | 'playing' | 'stopped' | 'ended' | 'ready' | 'location'
  • listener: Listener<K, GeoXpWebEvent>

    event listener

  Returns void

on

• on<K>(
      eventName: Key<K, GeoXpWebEvent>,
      listener: Listener<K, GeoXpWebEvent>,
  ): void

• Event wrapper on

  Type Parameters

  • K

  Parameters

  • eventName: Key<K, GeoXpWebEvent>

    'incoming' | 'active' | 'inactive' | 'visited' | 'last' | 'complete' | 'playing' | 'stopped' | 'ended' | 'ready' | 'location'
  • listener: Listener<K, GeoXpWebEvent>

    event listener

  Returns void

once

• once<K>(
      eventName: Key<K, GeoXpWebEvent>,
      listener: Listener<K, GeoXpWebEvent>,
  ): void

• Event wrapper once

  Type Parameters

  • K

  Parameters

  • eventName: Key<K, GeoXpWebEvent>

    'incoming' | 'active' | 'inactive' | 'visited' | 'last' | 'complete' | 'playing' | 'stopped' | 'ended' | 'ready' | 'location'
  • listener: Listener<K, GeoXpWebEvent>

    event listener

  Returns void

reload

• reload(config: GeoXpWebConfig): void

• Loads a new config

  Parameters

  • config: GeoXpWebConfig

    GeoXpWebConfig configuration

  Returns void

unlock

• unlock(): void

• Unlocks web audio and web geolocation

  Returns void