Class AudioPlayer<Files>

An audio manager which handles keeping track of, loading, and playing multiple audio files.

Type Parameters

const Files extends Readonly<AudioFiles>

Hierarchy

ListenTarget<AllAudioFileEvents>
- AudioPlayer

Index

Constructors

constructor

new AudioPlayer<
    const Files extends
        Readonly<
            Readonly<
                Record<
                    string,
                    Readonly<
                        Pick<
                            Readonly<
                                { sources: readonly AudioFileSource[] } & PartialWithUndefined<
                                    {
                                        audioCache: AudioFileCache;
                                        audioContext: BaseAudioContext;
                                        createEffects: (
                                            audioContext: BaseAudioContext,
                                        ) => (...) | (...) | (...);
                                        fetch: (url: string) => Promise<(...)>;
                                        loadOnPlay: boolean;
                                        outputNode: AudioNode;
                                        volume: number;
                                    },
                                >,
                            >,
                            "fetch"
                            | "volume"
                            | "createEffects"
                            | "sources",
                        >,
                    >,
                >,
            >,
        >,
>(
    initFiles: Readonly<Files>,
    options?: Readonly<PartialWithUndefined<AudioPlayerOptions>>,
): AudioPlayer<Files>
Type Parameters
- const Files extends Readonly<
      Readonly<
          Record<
              string,
              Readonly<
                  Pick<
                      Readonly<
                          { sources: readonly AudioFileSource[] } & PartialWithUndefined<
                              {
                                  audioCache: AudioFileCache;
                                  audioContext: BaseAudioContext;
                                  createEffects: (
                                      audioContext: BaseAudioContext,
                                  ) => (...) | (...) | (...);
                                  fetch: (url: string) => Promise<(...)>;
                                  loadOnPlay: boolean;
                                  outputNode: AudioNode;
                                  volume: number;
                              },
                          >,
                      >,
                      "fetch"
                      | "volume"
                      | "createEffects"
                      | "sources",
                  >,
              >,
          >,
      >,
  >
Parameters
- initFiles: Readonly<Files>
- options: Readonly<PartialWithUndefined<AudioPlayerOptions>> = {}
Returns AudioPlayer<Files>
Overrides ListenTarget<AllAudioFileEvents>.constructor
- Defined in packages/audio/src/audio-player.ts:99

Properties

`Readonly`audioCache

audioCache: AudioFileCache = {}

`Readonly`audioContext

audioContext: AudioContext = ...

`Readonly`audioFiles

audioFiles: Partial<Record<keyof Files, AudioFile>> = {}

`Readonly`gainNode

gainNode: GainNode

Controls volume for all audio files. Modify gain.value on this to change playback volume.

`Protected` `Readonly`initFiles

initFiles: Readonly<Files>

`Readonly`isAudioAllowed

isAudioAllowed: boolean = ...

If true, indicates that an internal AudioFile instance has detected that the current browser session is allowing audio playback. Most browsers these days block audio on initial page load until the user has interacted with the page.

`Readonly`isDestroyed

isDestroyed: boolean = ...

`Protected` `Readonly`options

options: Readonly<PartialWithUndefined<AudioPlayerOptions>> = {}

`Protected` `Readonly`outputNode

outputNode: AudioNode

play

play: Record<keyof Files, () => Promise<boolean>>

Play a specific audio file.

Methods

destroy

destroy(): Promise<void>
Destroy and cleanup this AudioPlayer and all child AudioFile instances.

Returns Promise<void>
Overrides ListenTarget.destroy
- Defined in packages/audio/src/audio-player.ts:223

load

load<LoadFiles extends Partial<Record<keyof Files, undefined | boolean>>>(
    loadKeys: LoadFiles,
    progressCallback?: AudioLoadProgressCallback,
): Promise<
    Record<
        keyof {
            [Prop in string
            | number
            | symbol as LoadFiles[Prop] extends true ? Prop : never]: Prop
        },
        AudioFile,
    >,
>
Load a batch of audio files, with an optional progress callback. Any file set to false will be unloaded (if it has been loaded). Any file that is omitted or set to undefined will be left alone (if it's already loaded it'll stay loaded, if it's not loaded, it won't be loaded).
Type Parameters
- LoadFiles extends Partial<Record<keyof Files, undefined | boolean>>
Parameters
- loadKeys: LoadFiles
- OptionalprogressCallback: AudioLoadProgressCallback
Returns Promise<
    Record<
        keyof {
            [Prop in string
            | number
            | symbol as LoadFiles[Prop] extends true ? Prop : never]: Prop
        },
        AudioFile,
    >,
>
- Defined in packages/audio/src/audio-player.ts:164
load(loadKeys: keyof Files): Promise<AudioFile>
Load a single audio file.
Parameters
- loadKeys: keyof Files
Returns Promise<AudioFile>
- Defined in packages/audio/src/audio-player.ts:169
load(
    loadKeys:
        | keyof Files
        | Partial<Record<keyof Files, undefined | boolean>>,
    progressCallback?: AudioLoadProgressCallback,
): Promise<AudioFile | Record<string, AudioFile>>
Load audio files.
Parameters
- loadKeys: keyof Files | Partial<Record<keyof Files, undefined | boolean>>
- OptionalprogressCallback: AudioLoadProgressCallback
Returns Promise<AudioFile | Record<string, AudioFile>>
- Defined in packages/audio/src/audio-player.ts:171

loadAll

loadAll(
    progressCallback?: AudioLoadProgressCallback,
): Promise<
    Record<
        keyof {
            [Prop in string
            | number
            | symbol as InnerMappedValues<Readonly<Files>, true>[Prop] extends true
                ? Prop
                : never]: Prop
        },
        AudioFile,
    >,
>
Load all audio files at once.
Parameters
- OptionalprogressCallback: AudioLoadProgressCallback
Returns Promise<
    Record<
        keyof {
            [Prop in string
            | number
            | symbol as InnerMappedValues<Readonly<Files>, true>[Prop] extends true
                ? Prop
                : never]: Prop
        },
        AudioFile,
    >,
>
- Defined in packages/audio/src/audio-player.ts:215

`Protected`setupAudioFile

setupAudioFile(key: keyof Files): AudioFile
Create a new AudioFile instance at the given key and set it up.
Parameters
- key: keyof Files
Returns AudioFile
- Defined in packages/audio/src/audio-player.ts:123

Class AudioPlayer<Files>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AudioPlayer<Files>

Properties

ReadonlyaudioCache

ReadonlyaudioContext

ReadonlyaudioFiles

ReadonlygainNode

Protected ReadonlyinitFiles

ReadonlyisAudioAllowed

ReadonlyisDestroyed

Protected Readonlyoptions

Protected ReadonlyoutputNode

play

Methods

destroy

Returns Promise<void>

load

Type Parameters

Parameters

Returns Promise< Record< keyof { [Prop in string | number | symbol as LoadFiles[Prop] extends true ? Prop : never]: Prop }, AudioFile, >,>

Parameters

Returns Promise<AudioFile>

Parameters

Returns Promise<AudioFile | Record<string, AudioFile>>

loadAll

Parameters

Returns Promise< Record< keyof { [Prop in string | number | symbol as InnerMappedValues<Readonly<Files>, true>[Prop] extends true ? Prop : never]: Prop }, AudioFile, >,>

ProtectedsetupAudioFile

Parameters

Returns AudioFile

Settings

On This Page

`Readonly`audioCache

`Readonly`audioContext

`Readonly`audioFiles

`Readonly`gainNode

`Protected` `Readonly`initFiles

`Readonly`isAudioAllowed

`Readonly`isDestroyed

`Protected` `Readonly`options

`Protected` `Readonly`outputNode

Returns Promise<
Record<
keyof {
[Prop in string
| number
| symbol as LoadFiles[Prop] extends true ? Prop : never]: Prop
},
AudioFile,
>,
>

Returns Promise<
Record<
keyof {
[Prop in string
| number
| symbol as InnerMappedValues<Readonly<Files>, true>[Prop] extends true
? Prop
: never]: Prop
},
AudioFile,
>,
>

`Protected`setupAudioFile