linuxsampler 2.3.1
FxSend.h
Go to the documentation of this file.
1/***************************************************************************
2 * *
3 * LinuxSampler - modular, streaming capable sampler *
4 * *
5 * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6 * Copyright (C) 2005 - 2010 Christian Schoenebeck *
7 * *
8 * This library is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
12 * *
13 * This library is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this library; if not, write to the Free Software *
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21 * MA 02111-1307 USA *
22 ***************************************************************************/
23
24#ifndef LS_FXSEND_H
25#define LS_FXSEND_H
26
27#include "../common/global.h"
28#include "../drivers/audio/AudioChannel.h"
29#include "EngineChannel.h"
30
31#include <vector>
32
33namespace LinuxSampler {
34
35 // just symbol prototyping
36 class EngineChannel;
37
231
232} // namespace LinuxSampler
233
234#endif // LS_FXSEND_H
Channel Interface for LinuxSampler Sampler Engines.
Exception that will be thrown in NON REAL TIME PARTS of the LinuxSampler application.
Definition Exception.h:37
Engine Channel Effect Send.
Definition FxSend.h:56
void SetDestinationChannel(int SrcChan, int DstChan)
Alters the routing of an audio channel.
void SetMidiController(uint8_t MidiCtrl)
Alter the MIDI controller number which should alter the effect send's send level.
int iDestinationEffectChainPos
Definition FxSend.h:223
EngineChannel * pEngineChannel
Definition FxSend.h:221
int iDestinationEffectChain
Definition FxSend.h:222
uint8_t MidiController()
Returns the MIDI controller number which can alter the effect send's send level.
void SetName(String Name)
Sets the name of this effect send entity.
void UpdateChannels()
Should be called by the engine channel whenever the amount of audio channel has changed,...
FxSend(EngineChannel *pEngineChannel, uint8_t MidiCtrl, String Name="")
Constructor.
uint Id()
Returns the (at least sampler-channel-) unique ID of the effect send instance.
void Reset()
Reset send level to the default send level (i.e.
uint8_t MidiFxSendController
Definition FxSend.h:225
float Level()
The effect send's current send level ( usually a value between 0.0f and 1.0f ).
String Name()
Returns the (optional) name of this effect send entity.
int DestinationMasterEffect() const DEPRECATED_API
void SetDestinationMasterEffect(int iChain, int iChainPos) DEPRECATED_API
int DestinationChannel(int SrcChan)
Returns the audio output device's audio channel to which effect send's channel SrcChan is currently r...
void SetLevel(float f)
Alter the effect send's send level ( usually a value between 0.0f and 1.0f ).
int DestinationEffectChainPosition() const
Index of the send effect of the send effect chain given by DestinationEffectChain(),...
int DestinationEffectChain() const
Index of the send effect chain this FX send is routed to or -1 if FX send is not routed to a send eff...
void SetDestinationEffect(int iChain, int iChainPos)
Route this FX send to the given send effect given by index iChainPos of the send effect chain given b...
int DestinationMasterEffectChain() const DEPRECATED_API
void SetInfoChanged(bool b)
Sets whether the effect send's settings are changed.
std::vector< int > Routing
Definition FxSend.h:224
bool IsInfoChanged()
Determines whether the effect send's settings are changed.
Wraps as a kind of pointer class some data object shared with other threads, to protect / synchronize...
#define DEPRECATED_API
Definition global.h:71
std::string String
Definition global.h:44