@soundworks/plugin-delay v1.0.0

@soundworks/plugin-delay

soundworks plugin that just defer its initialization. Created for testing the plugin manager life cycle (let us know if you find any other use case from that, ...).

Table of Contents

• Installation
• Example
• Usage
  • Server installation
    • Registering the plugin
    • Requiring the plugin
  • Client installation
    • Registering the plugin
    • Requiring the plugin
• Credits
• License

Installation

npm install @soundworks/plugin-delay --save

Example

A working example can be found in the https://github.com/collective-soundworks/soundworks-examples repository.

Usage

Server installation

Registering the plugin

// index.js
import { Server } from '@soundworks/core/server';
import pluginPluginFactory from '@soundworks/plugin-delay/server';

const server = new Server();
server.pluginManager.register('delay', pluginPluginFactory, {
  startedDelayTime: 1,
  readyDelayTime: 1,
}, []);

Requiring the plugin

// MyExperience.js
import { AbstractExperience } from '@soundworks/core/server';

class MyExperience extends AbstractExperience {
  constructor(server, clientType) {
    super(server, clientType);
    // require plugin in the experience
    this.delay = this.require('delay');
  }
}

Client installation

Registering the plugin

// index.js
import { Client } from '@soundworks/core/client';
import pluginPluginFactory from '@soundworks/plugin-delay/client';

const client = new Client();
client.pluginManager.register('delay', pluginPluginFactory, {
  startedDelayTime: 1,
  readyDelayTime: 1,
}, []);

Requiring the plugin

// MyExperience.js
import { Experience } from '@soundworks/core/client';

class MyExperience extends Experience {
  constructor(client) {
    super(client);
    // require plugin in the experience
    this.delay = this.require('delay');
  }
}

Credits

The code has been initiated in the framework of the WAVE and CoSiMa research projects, funded by the French National Research Agency (ANR).

License

BSD-3-Clause