#include <juce_PluginHostType.h>

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
}

Public Member Functions
	PluginHostType ()
	PluginHostType (const PluginHostType &other)=default
PluginHostType &	operator= (const PluginHostType &other)=default
bool	isAbletonLive () const noexcept
bool	isAdobeAudition () const noexcept
bool	isArdour () const noexcept
bool	isAULab () const noexcept
bool	isBitwigStudio () const noexcept
bool	isCubase () const noexcept
bool	isCubase7orLater () const noexcept
bool	isCubaseBridged () const noexcept
bool	isDaVinciResolve () const noexcept
bool	isDigitalPerformer () const noexcept
bool	isFinalCut () const noexcept
bool	isFruityLoops () const noexcept
bool	isGarageBand () const noexcept
bool	isJUCEPluginHost () const noexcept
bool	isLogic () const noexcept
bool	isMainStage () const noexcept
bool	isNuendo () const noexcept
bool	isPluginval () const noexcept
bool	isPremiere () const noexcept
bool	isProTools () const noexcept
bool	isPyramix () const noexcept
bool	isReceptor () const noexcept
bool	isReaper () const noexcept
bool	isReason () const noexcept
bool	isRenoise () const noexcept
bool	isSADiE () const noexcept
bool	isSamplitude () const noexcept
bool	isSequoia () const noexcept
bool	isSonar () const noexcept
bool	isSteinbergTestHost () const noexcept
bool	isSteinberg () const noexcept
bool	isStudioOne () const noexcept
bool	isTracktion () const noexcept
bool	isTracktionWaveform () const noexcept
bool	isVBVSTScanner () const noexcept
bool	isViennaEnsemblePro () const noexcept
bool	isWaveBurner () const noexcept
bool	isWavelab () const noexcept
bool	isWavelabLegacy () const noexcept
const char *	getHostDescription () const noexcept
bool	isInterAppAudioConnected () const
void	switchToHostApplication () const
Image	getHostIcon (int size) const

Static Public Member Functions
static String	getHostPath ()
static AudioProcessor::WrapperType	getPluginLoadedAs () noexcept
static bool	isInAAXAudioSuite (AudioProcessor &)

Public Attributes
HostType	type

Static Public Attributes
static AudioProcessor::WrapperType	jucePlugInClientCurrentWrapperType = AudioProcessor::wrapperType_Undefined
static std::function< bool(AudioProcessor &)>	jucePlugInIsRunningInAudioSuiteFn = nullptr
static String	hostIdReportedByWrapper

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()

String juce::PluginHostType::getHostPath ( )

inlinestatic

Returns the complete absolute path of the host application executable.

◆ getHostType()

PluginHostType::HostType juce::PluginHostType::getHostType ( )

staticprivate

◆ getPluginLoadedAs()

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

◆ isAbletonLive()

bool juce::PluginHostType::isAbletonLive ( ) const

inlinenoexcept

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

◆ isAdobeAudition()

bool juce::PluginHostType::isAdobeAudition ( ) const

inlinenoexcept

Returns true if the host is Adobe Audition.

◆ isArdour()

bool juce::PluginHostType::isArdour ( ) const

inlinenoexcept

Returns true if the host is Ardour.

◆ isAULab()

bool juce::PluginHostType::isAULab ( ) const

inlinenoexcept

Returns true if the host is AU Lab.

◆ isBitwigStudio()

bool juce::PluginHostType::isBitwigStudio ( ) const

inlinenoexcept

Returns true if the host is Bitwig Studio.

◆ isCubase()

bool juce::PluginHostType::isCubase ( ) const

inlinenoexcept

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

◆ isCubase7orLater()

bool juce::PluginHostType::isCubase7orLater ( ) const

inlinenoexcept

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

◆ isCubaseBridged()

bool juce::PluginHostType::isCubaseBridged ( ) const

inlinenoexcept

Returns true if the host is Steinberg Cubase 5 Bridged.

◆ isDaVinciResolve()

bool juce::PluginHostType::isDaVinciResolve ( ) const

inlinenoexcept

Returns true if the host is DaVinci Resolve.

◆ isDigitalPerformer()

bool juce::PluginHostType::isDigitalPerformer ( ) const

inlinenoexcept

Returns true if the host is Digital Performer.

◆ isFinalCut()

bool juce::PluginHostType::isFinalCut ( ) const

inlinenoexcept

Returns true if the host is Apple Final Cut Pro.

◆ isFruityLoops()

bool juce::PluginHostType::isFruityLoops ( ) const

inlinenoexcept

Returns true if the host is Fruity Loops.

◆ isGarageBand()

bool juce::PluginHostType::isGarageBand ( ) const

inlinenoexcept

Returns true if the host is Apple GarageBand.

◆ isInAAXAudioSuite()

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

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

◆ isLogic()

bool juce::PluginHostType::isLogic ( ) const

inlinenoexcept

Returns true if the host is Apple Logic Pro.

◆ isMainStage()

bool juce::PluginHostType::isMainStage ( ) const

inlinenoexcept

Returns true if the host is Apple MainStage.

◆ isNuendo()

bool juce::PluginHostType::isNuendo ( ) const

inlinenoexcept

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

◆ isPluginval()

bool juce::PluginHostType::isPluginval ( ) const

inlinenoexcept

Returns true if the host is pluginval.

◆ isPremiere()

bool juce::PluginHostType::isPremiere ( ) const

inlinenoexcept

Returns true if the host is Adobe Premiere Pro.

◆ isProTools()

bool juce::PluginHostType::isProTools ( ) const

inlinenoexcept

Returns true if the host is Avid Pro Tools.

◆ isPyramix()

bool juce::PluginHostType::isPyramix ( ) const

inlinenoexcept

Returns true if the host is Merging Pyramix.

◆ isReaper()

bool juce::PluginHostType::isReaper ( ) const

inlinenoexcept

Returns true if the host is Cockos Reaper.

◆ isReason()

bool juce::PluginHostType::isReason ( ) const

inlinenoexcept

Returns true if the host is Reason.

◆ isReceptor()

bool juce::PluginHostType::isReceptor ( ) const

inlinenoexcept

Returns true if the host is Muse Receptor.

◆ isRenoise()

bool juce::PluginHostType::isRenoise ( ) const

inlinenoexcept

Returns true if the host is Renoise.

◆ isSADiE()

bool juce::PluginHostType::isSADiE ( ) const

inlinenoexcept

Returns true if the host is SADiE.

◆ isSamplitude()

bool juce::PluginHostType::isSamplitude ( ) const

inlinenoexcept

Returns true if the host is Magix Samplitude.

◆ isSequoia()

bool juce::PluginHostType::isSequoia ( ) const

inlinenoexcept

Returns true if the host is Magix Sequoia.

◆ isSonar()

bool juce::PluginHostType::isSonar ( ) const

inlinenoexcept

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

◆ isSteinberg()

bool juce::PluginHostType::isSteinberg ( ) const

inlinenoexcept

Returns true if the host is any product from Steinberg.

◆ isSteinbergTestHost()

bool juce::PluginHostType::isSteinbergTestHost ( ) const

inlinenoexcept

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

◆ isStudioOne()

bool juce::PluginHostType::isStudioOne ( ) const

inlinenoexcept

Returns true if the host is PreSonus Studio One.

◆ isTracktion()

bool juce::PluginHostType::isTracktion ( ) const

inlinenoexcept

Returns true if the host is any version of Tracktion.

◆ isTracktionWaveform()

bool juce::PluginHostType::isTracktionWaveform ( ) const

inlinenoexcept

Returns true if the host is Tracktion Waveform.

◆ isVBVSTScanner()

bool juce::PluginHostType::isVBVSTScanner ( ) const

inlinenoexcept

Returns true if the host is VB Audio VST Scanner.

◆ isViennaEnsemblePro()

bool juce::PluginHostType::isViennaEnsemblePro ( ) const

inlinenoexcept

Returns true if the host is Vienna Ensemble Pro.

◆ isWaveBurner()

bool juce::PluginHostType::isWaveBurner ( ) const

inlinenoexcept

Returns true if the host is Apple WaveBurner.

◆ isWavelab()

bool juce::PluginHostType::isWavelab ( ) const

inlinenoexcept

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

◆ isWavelabLegacy()

bool juce::PluginHostType::isWavelabLegacy ( ) const

inlinenoexcept

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

◆ 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

◆ hostIdReportedByWrapper

String juce::PluginHostType::hostIdReportedByWrapper

static

◆ jucePlugInClientCurrentWrapperType

AudioProcessor::WrapperType juce::PluginHostType::jucePlugInClientCurrentWrapperType = AudioProcessor::wrapperType_Undefined

static

◆ jucePlugInIsRunningInAudioSuiteFn

std::function< bool(AudioProcessor &)> juce::PluginHostType::jucePlugInIsRunningInAudioSuiteFn = nullptr

static

◆ type

HostType juce::PluginHostType::type

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

/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_processors/utilities/juce_PluginHostType.h
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_processors/utilities/juce_PluginHostType.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static 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

◆ hostIdReportedByWrapper

◆ jucePlugInClientCurrentWrapperType

◆ jucePlugInIsRunningInAudioSuiteFn

◆ type