Browse Source

Build: Update docs for plugin- and manufacturer-code

tags/2021-05-28
reuk 4 years ago
parent
commit
f2e0552ba7
No known key found for this signature in database GPG Key ID: 9ADCD339CFC98A11
3 changed files with 11 additions and 6 deletions
  1. +5
    -3
      docs/CMake API.md
  2. +2
    -1
      examples/CMake/AudioPlugin/CMakeLists.txt
  3. +4
    -2
      extras/Projucer/Source/Project/jucer_Project.cpp

+ 5
- 3
docs/CMake API.md View File

@@ -412,11 +412,13 @@ attributes directly to these creation functions, rather than adding them later.

- `PLUGIN_MANUFACTURER_CODE`
- A four-character unique ID for your company. For AU compatibility, this must contain at least
one upper-case letter.
one upper-case letter. GarageBand 10.3 requires the first letter to be upper-case, and the
remaining letters to be lower-case.

- `PLUGIN_CODE`
- A four-character unique ID for your plugin. For AU compatibility, this must contain at least
one upper-case letter.
- A four-character unique ID for your plugin. For AU compatibility, this must contain exactly one
upper-case letter. GarageBand 10.3 requires the first letter to be upper-case, and the remaining
letters to be lower-case.

- `DESCRIPTION`
- A short description of your plugin.


+ 2
- 1
examples/CMake/AudioPlugin/CMakeLists.txt View File

@@ -49,7 +49,8 @@ juce_add_plugin(AudioPluginExample
# EDITOR_WANTS_KEYBOARD_FOCUS TRUE/FALSE # Does the editor need keyboard focus?
# COPY_PLUGIN_AFTER_BUILD TRUE/FALSE # Should the plugin be installed to a default location after building?
PLUGIN_MANUFACTURER_CODE Juce # A four-character manufacturer id with at least one upper-case character
PLUGIN_CODE Dem0 # A unique four-character plugin id with at least one upper-case character
PLUGIN_CODE Dem0 # A unique four-character plugin id with exactly one upper-case character
# GarageBand 10.3 requires the first letter to be upper-case, and the remaining letters to be lower-case
FORMATS AU VST3 Standalone # The formats to build. Other valid formats are: AAX Unity VST AU AUv3
PRODUCT_NAME "Audio Plugin Example") # The name of the final executable, which can differ from the target name



+ 4
- 2
extras/Projucer/Source/Project/jucer_Project.cpp View File

@@ -1394,9 +1394,11 @@ void Project::createAudioPluginPropertyEditors (PropertyListBuilder& props)
props.add (new TextPropertyComponent (pluginManufacturerValue, "Plugin Manufacturer", 256, false),
"The name of your company (cannot be blank).");
props.add (new TextPropertyComponent (pluginManufacturerCodeValue, "Plugin Manufacturer Code", 4, false),
"A four-character unique ID for your company. Note that for AU compatibility, this must contain at least one upper-case letter!");
"A four-character unique ID for your company. Note that for AU compatibility, this must contain at least one upper-case letter!"
" GarageBand 10.3 requires the first letter to be upper-case, and the remaining letters to be lower-case.");
props.add (new TextPropertyComponent (pluginCodeValue, "Plugin Code", 4, false),
"A four-character unique ID for your plugin. Note that for AU compatibility, this must contain at least one upper-case letter!");
"A four-character unique ID for your plugin. Note that for AU compatibility, this must contain exactly one upper-case letter!"
" GarageBand 10.3 requires the first letter to be upper-case, and the remaining letters to be lower-case.");
props.add (new TextPropertyComponent (pluginChannelConfigsValue, "Plugin Channel Configurations", 1024, false),
"This list is a comma-separated set list in the form {numIns, numOuts} and each pair indicates a valid plug-in "
"configuration. For example {1, 1}, {2, 2} means that the plugin can be used either with 1 input and 1 output, "


Loading…
Cancel
Save