A useful utility class to determine the host or DAW in which your plugin is loaded. More...

#include "juce_PluginHostType.h"

Public Types
enum	HostType { UnknownHost , AbletonLive6 , AbletonLive7 , AbletonLive8 , AbletonLive9 , AbletonLive10 , AbletonLive11 , AbletonLiveGeneric , AdobeAudition , AdobePremierePro , AppleGarageBand , AppleInfoHelper , AppleLogic , AppleMainStage , Ardour , AULab , AUVal , AvidProTools , BitwigStudio , CakewalkSonar8 , CakewalkSonarGeneric , CakewalkByBandlab , DaVinciResolve , DigitalPerformer , FinalCut , FruityLoops , JUCEPluginHost , MagixSamplitude , MagixSequoia , MergingPyramix , MuseReceptorGeneric , Maschine , pluginval , Reaper , Reason , Renoise , SADiE , SteinbergCubase4 , SteinbergCubase5 , SteinbergCubase5Bridged , SteinbergCubase6 , SteinbergCubase7 , SteinbergCubase8 , SteinbergCubase8_5 , SteinbergCubase9 , SteinbergCubase9_5 , SteinbergCubase10 , SteinbergCubase10_5 , SteinbergCubaseGeneric , SteinbergNuendo3 , SteinbergNuendo4 , SteinbergNuendo5 , SteinbergNuendoGeneric , SteinbergWavelab5 , SteinbergWavelab6 , SteinbergWavelab7 , SteinbergWavelab8 , SteinbergWavelabGeneric , SteinbergTestHost , StudioOne , Tracktion3 , TracktionGeneric , TracktionWaveform , VBVSTScanner , ViennaEnsemblePro , WaveBurner }
	Represents the host type and also its version for some hosts. More...

Public Member Functions
	PluginHostType (const PluginHostType &other)=default

PluginHostType &	operator= (const PluginHostType &other)=default

bool	isAbletonLive () const noexcept
	Returns true if the host is any version of Ableton Live.

bool	isAdobeAudition () const noexcept
	Returns true if the host is Adobe Audition.

bool	isAppleInfoHelper () const noexcept
	Returns true if the host is com.apple.audio.InfoHelper.

bool	isArdour () const noexcept
	Returns true if the host is Ardour.

bool	isAULab () const noexcept
	Returns true if the host is AU Lab.

bool	isAUVal () const noexcept
	Returns true if the host is auval.

bool	isBitwigStudio () const noexcept
	Returns true if the host is Bitwig Studio.

bool	isCubase () const noexcept
	Returns true if the host is any version of Steinberg Cubase.

bool	isCubase7orLater () const noexcept
	Returns true if the host is Steinberg Cubase 7 or later.

bool	isCubaseBridged () const noexcept
	Returns true if the host is Steinberg Cubase 5 Bridged.

bool	isDaVinciResolve () const noexcept
	Returns true if the host is DaVinci Resolve.

bool	isDigitalPerformer () const noexcept
	Returns true if the host is Digital Performer.

bool	isFinalCut () const noexcept
	Returns true if the host is Apple Final Cut Pro.

bool	isFruityLoops () const noexcept
	Returns true if the host is Fruity Loops.

bool	isGarageBand () const noexcept
	Returns true if the host is Apple GarageBand.

bool	isJUCEPluginHost () const noexcept
	Returns true if the host is the JUCE AudioPluginHost.

bool	isLogic () const noexcept
	Returns true if the host is Apple Logic Pro.

bool	isMainStage () const noexcept
	Returns true if the host is Apple MainStage.

bool	isNuendo () const noexcept
	Returns true if the host is any version of Steinberg Nuendo.

bool	isPluginval () const noexcept
	Returns true if the host is pluginval.

bool	isPremiere () const noexcept
	Returns true if the host is Adobe Premiere Pro.

bool	isProTools () const noexcept
	Returns true if the host is Avid Pro Tools.

bool	isPyramix () const noexcept
	Returns true if the host is Merging Pyramix.

bool	isReceptor () const noexcept
	Returns true if the host is Muse Receptor.

bool	isReaper () const noexcept
	Returns true if the host is Cockos Reaper.

bool	isReason () const noexcept
	Returns true if the host is Reason.

bool	isRenoise () const noexcept
	Returns true if the host is Renoise.

bool	isSADiE () const noexcept
	Returns true if the host is SADiE.

bool	isSamplitude () const noexcept
	Returns true if the host is Magix Samplitude.

bool	isSequoia () const noexcept
	Returns true if the host is Magix Sequoia.

bool	isSonar () const noexcept
	Returns true if the host is any version of Cakewalk Sonar.

bool	isSteinbergTestHost () const noexcept
	Returns true if the host is Steinberg's VST3 Test Host.

bool	isSteinberg () const noexcept
	Returns true if the host is any product from Steinberg.

bool	isStudioOne () const noexcept
	Returns true if the host is PreSonus Studio One.

bool	isTracktion () const noexcept
	Returns true if the host is any version of Tracktion.

bool	isTracktionWaveform () const noexcept
	Returns true if the host is Tracktion Waveform.

bool	isVBVSTScanner () const noexcept
	Returns true if the host is VB Audio VST Scanner.

bool	isViennaEnsemblePro () const noexcept
	Returns true if the host is Vienna Ensemble Pro.

bool	isWaveBurner () const noexcept
	Returns true if the host is Apple WaveBurner.

bool	isWavelab () const noexcept
	Returns true if the host is any version of Steinberg WaveLab.

bool	isWavelabLegacy () const noexcept
	Returns true if the host is Steinberg WaveLab 6 or below.

bool	isMaschine () const noexcept
	Returns true if the host is Native Instruments Maschine.

const char *	getHostDescription () const noexcept
	Returns a human-readable description of the host.

bool	isInterAppAudioConnected () const
	Returns true if the plugin is connected with Inter-App Audio on iOS.

void	switchToHostApplication () const
	Switches to the host application when Inter-App Audio is used on iOS.

Image	getHostIcon (int size) const
	Gets the host app's icon when Inter-App Audio is used on iOS.

Static Public Member Functions
static String	getHostPath ()
	Returns the complete absolute path of the host application executable.

static AudioProcessor::WrapperType	getPluginLoadedAs () noexcept
	Returns the plug-in format via which the plug-in file was loaded.

static bool	isInAAXAudioSuite (AudioProcessor &)
	Returns true if the AudioProcessor instance is an AAX plug-in running in AudioSuite.

Public Attributes
HostType	type

Detailed Description

A useful utility class to determine the host or DAW in which your plugin is loaded.

Declare a PluginHostType object in your class to use it.

@tags{Audio}

Definition at line 38 of file juce_PluginHostType.h.

Member Enumeration Documentation

◆ HostType

enum juce::PluginHostType::HostType

Represents the host type and also its version for some hosts.

Enumerator
UnknownHost	Represents an unknown host.
AbletonLive6	Represents Ableton Live 6.
AbletonLive7	Represents Ableton Live 7.
AbletonLive8	Represents Ableton Live 8.
AbletonLive9	Represents Ableton Live 9.
AbletonLive10	Represents Ableton Live 10.
AbletonLive11	Represents Ableton Live 11.
AbletonLiveGeneric	Represents Ableton Live.
AdobeAudition	Represents Adobe Audition.
AdobePremierePro	Represents Adobe Premiere Pro.
AppleGarageBand	Represents Apple GarageBand.
AppleInfoHelper	Represents Apple com.apple.audio.InfoHelper.
AppleLogic	Represents Apple Logic Pro.
AppleMainStage	Represents Apple Main Stage.
Ardour	Represents Ardour.
AULab	Represents AU Lab.
AUVal	Represents Apple AU validator.
AvidProTools	Represents Avid Pro Tools.
BitwigStudio	Represents Bitwig Studio.
CakewalkSonar8	Represents Cakewalk Sonar 8.
CakewalkSonarGeneric	Represents Cakewalk Sonar.
CakewalkByBandlab	Represents Cakewalk by Bandlab.
DaVinciResolve	Represents DaVinci Resolve.
DigitalPerformer	Represents Digital Performer.
FinalCut	Represents Apple Final Cut Pro.
FruityLoops	Represents Fruity Loops.
JUCEPluginHost	Represents the JUCE AudioPluginHost.
MagixSamplitude	Represents Magix Samplitude.
MagixSequoia	Represents Magix Sequoia.
MergingPyramix	Represents Merging Pyramix.
MuseReceptorGeneric	Represents Muse Receptor.
Maschine	Represents Native Instruments Maschine.
pluginval	Represents pluginval.
Reaper	Represents Cockos Reaper.
Reason	Represents Reason.
Renoise	Represents Renoise.
SADiE	Represents SADiE.
SteinbergCubase4	Represents Steinberg Cubase 4.
SteinbergCubase5	Represents Steinberg Cubase 5.
SteinbergCubase5Bridged	Represents Steinberg Cubase 5 Bridged.
SteinbergCubase6	Represents Steinberg Cubase 6.
SteinbergCubase7	Represents Steinberg Cubase 7.
SteinbergCubase8	Represents Steinberg Cubase 8.
SteinbergCubase8_5	Represents Steinberg Cubase 8.5.
SteinbergCubase9	Represents Steinberg Cubase 9.
SteinbergCubase9_5	Represents Steinberg Cubase 9.5.
SteinbergCubase10	Represents Steinberg Cubase 10.
SteinbergCubase10_5	Represents Steinberg Cubase 10.5.
SteinbergCubaseGeneric	Represents Steinberg Cubase.
SteinbergNuendo3	Represents Steinberg Nuendo 3.
SteinbergNuendo4	Represents Steinberg Nuendo 4.
SteinbergNuendo5	Represents Steinberg Nuendo 5.
SteinbergNuendoGeneric	Represents Steinberg Nuendo.
SteinbergWavelab5	Represents Steinberg Wavelab 5.
SteinbergWavelab6	Represents Steinberg Wavelab 6.
SteinbergWavelab7	Represents Steinberg Wavelab 7.
SteinbergWavelab8	Represents Steinberg Wavelab 8.
SteinbergWavelabGeneric	Represents Steinberg Wavelab.
SteinbergTestHost	Represents Steinberg's VST3 Test Host.
StudioOne	Represents PreSonus Studio One.
Tracktion3	Represents Tracktion 3.
TracktionGeneric	Represents Tracktion.
TracktionWaveform	Represents Tracktion Waveform.
VBVSTScanner	Represents VB Audio VST Scanner.
ViennaEnsemblePro	Represents Vienna Ensemble Pro.
WaveBurner	Represents Apple WaveBurner.

Definition at line 48 of file juce_PluginHostType.h.

Constructor & Destructor Documentation

◆ PluginHostType()

juce::PluginHostType::PluginHostType ( )

Definition at line 42 of file juce_PluginHostType.h.

Member Function Documentation

◆ getHostDescription()

const char * juce::PluginHostType::getHostDescription ( ) const

noexcept

Returns a human-readable description of the host.

Definition at line 87 of file juce_PluginHostType.cpp.

◆ getHostIcon()

Image juce::PluginHostType::getHostIcon ( int size ) const

Gets the host app's icon when Inter-App Audio is used on iOS.

Definition at line 72 of file juce_PluginHostType.cpp.

◆ getHostPath()

static String juce::PluginHostType::getHostPath ( )

static

Returns the complete absolute path of the host application executable.

Definition at line 224 of file juce_PluginHostType.h.

◆ getPluginLoadedAs()

static AudioProcessor::WrapperType juce::PluginHostType::getPluginLoadedAs ( )

staticnoexcept

Returns the plug-in format via which the plug-in file was loaded.

This value is identical to AudioProcessor::wrapperType of the main audio processor of this plug-in. This function is useful for code that does not have access to the plug-in's main audio processor.

See also: AudioProcessor::wrapperType

Definition at line 238 of file juce_PluginHostType.h.

◆ isAbletonLive()

bool juce::PluginHostType::isAbletonLive ( ) const

noexcept

Returns true if the host is any version of Ableton Live.

Definition at line 122 of file juce_PluginHostType.h.

◆ isAdobeAudition()

bool juce::PluginHostType::isAdobeAudition ( ) const

noexcept

Returns true if the host is Adobe Audition.

Definition at line 126 of file juce_PluginHostType.h.

◆ isAppleInfoHelper()

bool juce::PluginHostType::isAppleInfoHelper ( ) const

noexcept

Returns true if the host is com.apple.audio.InfoHelper.

Definition at line 128 of file juce_PluginHostType.h.

◆ isArdour()

bool juce::PluginHostType::isArdour ( ) const

noexcept

Returns true if the host is Ardour.

Definition at line 130 of file juce_PluginHostType.h.

◆ isAULab()

bool juce::PluginHostType::isAULab ( ) const

noexcept

Returns true if the host is AU Lab.

Definition at line 132 of file juce_PluginHostType.h.

◆ isAUVal()

bool juce::PluginHostType::isAUVal ( ) const

noexcept

Returns true if the host is auval.

Definition at line 134 of file juce_PluginHostType.h.

◆ isBitwigStudio()

bool juce::PluginHostType::isBitwigStudio ( ) const

noexcept

Returns true if the host is Bitwig Studio.

Definition at line 136 of file juce_PluginHostType.h.

◆ isCubase()

bool juce::PluginHostType::isCubase ( ) const

noexcept

Returns true if the host is any version of Steinberg Cubase.

Definition at line 138 of file juce_PluginHostType.h.

◆ isCubase7orLater()

bool juce::PluginHostType::isCubase7orLater ( ) const

noexcept

Returns true if the host is Steinberg Cubase 7 or later.

Definition at line 142 of file juce_PluginHostType.h.

◆ isCubaseBridged()

bool juce::PluginHostType::isCubaseBridged ( ) const

noexcept

Returns true if the host is Steinberg Cubase 5 Bridged.

Definition at line 144 of file juce_PluginHostType.h.

◆ isDaVinciResolve()

bool juce::PluginHostType::isDaVinciResolve ( ) const

noexcept

Returns true if the host is DaVinci Resolve.

Definition at line 146 of file juce_PluginHostType.h.

◆ isDigitalPerformer()

bool juce::PluginHostType::isDigitalPerformer ( ) const

noexcept

Returns true if the host is Digital Performer.

Definition at line 148 of file juce_PluginHostType.h.

◆ isFinalCut()

bool juce::PluginHostType::isFinalCut ( ) const

noexcept

Returns true if the host is Apple Final Cut Pro.

Definition at line 150 of file juce_PluginHostType.h.

◆ isFruityLoops()

bool juce::PluginHostType::isFruityLoops ( ) const

noexcept

Returns true if the host is Fruity Loops.

Definition at line 152 of file juce_PluginHostType.h.

◆ isGarageBand()

bool juce::PluginHostType::isGarageBand ( ) const

noexcept

Returns true if the host is Apple GarageBand.

Definition at line 154 of file juce_PluginHostType.h.

◆ isInAAXAudioSuite()

bool juce::PluginHostType::isInAAXAudioSuite ( AudioProcessor & processor )

static

Returns true if the AudioProcessor instance is an AAX plug-in running in AudioSuite.

Definition at line 59 of file juce_PluginHostType.cpp.

◆ isInterAppAudioConnected()

bool juce::PluginHostType::isInterAppAudioConnected ( ) const

Returns true if the plugin is connected with Inter-App Audio on iOS.

Definition at line 41 of file juce_PluginHostType.cpp.

◆ isJUCEPluginHost()

bool juce::PluginHostType::isJUCEPluginHost ( ) const

noexcept

Returns true if the host is the JUCE AudioPluginHost.

Definition at line 156 of file juce_PluginHostType.h.

◆ isLogic()

bool juce::PluginHostType::isLogic ( ) const

noexcept

Returns true if the host is Apple Logic Pro.

Definition at line 158 of file juce_PluginHostType.h.

◆ isMainStage()

bool juce::PluginHostType::isMainStage ( ) const

noexcept

Returns true if the host is Apple MainStage.

Definition at line 160 of file juce_PluginHostType.h.

◆ isMaschine()

bool juce::PluginHostType::isMaschine ( ) const

noexcept

Returns true if the host is Native Instruments Maschine.

Definition at line 208 of file juce_PluginHostType.h.

◆ isNuendo()

bool juce::PluginHostType::isNuendo ( ) const

noexcept

Returns true if the host is any version of Steinberg Nuendo.

Definition at line 162 of file juce_PluginHostType.h.

◆ isPluginval()

bool juce::PluginHostType::isPluginval ( ) const

noexcept

Returns true if the host is pluginval.

Definition at line 164 of file juce_PluginHostType.h.

◆ isPremiere()

bool juce::PluginHostType::isPremiere ( ) const

noexcept

Returns true if the host is Adobe Premiere Pro.

Definition at line 166 of file juce_PluginHostType.h.

◆ isProTools()

bool juce::PluginHostType::isProTools ( ) const

noexcept

Returns true if the host is Avid Pro Tools.

Definition at line 168 of file juce_PluginHostType.h.

◆ isPyramix()

bool juce::PluginHostType::isPyramix ( ) const

noexcept

Returns true if the host is Merging Pyramix.

Definition at line 170 of file juce_PluginHostType.h.

◆ isReaper()

bool juce::PluginHostType::isReaper ( ) const

noexcept

Returns true if the host is Cockos Reaper.

Definition at line 174 of file juce_PluginHostType.h.

◆ isReason()

bool juce::PluginHostType::isReason ( ) const

noexcept

Returns true if the host is Reason.

Definition at line 176 of file juce_PluginHostType.h.

◆ isReceptor()

bool juce::PluginHostType::isReceptor ( ) const

noexcept

Returns true if the host is Muse Receptor.

Definition at line 172 of file juce_PluginHostType.h.

◆ isRenoise()

bool juce::PluginHostType::isRenoise ( ) const

noexcept

Returns true if the host is Renoise.

Definition at line 178 of file juce_PluginHostType.h.

◆ isSADiE()

bool juce::PluginHostType::isSADiE ( ) const

noexcept

Returns true if the host is SADiE.

Definition at line 180 of file juce_PluginHostType.h.

◆ isSamplitude()

bool juce::PluginHostType::isSamplitude ( ) const

noexcept

Returns true if the host is Magix Samplitude.

Definition at line 182 of file juce_PluginHostType.h.

◆ isSequoia()

bool juce::PluginHostType::isSequoia ( ) const

noexcept

Returns true if the host is Magix Sequoia.

Definition at line 184 of file juce_PluginHostType.h.

◆ isSonar()

bool juce::PluginHostType::isSonar ( ) const

noexcept

Returns true if the host is any version of Cakewalk Sonar.

Definition at line 186 of file juce_PluginHostType.h.

◆ isSteinberg()

bool juce::PluginHostType::isSteinberg ( ) const

noexcept

Returns true if the host is any product from Steinberg.

Definition at line 190 of file juce_PluginHostType.h.

◆ isSteinbergTestHost()

bool juce::PluginHostType::isSteinbergTestHost ( ) const

noexcept

Returns true if the host is Steinberg's VST3 Test Host.

Definition at line 188 of file juce_PluginHostType.h.

◆ isStudioOne()

bool juce::PluginHostType::isStudioOne ( ) const

noexcept

Returns true if the host is PreSonus Studio One.

Definition at line 192 of file juce_PluginHostType.h.

◆ isTracktion()

bool juce::PluginHostType::isTracktion ( ) const

noexcept

Returns true if the host is any version of Tracktion.

Definition at line 194 of file juce_PluginHostType.h.

◆ isTracktionWaveform()

bool juce::PluginHostType::isTracktionWaveform ( ) const

noexcept

Returns true if the host is Tracktion Waveform.

Definition at line 196 of file juce_PluginHostType.h.

◆ isVBVSTScanner()

bool juce::PluginHostType::isVBVSTScanner ( ) const

noexcept

Returns true if the host is VB Audio VST Scanner.

Definition at line 198 of file juce_PluginHostType.h.

◆ isViennaEnsemblePro()

bool juce::PluginHostType::isViennaEnsemblePro ( ) const

noexcept

Returns true if the host is Vienna Ensemble Pro.

Definition at line 200 of file juce_PluginHostType.h.

◆ isWaveBurner()

bool juce::PluginHostType::isWaveBurner ( ) const

noexcept

Returns true if the host is Apple WaveBurner.

Definition at line 202 of file juce_PluginHostType.h.

◆ isWavelab()

bool juce::PluginHostType::isWavelab ( ) const

noexcept

Returns true if the host is any version of Steinberg WaveLab.

Definition at line 204 of file juce_PluginHostType.h.

◆ isWavelabLegacy()

bool juce::PluginHostType::isWavelabLegacy ( ) const

noexcept

Returns true if the host is Steinberg WaveLab 6 or below.

Definition at line 206 of file juce_PluginHostType.h.

◆ switchToHostApplication()

void juce::PluginHostType::switchToHostApplication ( ) const

Switches to the host application when Inter-App Audio is used on iOS.

Definition at line 51 of file juce_PluginHostType.cpp.

Member Data Documentation

◆ type

HostType juce::PluginHostType::type

Definition at line 118 of file juce_PluginHostType.h.

The documentation for this class was generated from the following files:

juce_audio_processors/utilities/juce_PluginHostType.h
juce_audio_processors/utilities/juce_PluginHostType.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ HostType

Constructor & Destructor Documentation

◆ PluginHostType()

Member Function Documentation

◆ getHostDescription()

◆ getHostIcon()

◆ getHostPath()

◆ getPluginLoadedAs()

◆ isAbletonLive()

◆ isAdobeAudition()

◆ isAppleInfoHelper()

◆ isArdour()

◆ isAULab()

◆ isAUVal()

◆ isBitwigStudio()

◆ isCubase()

◆ isCubase7orLater()

◆ isCubaseBridged()

◆ isDaVinciResolve()

◆ isDigitalPerformer()

◆ isFinalCut()

◆ isFruityLoops()

◆ isGarageBand()

◆ isInAAXAudioSuite()

◆ isInterAppAudioConnected()

◆ isJUCEPluginHost()

◆ isLogic()

◆ isMainStage()

◆ isMaschine()

◆ isNuendo()

◆ isPluginval()

◆ isPremiere()

◆ isProTools()

◆ isPyramix()

◆ isReaper()

◆ isReason()

◆ isReceptor()

◆ isRenoise()

◆ isSADiE()

◆ isSamplitude()

◆ isSequoia()

◆ isSonar()

◆ isSteinberg()

◆ isSteinbergTestHost()

◆ isStudioOne()

◆ isTracktion()

◆ isTracktionWaveform()

◆ isVBVSTScanner()

◆ isViennaEnsemblePro()

◆ isWaveBurner()

◆ isWavelab()

◆ isWavelabLegacy()

◆ switchToHostApplication()

Member Data Documentation

◆ type