Generic C++ access to SOUND4 .CL librairies

Table of Contents

• General usage
• Communicating with the instance
• Metadata
• Advanced tasks
  • Custom storage
  • Using a bus
  • Convert helpers
  • Adding a health point in the web server

This is the easier way to integrate, and works for all .CL engines.

General usage

See Sample using Generic C++ interface (multi-process compatible).

The main steps are the following :

1. Load the want library with CProcessor::Load
2. Configure logging with CProcessor::SetLogSeverity and CProcessor::SetLoggerCallback
3. Allocate an CInstance
4. Configure parameters with CInstance::SetParam (see Environment variables and parameters)
5. Create the instance with CInstance::Create.
6. Create a web server with CInstance::StartWebServer
7. Send the audio to the instance using CInstance::ProcessAudio

Note

All std::string are UTF-8 encoded

Communicating with the instance

If you need to communicate with the instance, you can create a CInstance::NewClient and use it with JSON syntax.

Metadata

You can update the metadata by calling CInstance::SetMetadata or CInstance::SetMetadataMulti.

This may be used by plugins, like Stream.CL.

Advanced tasks

Custom storage

You can use your own storage implementation by deriving CPresetLoader.

You have then to select it in your instance with CInstance::SetPresetManager.

Whenever some change from storage happens, you should inform the instance with CInstance::PresetManager_InformChange

Using a bus

You can group instances for processes which supports it with CInstance::SetBus

Convert helpers

You can use helpers to convert audio from different formats using Audio convert helpers (C++).

Adding a health point in the web server

Your application can define exactly what will be returned by the web server on the /apphealth path. Use CInstance::SetWebServerAppHealth.