SoundbankManagerClient

Client-side representation of the SoundbankManager

import { Client } from '@soundworks/core/client.js';
import { ComoClient } from '@ircam/como/client.js';

const client = new Client(config);
const como = new ComoClient(client);
await como.start();

const buffer = await como.soundbankManager.getBuffer('test.mp3');

On browser clients, the component automatically expose the como-soundbank-manager Web Component:

<como-soundbank-manager
  .como=${como}
></como-soundbank-manager>
<!-- or with optional session -->
<como-soundbank-manager
  .como=${como}
  session-id=${sessionId}
></como-soundbank-manager>

Extends

Constructor

new SoundbankManagerClient()

Source:

Methods

(async) getBuffer(filename) → {AudioBuffer}

Description:

  • Get an AudioBuffer from its filename

Source:
Overrides:
Parameters:
Name Type Description
filename String

Filename of the related audio buffer
Returns:
Type
AudioBuffer

(async) getBuffers(fileList) → {Object.<String, AudioBuffer>}

Description:

  • Get a set of AudioBuffers from their filenames

Source:
Overrides:
Parameters:
Name Type Description
fileList Array.<String>

List of filenames to retrieve
Returns:
Type
Object.<String, AudioBuffer>

getTreeAsUrlMap() → {Object.<String, String>}

Description:

  • Get the list of audio files (mp3 or wav) as filename / url object

Source:
Overrides:
See:
Returns:
Type
Object.<String, String>

onUpdate(callback, executeListener)

Description:

  • Register a callback to be triggered when the underlying filesystem changes

Source:
Overrides:
See:
Parameters:
Name Type Description
callback function

Callback function to execute
executeListener Boolean

If true, execute the given callback immediately. (optional, default false)