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

#include <juce_PluginHostType.h>

Collaboration diagram for juce::PluginHostType:

Public Types
enum	HostType { UnknownHost, AbletonLive6, AbletonLive7, AbletonLive8, AbletonLive9, AbletonLive10, AbletonLive11, AbletonLiveGeneric, AdobeAudition, AdobePremierePro, AppleGarageBand, AppleLogic, AppleMainStage, Ardour, AULab, AvidProTools, BitwigStudio, CakewalkSonar8, CakewalkSonarGeneric, CakewalkByBandlab, DaVinciResolve, DigitalPerformer, FinalCut, FruityLoops, JUCEPluginHost, MagixSamplitude, MagixSequoia, MergingPyramix, MuseReceptorGeneric, 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 ()

	PluginHostType (const PluginHostType &other)=default

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Attributes
HostType	type

Static Private Member Functions
static HostType	getHostType ()

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}

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.
AppleLogic	Represents Apple Logic Pro.
AppleMainStage	Represents Apple Main Stage.
Ardour	Represents Ardour.
AULab	Represents AU Lab.
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.
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.

Constructor & Destructor Documentation

◆ PluginHostType() [1/2]

juce::PluginHostType::PluginHostType ( )

inline

◆ PluginHostType() [2/2]

juce::PluginHostType::PluginHostType ( const PluginHostType & other )

default

Member Function Documentation

◆ getHostDescription()

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

noexcept

Returns a human-readable description of the host.

◆ getHostIcon()

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

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

◆ getHostPath()

static String juce::PluginHostType::getHostPath ( )

inlinestatic

Returns the complete absolute path of the host application executable.

References juce::File::getFullPathName(), juce::File::getSpecialLocation(), and juce::File::hostApplicationPath.

◆ getHostType()

static HostType juce::PluginHostType::getHostType ( )

staticprivate

◆ getPluginLoadedAs()

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

inlinestaticnoexcept

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

Referenced by juce::StandalonePluginHolder::getInstance().

◆ isAbletonLive()

bool juce::PluginHostType::isAbletonLive ( ) const

inlinenoexcept

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

References AbletonLive10, AbletonLive11, AbletonLive6, AbletonLive7, AbletonLive8, AbletonLive9, AbletonLiveGeneric, and type.

◆ isAdobeAudition()

bool juce::PluginHostType::isAdobeAudition ( ) const

inlinenoexcept

Returns true if the host is Adobe Audition.

References AdobeAudition, and type.

◆ isArdour()

bool juce::PluginHostType::isArdour ( ) const

inlinenoexcept

Returns true if the host is Ardour.

References Ardour, and type.

◆ isAULab()

bool juce::PluginHostType::isAULab ( ) const

inlinenoexcept

Returns true if the host is AU Lab.

References AULab, and type.

◆ isBitwigStudio()

bool juce::PluginHostType::isBitwigStudio ( ) const

inlinenoexcept

Returns true if the host is Bitwig Studio.

References BitwigStudio, and type.

◆ isCubase()

bool juce::PluginHostType::isCubase ( ) const

inlinenoexcept

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

References SteinbergCubase10, SteinbergCubase10_5, SteinbergCubase4, SteinbergCubase5, SteinbergCubase5Bridged, SteinbergCubase6, SteinbergCubase7, SteinbergCubase8, SteinbergCubase8_5, SteinbergCubase9, SteinbergCubase9_5, SteinbergCubaseGeneric, and type.

Referenced by isCubase7orLater(), and isSteinberg().

◆ isCubase7orLater()

bool juce::PluginHostType::isCubase7orLater ( ) const

inlinenoexcept

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

References isCubase(), SteinbergCubase4, SteinbergCubase5, SteinbergCubase6, and type.

◆ isCubaseBridged()

bool juce::PluginHostType::isCubaseBridged ( ) const

inlinenoexcept

Returns true if the host is Steinberg Cubase 5 Bridged.

References SteinbergCubase5Bridged, and type.

◆ isDaVinciResolve()

bool juce::PluginHostType::isDaVinciResolve ( ) const

inlinenoexcept

Returns true if the host is DaVinci Resolve.

References DaVinciResolve, and type.

◆ isDigitalPerformer()

bool juce::PluginHostType::isDigitalPerformer ( ) const

inlinenoexcept

Returns true if the host is Digital Performer.

References DigitalPerformer, and type.

◆ isFinalCut()

bool juce::PluginHostType::isFinalCut ( ) const

inlinenoexcept

Returns true if the host is Apple Final Cut Pro.

References FinalCut, and type.

◆ isFruityLoops()

bool juce::PluginHostType::isFruityLoops ( ) const

inlinenoexcept

Returns true if the host is Fruity Loops.

References FruityLoops, and type.

◆ isGarageBand()

bool juce::PluginHostType::isGarageBand ( ) const

inlinenoexcept

Returns true if the host is Apple GarageBand.

References AppleGarageBand, and type.

◆ isInAAXAudioSuite()

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

static

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

◆ isInterAppAudioConnected()

bool juce::PluginHostType::isInterAppAudioConnected ( ) const

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

◆ isJUCEPluginHost()

bool juce::PluginHostType::isJUCEPluginHost ( ) const

inlinenoexcept

Returns true if the host is the JUCE AudioPluginHost.

References JUCEPluginHost, and type.

◆ isLogic()

bool juce::PluginHostType::isLogic ( ) const

inlinenoexcept

Returns true if the host is Apple Logic Pro.

References AppleLogic, and type.

◆ isMainStage()

bool juce::PluginHostType::isMainStage ( ) const

inlinenoexcept

Returns true if the host is Apple MainStage.

References AppleMainStage, and type.

◆ isNuendo()

bool juce::PluginHostType::isNuendo ( ) const

inlinenoexcept

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

References SteinbergNuendo3, SteinbergNuendo4, SteinbergNuendo5, SteinbergNuendoGeneric, and type.

Referenced by isSteinberg().

◆ isPluginval()

bool juce::PluginHostType::isPluginval ( ) const

inlinenoexcept

Returns true if the host is pluginval.

References pluginval, and type.

◆ isPremiere()

bool juce::PluginHostType::isPremiere ( ) const

inlinenoexcept

Returns true if the host is Adobe Premiere Pro.

References AdobePremierePro, and type.

◆ isProTools()

bool juce::PluginHostType::isProTools ( ) const

inlinenoexcept

Returns true if the host is Avid Pro Tools.

References AvidProTools, and type.

◆ isPyramix()

bool juce::PluginHostType::isPyramix ( ) const

inlinenoexcept

Returns true if the host is Merging Pyramix.

References MergingPyramix, and type.

◆ isReaper()

bool juce::PluginHostType::isReaper ( ) const

inlinenoexcept

Returns true if the host is Cockos Reaper.

References Reaper, and type.

◆ isReason()

bool juce::PluginHostType::isReason ( ) const

inlinenoexcept

Returns true if the host is Reason.

References Reason, and type.

◆ isReceptor()

bool juce::PluginHostType::isReceptor ( ) const

inlinenoexcept

Returns true if the host is Muse Receptor.

References MuseReceptorGeneric, and type.

◆ isRenoise()

bool juce::PluginHostType::isRenoise ( ) const

inlinenoexcept

Returns true if the host is Renoise.

References Renoise, and type.

◆ isSADiE()

bool juce::PluginHostType::isSADiE ( ) const

inlinenoexcept

Returns true if the host is SADiE.

References SADiE, and type.

◆ isSamplitude()

bool juce::PluginHostType::isSamplitude ( ) const

inlinenoexcept

Returns true if the host is Magix Samplitude.

References MagixSamplitude, and type.

◆ isSequoia()

bool juce::PluginHostType::isSequoia ( ) const

inlinenoexcept

Returns true if the host is Magix Sequoia.

References MagixSequoia, and type.

◆ isSonar()

bool juce::PluginHostType::isSonar ( ) const

inlinenoexcept

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

References CakewalkByBandlab, CakewalkSonar8, CakewalkSonarGeneric, and type.

◆ isSteinberg()

bool juce::PluginHostType::isSteinberg ( ) const

inlinenoexcept

Returns true if the host is any product from Steinberg.

References isCubase(), isNuendo(), isSteinbergTestHost(), and isWavelab().

◆ isSteinbergTestHost()

bool juce::PluginHostType::isSteinbergTestHost ( ) const

inlinenoexcept

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

References SteinbergTestHost, and type.

Referenced by isSteinberg().

◆ isStudioOne()

bool juce::PluginHostType::isStudioOne ( ) const

inlinenoexcept

Returns true if the host is PreSonus Studio One.

References StudioOne, and type.

◆ isTracktion()

bool juce::PluginHostType::isTracktion ( ) const

inlinenoexcept

Returns true if the host is any version of Tracktion.

References isTracktionWaveform(), Tracktion3, TracktionGeneric, and type.

◆ isTracktionWaveform()

bool juce::PluginHostType::isTracktionWaveform ( ) const

inlinenoexcept

Returns true if the host is Tracktion Waveform.

References TracktionWaveform, and type.

Referenced by isTracktion().

◆ isVBVSTScanner()

bool juce::PluginHostType::isVBVSTScanner ( ) const

inlinenoexcept

Returns true if the host is VB Audio VST Scanner.

References type, and VBVSTScanner.

◆ isViennaEnsemblePro()

bool juce::PluginHostType::isViennaEnsemblePro ( ) const

inlinenoexcept

Returns true if the host is Vienna Ensemble Pro.

References type, and ViennaEnsemblePro.

◆ isWaveBurner()

bool juce::PluginHostType::isWaveBurner ( ) const

inlinenoexcept

Returns true if the host is Apple WaveBurner.

References type, and WaveBurner.

◆ isWavelab()

bool juce::PluginHostType::isWavelab ( ) const

inlinenoexcept

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

References isWavelabLegacy(), SteinbergWavelab7, SteinbergWavelab8, SteinbergWavelabGeneric, and type.

Referenced by isSteinberg().

◆ isWavelabLegacy()

bool juce::PluginHostType::isWavelabLegacy ( ) const

inlinenoexcept

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

References SteinbergWavelab5, SteinbergWavelab6, and type.

Referenced by isWavelab().

◆ operator=()

PluginHostType& juce::PluginHostType::operator= ( const PluginHostType & other )

default

◆ switchToHostApplication()

void juce::PluginHostType::switchToHostApplication ( ) const

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

Member Data Documentation

◆ type

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

juce_PluginHostType.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ HostType

Constructor & Destructor Documentation

◆ PluginHostType() [1/2]

◆ PluginHostType() [2/2]

Member Function Documentation

◆ getHostDescription()

◆ getHostIcon()

◆ getHostPath()

◆ getHostType()

◆ getPluginLoadedAs()

◆ isAbletonLive()

◆ isAdobeAudition()

◆ isArdour()

◆ isAULab()

◆ isBitwigStudio()

◆ isCubase()

◆ isCubase7orLater()

◆ isCubaseBridged()

◆ isDaVinciResolve()

◆ isDigitalPerformer()

◆ isFinalCut()

◆ isFruityLoops()

◆ isGarageBand()

◆ isInAAXAudioSuite()

◆ isInterAppAudioConnected()

◆ isJUCEPluginHost()

◆ isLogic()

◆ isMainStage()

◆ isNuendo()

◆ isPluginval()

◆ isPremiere()

◆ isProTools()

◆ isPyramix()

◆ isReaper()

◆ isReason()

◆ isReceptor()

◆ isRenoise()

◆ isSADiE()

◆ isSamplitude()

◆ isSequoia()

◆ isSonar()

◆ isSteinberg()

◆ isSteinbergTestHost()

◆ isStudioOne()

◆ isTracktion()

◆ isTracktionWaveform()

◆ isVBVSTScanner()

◆ isViennaEnsemblePro()

◆ isWaveBurner()

◆ isWavelab()

◆ isWavelabLegacy()

◆ operator=()

◆ switchToHostApplication()

Member Data Documentation

◆ type