Sonar Vst Plugin Properties
- Vst Plugin Free Download
- Sonar Vst Plugin Properties Reviews
- Vst Plugin Download
- Sonar Vst Plugin Properties Reviews
Global VST Settings on SONAR X1
The Adapter scans the target VST plug-ins folder for devices, then presents them all in a list. Scroll down to the plug-in you want to register as a DXi, click on it, then click on Properties. Tick the box that says 'Configure as DXi Synth', then click on 'OK'. Click on 'Next', and wait while VST Adapter registers all the available plug-ins. Better than disabling the plugin, you may fix the plugin version to 2.6, which works fine, taking into account sonar.host.url. For instance, with Maven in my case.
SONAR X1 Producer has everything needed to deliver the polished, “radio-ready” recordings that are expected in today’s music industry – all in one box. Included are all of SONAR’s cutting edge music creation tools plus an unparalleled collection of world-class instruments and effects. From the innovative Skylight interface to the legendary, “big-studio” sound of the ProChannel console strip, SONAR X1 Producer is the ideal choice for anyone serious about music production.
VST Settings
To configure global VST settings Go to Edit > Preferences > File - VST Settings.
To add a folder to scan
1. Go to Edit > Preferences > File - VST Settings.
2. Under VST Scan Folder(s), click the Add button to open the Browser for Folder dialog.
3. Choose the folder you want to add, and click OK.
4. Repeat steps 1 and 2 to add any additional folders you might want to scan.
The new folders appear in the VST Scan Folder(s) list, along with any folders that were already in the list.
To remove a folder from the VST Scan Folder(s) list
1. Go to Edit > Preferences > File - VST Settings.
2. Under VST Scan Folder(s), select the folder you want to remove, then click the Remove button.
To set options for all plug-ins in a folder
1. Go to Edit > Preferences > File - VST Settings.
2. Under VST Scan Folder(s), select the folder you want to set options for, then click the Folder Defaults button.
3. In the dialog that appears, choose from the following options (options that control properties for individual plug-ins are greyed-out: use the Cakewalk Plug-in Manager to set those options):
> Enable as plug-in. Enable this option if you want to use the plug-ins in this folder as audio effects.
> Configure as tempo-based effect. If the effects in this folder are supposed to respond to tempo information (for example, a tempo-synced delay), and they are not responding, make sure this box is checked.
> Force stereo operation. If you need to use mono plug-ins in situations that requires stereo, you can enable this option to run the plug-ins in stereo mode. This option simply creates two identical output streams from the plug-ins where only one existed.
> Do not intercept NRPNs. SONAR uses NRPNs to run automation of your VST plug-ins. However, some instruments have their own implementation of this process, so checking this box passes the NRPNs directly to the instrument, allowing it to manage its own automation.
> Max used inputs. This option controls the number of sidechain inputs that are exposed by SONAR for the plug-in. The default value is the maximum number of input channels that are exposed by the plug-in. If the value is set to 2, SONAR will not display any sidechainable inputs; if set to 4, SONAR will display 1 sidechainable input, etc.
> Load using jBridge wrapper. This check box is only enabled on systems where jBridge is installed. jBridge allows you to use 32-bit VST effects and instruments when using the x64 version of SONAR, as well as use 64-bit plug-ins when using the x86 version of SONAR. jBridge can also bridge 32-bit plug-ins in the x86 version of SONAR, allowing your computer to overcome the memory limitations of a single 32bit process.
> Enable delay compensation. Usually, you will leave this check box the way you found it. SONAR contains a delay compensator, which turns on and off automatically for each individual plug-in (only a few plug-ins need it). If your plug-in needs extra time to process the audio data, the plug-in sends a message to SONAR, so it can synchronize playback time to the delayed output from the plug-in.
> Serialize Host Access. When Serialize Host Access is selected, communications with the plug-in are serialized as far as possible. The default behavior is OFF, which allows asynchronous calls to the plug-in.
Free vst brickwall limiter. When Serialize Host Access is disabled, SONAR’s audio engine runs more efficiently and allows the UI thread to interact independently with the plug-in GUI without impacting the audio engine. The only reason to enable Serialize Host Access would be for a plug-in that has thread safety problems leading to crashes or glitches when changing plug-in presets. > Enable mono processing. When enabled, this option replicates the audio signal from the first channel to the left and right channel, effectively forcing the output of VST to be mono.
> Translate Bank/Program Changes. When enabled, this option translates MIDI program change messages into VST preset changes. This is only used for plug-ins that do not support MIDI program change messages.
> Always suspend on stop. When enabled the VST plug-in state will be set to suspended when the transport is stopped in SONAR. The default behavior is to keep VST’s always in a resumed state. Enabling this option will prevent effects tails from being heard when the transport is stopped.
> Always suspend on play. When Always suspend on Play is selected, the plug-in will reset when playback starts. Select this option for any VST instruments that have problems with stuck notes when stopping the transport. The Always suspend on Play property is also useful for effects that generate a tail, such as delays and reverbs. The effect is that you will hear the tails when the transport stops, but not when the transport rolls again. Always Suspend on Play is disabled by default.
4. Click OK to close the dialog.
To turn Automatic Scanning on or off
1. Go to Edit > Preferences > File - VST Settings.
2. Under VST Scan Options, select the Scan For VST Plug-ins On Startup check box. The next time you launch SONAR, your VST folders will either be scanned or not, depending on the option you chose.
To re-scan failed plug-ins
1. Go to Edit > Preferences > File - VST Settings.
2. Under VST Scan Options, select the Re-scan Failed Plug-ins check box. The next time you scan, any plug-ins that did not scan correctly during previous scans will be re-scanned.
To re-scan existing plug-ins
1. Go to Edit > Preferences > File - VST Settings.
2. Under VST Scan Options, select the Re-scan Existing Plug-ins check box. The next time you scan, any plug-ins that have already been scanned will be re-scanned, and any new folder default options you have chosen will be implemented.
To run a scan
1. Go to Edit > Preferences > File - VST Settings.
2. Under VST Scan, click the Scan VST Folders button.
To set all VST plug-ins to folder defaults
1. Go to Edit > Preferences > File - VST Settings.
2. Under VST Scan, click the Reset All VST Plug-ins button. The next time you scan, SONAR will set all plug-ins in your VST Scan folders to your folder default settings.
To set options for individual VST plug-ins
1. On the Utilities menu, click Cakewalk Plug-in Manager to open the Cakewalk Plug-in Manager.
2. In the Plug-in Categories list, select VST Audio Effects or VST Instruments.
3. In the Registered Plug-ins list, select the desired plug-in.
4. Under VST Configuration, click Plug-in Propertires to open the VST Plug-In Properties dialog.
5. Select the desired options, then click OK to close the VST Plug-In Properties dialog.
Note: For any of the VST properties to take effect, the plug-in must be re-instantiated. The simplest way to do that is to delete the plug-in from the effects bin or Synth Rack, then press CTRL+Z to undo.
Building your plugin
Prerequisites
To build a plugin, you need Java 8 and Maven 3.1 (or greater). Gradle can also be used thanks to https://github.com/iwarapter/gradle-sonar-packaging-plugin. Note that this Gradle plugin is not officially supported by SonarSource.
Create a Maven Project
The recommended way to start is by duplicating the plugin example project: https://github.com/SonarSource/sonar-custom-plugin-example.
If you want to start the project from scratch, use the following Maven pom.xml template:
Build
To build your plugin project, execute this command from the project root directory:mvn clean package
The plugin jar file is generated in the project's target/
directory.
Deploy
'Cold' Deploy
The standard way to install the plugin for regular users is to copy the JAR artifact, from the target/
directory to the extensions/plugins/
directory of your SonarQube installation then start the server. The file logs/web.log
will then contain a log line similar to:Deploy plugin Example Plugin / 0.1-SNAPSHOT
Scanner extensions such as sensors are immediately retrieved and loaded when scanning source code.
Debug
Debugging web server extensions
- Edit conf/sonar.properties and set:
sonar.web.javaAdditionalOpts=-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=8000
- Install your plugin by copying its JAR file to extensions/plugins
- Start the server. The line
Listening for transport dt_socket at address: 5005
is logged inlogs/sonar.log
. - Attach your IDE to the debug process (listening on port 8000 in the example)
Debugging compute engine extensions
Same procedure as for web server extensions (see previous paragraph), but with the property: sonar.ce.javaAdditionalOpts=-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=8000
Debugging scanner extensions
When using the Scanner for Maven, then simply execute:
Advanced Build Properties
Plugin properties are defined in the file META-INF/MANIFEST.MF
of the plugin .jar file.
Most of them are defined through the <configuration>
section of the sonar-packaging-maven-plugin. Some are taken from standard pom nodes Effective values are listed at the end of the build log:
Supported standard pom node properties:
Maven Property | Manifest Key | Notes |
---|---|---|
version | Plugin-Version | (required) Plugin version as displayed in page 'Marketplace'. Default: ${project.version} |
- | Sonar-Version | (required) Minimal version of supported SonarQube at runtime. For example if value is 5.2, then deploying the plugin on versions 5.1 and lower will fail. Default value is given by the version of sonar-plugin-api dependency. It can be overridden with the Maven property sonarQubeMinVersion (since sonar-packaging-maven-plugin 1.16). That allows in some cases to use new features of recent API and to still be compatible at runtime with older versions of SonarQube. Default: version of dependency sonar-plugin-api |
license | Plugin-License | Plugin license as displayed in page 'Marketplace'. Default ${project.licenses} |
developers | Plugin-Developers | List of developers displayed in page 'Marketplace'. Default: ${project.developers} |
Supported <configuration>
properties:
Maven Property | Manifest Key | Notes |
---|---|---|
pluginKey | Plugin-Key | (required) Contains only letters/digits and is unique among all plugins. Examples: groovy, widgetlab. Constructed from ${project.artifactId}. Given an artifactId of: sonar-widget-lab-plugin , your pluginKey will be: widgetlab |
pluginClass | Plugin-Class | (required) Name of the entry-point class that extends org.sonar.api.SonarPlugin . Example: org.codehaus.sonar.plugins.widgetlab.WidgetLabPlugin |
pluginName | Plugin-Name | (required) Displayed in the page 'Marketplace'. Default: ${project.name} |
pluginDescription | Plugin-Description | Displayed in the page 'Marketplace'. Default: ${project.description} |
pluginUrl | Plugin-Homepage | Homepage of website, for example https://github.com/SonarQubeCommunity/sonar-widget-lab${project.url} |
pluginIssueTrackerUrl | Plugin-IssueTrackerUrl | Example: https://github.com/SonarQubeCommunity/sonar-widget-lab/issues. Default: ${project.issueManagement.url} |
pluginTermsConditionsUrl | Plugin-TermsConditionsUrl | Users must read this document when installing the plugin from Marketplace. Default: ${sonar.pluginTermsConditionsUrl} |
useChildFirstClassLoader | Plugin-ChildFirstClassLoader | Each plugin is executed in an isolated classloader, which inherits a shared classloader that contains API and some other classes. By default the loading strategy of classes is parent-first (look up in shared classloader then in plugin classloader). If the property is true, then the strategy is child-first. This property is mainly used when building plugin against API < 5.2, as the shared classloader contained many 3rd party libraries (guava 10, commons-lang, ..) false |
basePlugin | Plugin-Base | If specified, then the plugin is executed in the same classloader as basePlugin. |
pluginSourcesUrl | Plugin-SourcesUrl | URL of SCM repository for open-source plugins. Displayed in page 'Marketplace'. Default: ${project.scm.url} |
pluginOrganizationName | Plugin-Organization | Organization which develops the plugin, displayed in the page 'Marketplace'. Default: ${project.organization.name} |
pluginOrganizationUrl | Plugin-OrganizationUrl | URL of the organization, displayed in the page 'Marketplace'. Default: ${project.organization.url} |
sonarLintSupported | SonarLint-Supported | Whether the language plugin supports SonarLint or not. Only SonarSource analyzers and custom rules plugins for SonarSource analyzers should set this to true. |
pluginDisplayVersion | Plugin-Display-Version | The version as displayed in SonarQube administration console. By default it's the raw version, for example '1.2', but can be overridden to '1.2 (build 12345)' for instance. Supported in sonar-packaging-maven-plugin 1.18.0.372. Default: ${project.version} |
The Maven sonar-packaging-maven-plugin supports also these properties:
Maven Property | Manifest Key | Notes |
---|---|---|
addMavenDescriptor | Copy pom file inside the directory META-INF of generated JAR file? | Boolean. Default: ${sonar.addMavenDescriptor} / true . |
skipDependenciesPackaging | Do not copy Maven dependencies into JAR file. | Default: ${sonar.skipDependenciesPackaging} / false`. |
Other Manifest fields:
Implementation-Build
- Identifier of build or commit, for example the Git sha1 '94638028f0099de59f769cdca776e506684235d6'. It is displayed for debugging purpose in logs when SonarQube server starts.
API basics
Extension points
SonarQube provides extension points for its three technical stacks:
- Scanner, which runs the source code analysis
Compute Engine, which consolidates the output of scanners, for example by
- computing 2nd-level measures such as ratings
- aggregating measures (for example number of lines of code of project = sum of lines of code of all files)
- assigning new issues to developers
- persisting everything in data stores
- Web application
Extension points are not designed to add new features but to complete existing features. Technically they are contracts defined by a Java interface or an abstract class annotated with @ExtensionPoint. The exhaustive list of extension points is available in the javadoc.
The implementations of extension points (named 'extensions') provided by a plugin must be declared in its entry point class, which implements org.sonar.api.Plugin and which is referenced in pom.xml:
ExamplePlugin.java
pom.xml
Lifecycle
A plugin extension exists only in its associated technical stacks. A scanner sensor is for example instantiated and executed only in a scanner runtime, but not in the web server nor in Compute Engine. The stack is defined by the annotations @ScannerSide, @ServerSide (for web server) and @ComputeEngineSide.
An extension can call core components or another extension of the same stack. These dependencies are defined by constructor injection:
It is recommended not to call other components in constructors. Indeed, they may not be initialized at that time. Constructors should only be used for dependency injection.
Compilation does not fail if incorrect dependencies are defined, such as a scanner extension trying to call a web server extension. Still it will fail at runtime when plugin is loaded.
Third-party Libraries
Vst Plugin Free Download
Plugins are executed in their own isolated classloaders. That allows the packaging and use of 3rd-party libraries without runtime conflicts with core internal libraries or other plugins. Note that since version 5.2, the SonarQube API does not bring transitive dependencies, except SLF4J. The libraries just have to be declared in the pom.xml with default scope 'compile':
pom.xml
Technically the libraries are packaged in the directory META-INF/lib of the generated JAR file. An alternative is to shade libraries, for example with maven-shade-plugin. That minimizes the size of the plugin .jar file by copying only the effective used classes.
The command mvn dependency:tree
gives the list of all dependencies, including transitive ones.
Configuration

The core component org.sonar.api.config.Configuration
provides access to configuration. It deals with default values and decryption of values. It is available in all stacks (scanner, web server, Compute Engine). As recommended earlier, it must not be called from constructors.
MyExtension.java
Scanner sensors can get config directly from SensorContext, without using constructor injection:
MySensor.java
In the scanner stack, properties are checked in the following order, and the first non-blank value is the one that is used:
- System property
- Scanner command-line (-Dsonar.property=foo for instance)
- Scanner tool (
of scanner for Maven for instance) - Project configuration defined in the web UI
- Global configuration defined in the web UI
- Default value
Plugins can define their own properties so that they can be configured from web administration console. The extension point org.sonar.api.config.PropertyDefinition must be used :
Values of the properties suffixed with .secured
are not available to non-authorized users (anonymous and users without project or global administration rights). .secured
is needed for passwords, for instance.
The annotation @org.sonar.api.Property
can also be used on an extension to declare a property, but org.sonar.api.config.PropertyDefinition is preferred.
Logging
The class org.sonar.api.utils.log.Logger
is used to log messages to scanner output, web server logs/sonar.log, or Compute Engine logs (available from administration web console). It's convenient for unit testing (see class LogTester
).
Internally SLF4J is used as a facade of various logging frameworks (log4j, commons-log, logback, java.util.logging). That allows all these frameworks to work at runtime, such as when they are required for a 3rd party library. SLF4J loggers can also be used instead of org.sonar.api.utils.log.Logger. Read the SLF4J manual for more details.
As an exception, plugins must not package logging libraries. Dependencies like SLF4J or log4j must be declared with scope 'provided'.
Exposing APIs to Other Plugins
The common use case is to write a language plugin that will allow some other plugins to contribute additional rules (see for example how it is done for Java analysis). The main plugin will expose some APIs that will be implemented/used by the 'rule' plugins.
Plugins are loaded in isolated classloaders. It means a plugin can't access another plugin's classes. There is an exception for package names following pattern org.sonar.plugins.<pluginKey>.api
. For example all classes in a plugin with the key myplugin that are located in org.sonar.plugins.myplugin.api
are visible to other plugins.
Serving Static Resources
If you need to serve static resources from your plugin such as images or JavaScript files, place them in a directory under resources
named static
(myplugin/src/main/resources/static
). At runtime they'll be available from http://{server}/static/{pluginKey}/{file}
.
Versioning and API Deprecation

Versioning Strategy
The goal of this versioning strategy is both to:
- Release often, release early in order to get quick feedback from the SonarQube community
- Release stable versions of the SonarQube platform for companies whose main priority is to set up a very stable environment. Even if the price for such stable environments is missing out on the latest, sexy SonarQube features
- Support the API deprecation strategy (see next section)
The rules are:
- Each ~two months a new version of SonarQube is released. This version should increment the minor digit of the previous version (ex: 4.2 -> 4.3)
- After three (or more) releases, a bug-fix version is released, and becomes the new LTS. The major digit of the subsequent version is incremented to start a new cycle (ex: 5.6 -> 6.0)
And here is the strategy in action:
API Deprecation Strategy
The goal of this deprecation strategy is to make sure that deprecated APIs will be dropped without side-effects at a given planned date. The expected consequence of such strategy is to ease the evolution of the SonarQube API by making such refactoring painless.
The rules are:
- An API must be deprecated before being dropped
- A deprecated API must be fully supported until its drop (For instance the implementation of a deprecated method can't be replaced by
throw new UnsupportedOperationException())
- If an API is deprecated in version X.Y, this API will be dropped in version (X+2).0. Example: an API deprecated in 4.1 is supported in 4.2, 4.3, 5.0, 5.1, 5.2, 5.3 and is dropped in version 6.0.
- According to the versioning strategy, that means that an API can remain deprecated before being dropped during 6 to 12 months.
- Any release of a SonarQube plugin must at least depend on the latest LTS version of the SonarQube API
- For each SonarQube plugin there must at least one release on each LTS version of SonarQube, which means at least one release each 6 months.
- No use of deprecated APIs is accepted when releasing a plugin. It raises a critical issue in SonarQube analysis. This issue can't be postponed.
- No deprecated API introduced 2 major versions ago is accepted when releasing SonarQube. It raises a critical issue in SonarQube analysis. This issue can't be postponed.
An API is marked as deprecated with both:
- the annotation @Deprecated
- the javadoc tag @deprecated whose message must start with 'in x.y', for example:
API Changes
Release 8.4
Added
org.sonar.api.batch.scm.ScmProvider#forkDate
Deprecated
org.sonar.api.rules.Rule#getId()
is deprecated and will always throw UnsupportedOperationException.
Release 8.3
Deprecated
org.sonar.api.utils.text.JsonWriter
Release 8.2
No changes
Sonar Vst Plugin Properties Reviews
Release 8.1
No changes
Release 8.0
No changes
Release 7.9
No changes
Release 7.8
Added
org.sonar.api.web.WebAnalytics
Deprecated
org.sonar.api.i18n.I18
org.sonar.api.SonarQubeVersion
useorg.sonar.api.SonarRuntime
insteadorg.sonar.api.profiles.XMLProfileParser
org.sonar.api.notifications.NotificationChannel
Removed
- Pico components relying on reflection to have their
start
orstop
method called. Make your component implementsorg.sonar.api.Startable
instead.
Release 7.7
Added
org.sonar.api.batch.scm.ScmProvider#ignoreCommand
Deprecated
org.sonar.api.batch.fs.InputFile::status
org.sonar.api.resources.Qualifiers#BRC
Removed
- The preview/issues mode of scanner has been removed
Release 7.6
Changed
PostJob
moved to project level IoC containerInputFileFilter
moved to project level IoC container
Added
- New annotation
org.sonar.api.scanner.ScannerSide
to mark (project level) scanner components org.sonar.api.batch.fs.InputProject
to create issues on projectorg.sonar.api.scanner.ProjectSensor
to declare Sensors that only run at project level
Deprecated
org.sonar.scanner.issue.IssueFilter
deprecatedorg.sonar.api.batch.InstantiationStrategy
deprecatedorg.sonar.api.batch.ScannerSide
deprecatedorg.sonar.api.batch.fs.InputModule
deprecated- Concept of global Sensor is deprecated (use
ProjectSensor
instead)
Removed
Vst Plugin Download
- Support of scanner tasks was removed
RulesProfile
is no longer available for scanner side components (useActiveRules
instead)
Release 7.5
No changes
Release 7.4
Changed
- Allow identity provider to not provide login
Added
- Allow sensors to report adhoc rules metadata
Removed
org.sonar.api.rules.RuleFinder
removed from scanner sidesonar-channel
removed from plugin classloader- stop support of plugins compiled with API < 5.2
Release 7.3
Added
RulesDefinitions
supports HotSpots and security standards
Deprecated
org.sonar.api.batch.AnalysisMode
andorg.sonar.api.issue.ProjectIssues
since preview mode is already deprecated for a while
Release 7.2
Added
org.sonar.api.batch.sensor.SensorContext#newExternalIssue
to report external issuesorg.sonar.api.batch.sensor.SensorContext#newSignificantCode
to report part of the source file that should be used for issue trackingorg.sonar.api.scan.issue.filter.FilterableIssue#textRange
Deprecated
- org.sonar.api.scan.issue.filter.FilterableIssue#line
Release 7.1
Added
org.sonar.api.Plugin.Context#getBootConfiguration
org.sonar.api.server.rule.RulesDefinition.NewRule#addDeprecatedRuleKey
to support deprecated rule keys
Release 7.0
Added
org.sonar.api.batch.scm.ScmProvider#relativePathFromScmRoot
,org.sonar.api.batch.scm.ScmProvider#branchChangedFiles
andorg.sonar.api.batch.scm.ScmProvider#revisionId
to improve branch and PR support
Release 6.7
Sonar Vst Plugin Properties Reviews
No changes