DOCSEARCHbyAlgolia
Submit Docs

VST 3 SDK Documentation

repository·master·Indexed 25 days ago

https://github.com/steinbergmedia/vst3sdk

A professional development kit for creating VST 3 audio plug-ins. It provides the API, implementation helper classes, and wrappers for platforms including AAX, AUv3, and AU to enable high-performance audio processing. The SDK supports Windows, macOS, iOS, and Linux (Ubuntu 24.04 LTS), and is distributed under the MIT license.

Tokens
988
Snippets
0
Records
7
Agent score
31%

What's inside VST 3 SDK

  1. Understand VST 3 SDK Licensing and Trademark Usage

    master

    The VST 3 SDK is distributed under the MIT license. This allows developers to use, modify, and redistribute the code freely, including within commercial products, provided the MIT license terms are followed.

    Licensing Details

    • MIT License: Available for full open-source integration and commercial use.
    • Deprecated Licenses: Licensing under GPLv3 and the Steinberg proprietary license is no longer available.

    Trademark and Logo Usage

    Using the VST name or the VST Compatible Logo is optional. If you choose to use them, you must comply with the Steinberg VST Usage Guidelines included in the SDK.

    Permitted Use

    If you display the logo or trademark, it must be unaltered and used only in clear product-related contexts, such as:

    • Splash screens
    • About boxes
    • Product websites
    • Documentation and manuals

    Prohibited Use

    • Do not use “VST” (or derivatives like “VSTi”) in company or product names.
    • Do not apply the logo or trademark to non-VST-compatible products.
    • Do not associate the trademark with offensive, obscene, or inappropriate content.

  2. Key features of VST 3

    master

    VST 3 is a redesigned API that provides several advanced capabilities compared to older VST versions:

    • Improved Performance with the Silence Flag: Processing is optionally applied only when audio signals are present.
    • Multiple Dynamic I/Os: I/O configuration can dynamically adapt to channel configuration; side-chains are easily implemented.
    • Sample-accurate Automation: Supports sample-accurate parameter automation and ramped automation data.
    • Logical Parameter Organization: Parameters are organized in a tree structure with sections.
    • Resizeable UI Editor: Allows users to resize the plug-in editor.
    • Mouse Over & Context Menu Support: Allows the host to interact with specific parameters via mouse position or custom context menus.
    • Note Expression: Provides access to controller events that provide articulation information for individual notes in polyphonic arrangements.
    • 3D Support: Supports speaker configurations like Ambisonic, Atmos, Auro 3D, or 22.2.
    • Factory Concept: A single library can export multiple plug-ins, replacing the old shell concept.
    • Remote Control Representation: Supports specific parameter mapping for remote hardware like Nuage.

  6. Build VST 3 using cmake-gui

    master

    If you prefer a graphical interface, use cmake-gui to configure and generate your project:

    1. Start the cmake-gui application.
    2. Browse Source...: Select the vst3sdk folder.
    3. Browse Build...: Select a folder where outputs will be created (e.g., a folder named build).
    4. You can inspect and modify SMTG Options.
    5. Press Configure.
    6. Press Generate to create the project files.

  7. System requirements for VST 3 SDK

    master

    The VST 3 SDK supports multiple platforms, architectures, and compilers. Ensure your environment matches the following requirements:

    Operating SystemArchitectureCompilerNotes
    Windows 11x86, x86_64, arm64, arm64ECMSVC 2022
    Windows 8.1/10x86, x86_64MSVC 2019, MSVC 2022
    macOS 10.13 - 15x86, x86_64, Apple SiliconXcode 10 - 16
    iOS 13 - 18arm64Xcode 11 - 16
    Linux - Ubuntu 24.04 LTSx86_64GCC 13.3 and higherVisual Studio Code, Qt Creator