tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications

« « « Anklang Documentation
Loading...
Searching...
No Matches
tracktion_AuxReturn.h
Go to the documentation of this file.
1 /*
2 ,--. ,--. ,--. ,--.
3 ,-' '-.,--.--.,--,--.,---.| |,-.,-' '-.`--' ,---. ,--,--, Copyright 2024
4 '-. .-'| .--' ,-. | .--'| /'-. .-',--.| .-. || \ Tracktion Software
5 | | | | \ '-' \ `--.| \ \ | | | |' '-' '| || | Corporation
6 `---' `--' `--`--'`---'`--'`--' `---' `--' `---' `--''--' www.tracktion.com
7
8 Tracktion Engine uses a GPL/commercial licence - see LICENCE.md for details.
9*/
10
11namespace tracktion { inline namespace engine
12{
13
14class AuxReturnPlugin : public Plugin
15{
16public:
18 ~AuxReturnPlugin() override;
19
20 static const char* getPluginName() { return NEEDS_TRANS("Aux Return"); }
21 static const char* xmlTypeName;
22
23 juce::String getName() const override;
24 juce::String getPluginType() override { return xmlTypeName; }
25 juce::String getShortName (int suggestedMaxLength) override;
26 juce::String getSelectableDescription() override { return TRANS("Aux Return Plugin"); }
27 int getNumOutputChannelsGivenInputs (int numInputChannels) override { return juce::jmin (numInputChannels, 2); }
28
29 void initialise (const PluginInitialisationInfo&) override;
30 void deinitialise() override;
31 void applyToBuffer (const PluginRenderContext&) override;
32
33 bool takesAudioInput() override { return true; }
34 bool takesMidiInput() override { return true; }
35 bool producesAudioWhenNoAudioInput() override { return true; }
36 bool canBeAddedToClip() override { return false; }
37 bool canBeAddedToRack() override { return false; }
38 bool needsConstantBufferSize() override { return true; }
39
40 void restorePluginStateFromValueTree (const juce::ValueTree&) override;
41
42 juce::CachedValue<int> busNumber;
43
44private:
46};
47
48}} // namespace tracktion { inline namespace engine
void deinitialise() override
Called after play stops to release resources.
juce::String getSelectableDescription() override
Subclasses must return a description of what they are.
juce::String getName() const override
The name of the type, e.g.
int getNumOutputChannelsGivenInputs(int numInputChannels) override
This must return the number of output channels that the plugin will produce, given a number of input ...
void applyToBuffer(const PluginRenderContext &) override
Process the next block of data.
#define TRANS(stringLiteral)
#define NEEDS_TRANS(stringLiteral)
#define JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(className)
constexpr Type jmin(Type a, Type b)
Passed into Plugins when they are being initialised, to give them useful contextual information that ...
The context passed to plugin render methods to provide it with buffers to fill.