Skip to content
switchboard-sdkPublic

About

Extension factory for the Switchboard SDK — generate your own C++ audio node (Bring Your Own Node).

Resources

Stars

2 stars

Watchers

12 watching

Forks

Latest commit

 

History

24 Commits

Folders and files

Repository files navigation

BYON – Switchboard SDK Extension Factory

Build

BYON ("Bring Your Own Node") is an extension factory for the Switchboard SDK: it generates a new, independently-named C++ extension project that you then own and develop. It isn't a template you edit in place — you run the generator and it stamps out your project.

What gets stamped out lives in template/ — example code named ExampleDSP that demonstrates the extension architecture (source/processor/sink nodes, demos, CMake setup, etc.).

For the concepts behind custom nodes and extensions, see the Bring Your Own Node guide.

🚀 Generating Your Project

Don't edit template/ in place. Instead, generate a new, independently-named project directory from it:

inv rename

or run the script directly:

scripts/rename.sh MyExtensionName [/optional/destination/path]

This copies template/ into a new project directory (a sibling directory named after your project by default), renames all ExampleDSP/EXAMPLEDSP/exampledsp references and file names within the copy, and initializes it with its own fresh git history. The original template/ directory here is left untouched, so you can run this as many times as you like.

See template/README.md for what's inside the generated project and how to build it. Once you have a project, that README also covers adding your own nodes, configuring the extension at load time, and shipping models and other assets.

About

Extension factory for the Switchboard SDK — generate your own C++ audio node (Bring Your Own Node).

Resources

Stars

2 stars

Watchers

12 watching

Forks

Releases

Packages

Contributors

Languages