PluginBusUtilities Class Reference

Classes
class	ScopedBusRestorer
struct	SupportedBusLayouts

Public Types
typedef Array< AudioProcessor::AudioProcessorBus >	AudioBusArray

Public Member Functions
	PluginBusUtilities (AudioProcessor &plugin, bool markDiscreteLayoutsAsSupported)
AudioBusArray &	getFilterBus (bool inputBus) noexcept
const AudioBusArray &	getFilterBus (bool inputBus) const noexcept
int	getBusCount (bool inputBus) const noexcept
AudioChannelSet	getChannelSet (bool inputBus, int bus) noexcept
int	getNumChannels (bool inp, int bus) const noexcept
bool	isBusEnabled (bool inputBus, int bus) const noexcept
bool	hasInputs (int bus) const noexcept
bool	hasOutputs (int bus) const noexcept
int	getNumEnabledBuses (bool inputBus) const noexcept
int	findTotalNumChannels (bool isInput) const noexcept
void	restoreBusArrangement (const AudioProcessor::AudioBusArrangement &original) const
Array< SupportedBusLayouts > &	getSupportedLayouts (bool isInput) noexcept
const Array< SupportedBusLayouts > &	getSupportedLayouts (bool isInput) const noexcept
SupportedBusLayouts &	getSupportedBusLayouts (bool isInput, int busNr) noexcept
const SupportedBusLayouts &	getSupportedBusLayouts (bool isInput, int busNr) const noexcept
bool	busIgnoresLayout (bool inp, int bus) const noexcept
const AudioChannelSet &	getDefaultLayoutForBus (bool isInput, int busIdx) const noexcept
bool	hasDynamicInBuses () const noexcept
bool	hasDynamicOutBuses () const noexcept
void	clear (int inputCount, int outputCount)
AudioChannelSet	getDefaultLayoutForChannelNumAndBus (bool isInput, int busIdx, int channelNum) const noexcept
void	findAllCompatibleLayouts ()
void	enableAllBuses ()

Public Attributes
AudioProcessor &	juceFilter

Member Typedef Documentation

typedef Array<AudioProcessor::AudioProcessorBus> PluginBusUtilities::AudioBusArray

Constructor & Destructor Documentation

PluginBusUtilities::PluginBusUtilities	(	AudioProcessor &	plugin,
		bool	markDiscreteLayoutsAsSupported
	)

Member Function Documentation

AudioBusArray& PluginBusUtilities::getFilterBus ( bool  inputBus )

noexcept

References AudioProcessor::busArrangement, AudioProcessor::AudioBusArrangement::inputBuses, juceFilter, and AudioProcessor::AudioBusArrangement::outputBuses.

Referenced by findTotalNumChannels(), getBusCount(), getChannelSet(), and getNumChannels().

const AudioBusArray& PluginBusUtilities::getFilterBus ( bool  inputBus ) const

noexcept

References AudioProcessor::busArrangement, AudioProcessor::AudioBusArrangement::inputBuses, juceFilter, and AudioProcessor::AudioBusArrangement::outputBuses.

int PluginBusUtilities::getBusCount ( bool  inputBus ) const

noexcept

References getFilterBus(), and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

Referenced by enableAllBuses(), findAllCompatibleLayouts(), getNumChannels(), getNumEnabledBuses(), and restoreBusArrangement().

AudioChannelSet PluginBusUtilities::getChannelSet ( bool  inputBus, int  bus  )

noexcept

References AudioProcessor::AudioProcessorBus::channels, getFilterBus(), and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference().

Referenced by enableAllBuses().

int PluginBusUtilities::getNumChannels ( bool  inp, int  bus  ) const

noexcept

References AudioProcessor::AudioProcessorBus::channels, getBusCount(), getFilterBus(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference(), isPositiveAndBelow(), and AudioChannelSet::size().

Referenced by isBusEnabled().

bool PluginBusUtilities::isBusEnabled ( bool  inputBus, int  bus  ) const

noexcept

References getNumChannels().

Referenced by getNumEnabledBuses(), hasInputs(), and hasOutputs().

bool PluginBusUtilities::hasInputs ( int  bus ) const

noexcept

References isBusEnabled().

bool PluginBusUtilities::hasOutputs ( int  bus ) const

noexcept

References isBusEnabled().

int PluginBusUtilities::getNumEnabledBuses ( bool  inputBus ) const

noexcept

References getBusCount(), and isBusEnabled().

int PluginBusUtilities::findTotalNumChannels ( bool  isInput ) const

noexcept

References AudioProcessor::AudioProcessorBus::channels, getFilterBus(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference(), AudioChannelSet::size(), and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

void PluginBusUtilities::restoreBusArrangement

(

const AudioProcessor::AudioBusArrangement &

original

)

const

References getBusCount(), AudioProcessor::AudioBusArrangement::inputBuses, jassert, juceFilter, AudioProcessor::AudioBusArrangement::outputBuses, and AudioProcessor::setPreferredBusArrangement().

Array<SupportedBusLayouts>& PluginBusUtilities::getSupportedLayouts ( bool  isInput )

noexcept

Referenced by busIgnoresLayout(), and getSupportedBusLayouts().

const Array<SupportedBusLayouts>& PluginBusUtilities::getSupportedLayouts ( bool  isInput ) const

noexcept

SupportedBusLayouts& PluginBusUtilities::getSupportedBusLayouts ( bool  isInput, int  busNr  )

noexcept

References getSupportedLayouts().

Referenced by busIgnoresLayout(), getDefaultLayoutForBus(), and getDefaultLayoutForChannelNumAndBus().

const SupportedBusLayouts& PluginBusUtilities::getSupportedBusLayouts ( bool  isInput, int  busNr  ) const

noexcept

References getSupportedLayouts().

bool PluginBusUtilities::busIgnoresLayout ( bool  inp, int  bus  ) const

noexcept

References PluginBusUtilities::SupportedBusLayouts::busIgnoresLayout, getSupportedBusLayouts(), getSupportedLayouts(), and isPositiveAndBelow().

const AudioChannelSet& PluginBusUtilities::getDefaultLayoutForBus ( bool  isInput, int  busIdx  ) const

noexcept

References PluginBusUtilities::SupportedBusLayouts::getDefault(), and getSupportedBusLayouts().

Referenced by enableAllBuses().

bool PluginBusUtilities::hasDynamicInBuses ( ) const

noexcept

bool PluginBusUtilities::hasDynamicOutBuses ( ) const

noexcept

void PluginBusUtilities::clear	(	int	inputCount,
		int	outputCount
	)

Referenced by findAllCompatibleLayouts().

AudioChannelSet PluginBusUtilities::getDefaultLayoutForChannelNumAndBus ( bool  isInput, int  busIdx, int  channelNum  ) const

noexcept

References AudioChannelSet::canonicalChannelSet(), PluginBusUtilities::SupportedBusLayouts::getDefaultLayoutForChannelNum(), and getSupportedBusLayouts().

void PluginBusUtilities::findAllCompatibleLayouts

(

)

References clear(), getBusCount(), and PluginBusUtilities::SupportedBusLayouts::updateDefaultLayout().

void PluginBusUtilities::enableAllBuses

(

)

References AudioChannelSet::disabled(), getBusCount(), getChannelSet(), getDefaultLayoutForBus(), juceFilter, and AudioProcessor::setPreferredBusArrangement().

Member Data Documentation

AudioProcessor& PluginBusUtilities::juceFilter

Referenced by enableAllBuses(), getFilterBus(), and restoreBusArrangement().

---

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

• juce_PluginBusUtilities.h