audio | @geps/geofs-types

Can be accessed with audio.

Index

Variables

Functions

Variables

impl

impl: { cordova: { decodingStack: []; player: null; createPlater: any; destroyPlayer: any; loadMP3: any; playSound: any; setRate: any; setVolume: any; stopSound: any }; html5: { player: null; createPlayer: any; destroyPlayer: any; loadMP3: any; playFile: any; playSound: any; setRate: any; setVolume: any; stopSound: any }; peer2peer: { webRTCiFrame: HTMLIFrameElement; destroy: any; init: any }; webAudio: { context: AudioContext; decodingStack: (() => void)[]; createPlayer: any; destroyPlayer: any; loadMP3: any; playSound: any; setRate: any; setVolume: any; stackDecoding: any; stopSound: any } }

Type declaration

cordova: { decodingStack: []; player: null; createPlater: any; destroyPlayer: any; loadMP3: any; playSound: any; setRate: any; setVolume: any; stopSound: any }
- decodingStack: []
- player: null
- createPlater:function
  - createPlater(): null | { decodingStack: []; player: null; createPlater: any; destroyPlayer: any; loadMP3: any; playSound: any; setRate: any; setVolume: any; stopSound: any }
  - - Defined in typings/audio.d.ts:36
    Returns null | { decodingStack: []; player: null; createPlater: any; destroyPlayer: any; loadMP3: any; playSound: any; setRate: any; setVolume: any; stopSound: any }
- destroyPlayer:function
  - destroyPlayer(): void
  - - Defined in typings/audio.d.ts:42
    Returns void
- loadMP3:function
  - loadMP3(a: string, b: string): void
  - - Defined in typings/audio.d.ts:37
    Parameters
    - a: string
    - b: string
    Returns void
- playSound:function
  - playSound(a: string, b: boolean): void
  - - Defined in typings/audio.d.ts:38
    Parameters
    - a: string
    - b: boolean
    Returns void
- setRate:function
  - setRate(a: string, b: number): void
  - - Defined in typings/audio.d.ts:41
    Parameters
    - a: string
    - b: number
    Returns void
- setVolume:function
  - setVolume(a: string, b: number): void
  - - Defined in typings/audio.d.ts:40
    Parameters
    - a: string
    - b: number
    Returns void
- stopSound:function
  - stopSound(a: string): void
  - - Defined in typings/audio.d.ts:39
    Parameters
    - a: string
    Returns void
html5: { player: null; createPlayer: any; destroyPlayer: any; loadMP3: any; playFile: any; playSound: any; setRate: any; setVolume: any; stopSound: any }
- player: null
- createPlayer:function
  - createPlayer(): null | { player: null; createPlayer: any; destroyPlayer: any; loadMP3: any; playFile: any; playSound: any; setRate: any; setVolume: any; stopSound: any }
  - - Defined in typings/audio.d.ts:24
    Returns null | { player: null; createPlayer: any; destroyPlayer: any; loadMP3: any; playFile: any; playSound: any; setRate: any; setVolume: any; stopSound: any }
- destroyPlayer:function
  - destroyPlayer(): void
  - - Defined in typings/audio.d.ts:31
    Returns void
- loadMP3:function
  - loadMP3(a: string, b: string, c: boolean): void
  - - Defined in typings/audio.d.ts:25
    Parameters
    - a: string
    - b: string
    - c: boolean
    Returns void
- playFile:function
  - playFile(a: string, b: boolean): void
  - - Defined in typings/audio.d.ts:26
    Parameters
    - a: string
    - b: boolean
    Returns void
- playSound:function
  - playSound(a: string): void
  - - Defined in typings/audio.d.ts:27
    Parameters
    - a: string
    Returns void
- setRate:function
  - setRate(a?: any, b?: any): void
  - - Defined in typings/audio.d.ts:30
    Parameters
    - Optional a: any
    - Optional b: any
    Returns void
- setVolume:function
  - setVolume(a: string, b: number): void
  - - Defined in typings/audio.d.ts:29
    Parameters
    - a: string
    - b: number
    Returns void
- stopSound:function
  - stopSound(a: string): void
  - - Defined in typings/audio.d.ts:28
    Parameters
    - a: string
    Returns void
peer2peer: { webRTCiFrame: HTMLIFrameElement; destroy: any; init: any }
- webRTCiFrame: HTMLIFrameElement
- destroy:function
  - destroy(): void
  - - Defined in typings/audio.d.ts:47
    Returns void
- init:function
  - init(a: string): void
  - - Defined in typings/audio.d.ts:46
    Parameters
    - a: string
    Returns void
webAudio: { context: AudioContext; decodingStack: (() => void)[]; createPlayer: any; destroyPlayer: any; loadMP3: any; playSound: any; setRate: any; setVolume: any; stackDecoding: any; stopSound: any }
- context: AudioContext
- decodingStack: (() => void)[]
- createPlayer:function
  - createPlayer(): null | { context: AudioContext; decodingStack: (() => void)[]; createPlayer: any; destroyPlayer: any; loadMP3: any; playSound: any; setRate: any; setVolume: any; stackDecoding: any; stopSound: any }
  - - Defined in typings/audio.d.ts:13
    Returns null | { context: AudioContext; decodingStack: (() => void)[]; createPlayer: any; destroyPlayer: any; loadMP3: any; playSound: any; setRate: any; setVolume: any; stackDecoding: any; stopSound: any }
- destroyPlayer:function
  - destroyPlayer(): void
  - - Defined in typings/audio.d.ts:20
    Returns void
- loadMP3:function
  - loadMP3(a: string, b: string): void
  - - Defined in typings/audio.d.ts:15
    Parameters
    - a: string
    - b: string
    Returns void
- playSound:function
  - playSound(a: string, b: boolean): void
  - - Defined in typings/audio.d.ts:16
    Parameters
    - a: string
    - b: boolean
    Returns void
- setRate:function
  - setRate(a: string, b: number): void
  - - Defined in typings/audio.d.ts:19
    Parameters
    - a: string
    - b: number
    Returns void
- setVolume:function
  - setVolume(a: string, b: number): void
  - - Defined in typings/audio.d.ts:18
    Parameters
    - a: string
    - b: number
    Returns void
- stackDecoding:function
  - stackDecoding(a: (() => void), b?: any): void
  - - Defined in typings/audio.d.ts:14
    Parameters
    - a: (() => void)
      - (): void
        Returns void
    - Optional b: any
    Returns void
- stopSound:function
  - stopSound(a: string): void
  - - Defined in typings/audio.d.ts:17
    Parameters
    - a: string
    Returns void

on

on: boolean

soundplayer

soundplayer: typeof webAudio | typeof html5

sounds

sounds: {}

Type declaration

[key: string]: { cut: number[]; effects?: { [ key in "volume" | "pitch" | "play" | "start" | "stop"]: { lastValue: number | undefined | null; ratio: number } }; loaded: boolean; loading: boolean; loop?: boolean; playing: boolean }
- cut: number[]
- Optional effects?: { [ key in "volume" | "pitch" | "play" | "start" | "stop"]: { lastValue: number | undefined | null; ratio: number } }
- loaded: boolean
- loading: boolean
- Optional loop?: boolean
- playing: boolean

Functions

init

init(a: Sound[]): void

- Defined in typings/audio.d.ts:69
Parameters
- a: Sound[]
Returns void

loaded

loaded(a: string): void

- Defined in typings/audio.d.ts:70
Parameters
- a: string
Returns void

mute

mute(): void

- Defined in typings/audio.d.ts:75
Returns void

playShutdown

playShutdown(): void

- Defined in typings/audio.d.ts:78
Returns void

playSoundLoop

playSoundLoop(a: string, b: boolean): void

- Defined in typings/audio.d.ts:79
Parameters
- a: string
- b: boolean
Returns void

playStartup

playStartup(): void

- Defined in typings/audio.d.ts:77
Returns void

stop

stop(): void

- Defined in typings/audio.d.ts:74
Returns void

stopSoundLoop

stopSoundLoop(a: string): void

- Defined in typings/audio.d.ts:80
Parameters
- a: string
Returns void

stopped

stopped(a: string): void

- Defined in typings/audio.d.ts:71
Parameters
- a: string
Returns void

toggleMute

toggleMute(): void

- Defined in typings/audio.d.ts:73
Returns void

unmute

unmute(): void

- Defined in typings/audio.d.ts:76
Returns void

update

update(): void

- Defined in typings/audio.d.ts:72
Returns void

Index

Variables

Functions

Variables

impl

Type declaration

cordova: { decodingStack: []; player: null; createPlater: any; destroyPlayer: any; loadMP3: any; playSound: any; setRate: any; setVolume: any; stopSound: any }

decodingStack: []

player: null

createPlater:function

Returns null | { decodingStack: []; player: null; createPlater: any; destroyPlayer: any; loadMP3: any; playSound: any; setRate: any; setVolume: any; stopSound: any }

destroyPlayer:function

Returns void

loadMP3:function

Parameters

a: string

b: string

Returns void

playSound:function

Parameters

a: string

b: boolean

Returns void

setRate:function

Parameters

a: string

b: number

Returns void

setVolume:function

Parameters

a: string

b: number

Returns void

stopSound:function

Parameters

a: string

Returns void

html5: { player: null; createPlayer: any; destroyPlayer: any; loadMP3: any; playFile: any; playSound: any; setRate: any; setVolume: any; stopSound: any }

player: null

createPlayer:function

Returns null | { player: null; createPlayer: any; destroyPlayer: any; loadMP3: any; playFile: any; playSound: any; setRate: any; setVolume: any; stopSound: any }

destroyPlayer:function

Returns void

loadMP3:function

Parameters

a: string

b: string

c: boolean

Returns void

playFile:function

Parameters

a: string

b: boolean

Returns void

playSound:function

Parameters

a: string

Returns void

setRate:function

Parameters

Optional a: any

Optional b: any

Returns void

setVolume:function

Parameters

a: string

b: number

Returns void

stopSound:function

Parameters

a: string

Returns void

peer2peer: { webRTCiFrame: HTMLIFrameElement; destroy: any; init: any }

webRTCiFrame: HTMLIFrameElement

destroy:function

Returns void

init:function

Parameters

a: string

Returns void