OPERATOR Class Reference

All ecasound objects which can be used as targets for dynamic control, are called operators. More...

Inheritance diagram for OPERATOR:

List of all members.

Public Types
typedef SAMPLE_SPECS::sample_t	parameter_t
Public Member Functions
virtual void	parameter_description (int param, struct PARAM_DESCRIPTION *pd) const
	An optional function for querying parameter descriptions.
virtual OPERATOR *	clone (void) const =0
	Virtual method that clones the current object and returns a pointer to it.
virtual OPERATOR *	new_expr (void) const =0
	Virtual method that creates a new object of current type.
Classes
struct	PARAM_DESCRIPTION
	Structure describing one operator parameter. More...

---

Detailed Description

All ecasound objects which can be used as targets for dynamic control, are called operators.

Author:

Kai Vehmanen

---

Member Function Documentation

virtual OPERATOR* OPERATOR::clone (  void   )  const [pure virtual]

Virtual method that clones the current object and returns a pointer to it. This must be implemented by all subclasses! Implements DYNAMIC_OBJECT< SAMPLE_SPECS::sample_t >. Implemented in TWO_STAGE_LINEAR_ENVELOPE, EFFECT_AMPLIFY, EFFECT_AMPLIFY_CLIPCOUNT, EFFECT_AMPLIFY_CHANNEL, EFFECT_LIMITER, EFFECT_COMPRESS, EFFECT_NOISEGATE, EFFECT_NORMAL_PAN, EFFECT_VOLUME_BUCKETS, EFFECT_VOLUME_PEAK, EFFECT_DCFIND, ADVANCED_COMPRESSOR, EFFECT_PULSE_GATE, EFFECT_PULSE_GATE_BPM, EFFECT_TREMOLO, EFFECT_BW_FILTER, EFFECT_BANDPASS, EFFECT_BANDREJECT, EFFECT_HIGHPASS, EFFECT_ALLPASS_FILTER, EFFECT_COMB_FILTER, EFFECT_INVERSE_COMB_FILTER, EFFECT_LOWPASS, EFFECT_LOWPASS_SIMPLE, EFFECT_RESONANT_BANDPASS, EFFECT_RESONANT_LOWPASS, EFFECT_RESONATOR, EFFECT_LADSPA, EFFECT_DCFIX, EFFECT_PITCH_SHIFT, EFFECT_AUDIO_STAMP, EFFECT_CHANNEL_COPY, EFFECT_MIX_TO_CHANNEL, EFFECT_RC_LOWPASS_FILTER, ADVANCED_REVERB, EFFECT_TIME_BASED, EFFECT_DELAY, EFFECT_MULTITAP_DELAY, EFFECT_FAKE_STEREO, EFFECT_REVERB, EFFECT_FLANGER, EFFECT_CHORUS, EFFECT_PHASER, GATE_BASE, TIME_CROP_GATE, THRESHOLD_GATE, CONTROLLER_SOURCE, FILE_PRESET, GENERIC_CONTROLLER, GENERIC_LINEAR_ENVELOPE, GLOBAL_PRESET, LINEAR_ENVELOPE, MIDI_CONTROLLER, GENERIC_OSCILLATOR_FILE, GENERIC_OSCILLATOR, SINE_OSCILLATOR, PRESET, VOLUME_ANALYZE_CONTROLLER, and TWO_STAGE_LINEAR_ENVELOPE.

virtual OPERATOR* OPERATOR::new_expr (  void   )  const [pure virtual]

Virtual method that creates a new object of current type. This must be implemented by all subclasses! Implements DYNAMIC_OBJECT< SAMPLE_SPECS::sample_t >. Implemented in EFFECT_AMPLIFY, EFFECT_AMPLIFY_CLIPCOUNT, EFFECT_AMPLIFY_CHANNEL, EFFECT_LIMITER, EFFECT_COMPRESS, EFFECT_NOISEGATE, EFFECT_NORMAL_PAN, EFFECT_VOLUME_BUCKETS, EFFECT_VOLUME_PEAK, EFFECT_DCFIND, ADVANCED_COMPRESSOR, EFFECT_PULSE_GATE, EFFECT_PULSE_GATE_BPM, EFFECT_TREMOLO, EFFECT_BANDPASS, EFFECT_BANDREJECT, EFFECT_HIGHPASS, EFFECT_ALLPASS_FILTER, EFFECT_COMB_FILTER, EFFECT_INVERSE_COMB_FILTER, EFFECT_LOWPASS, EFFECT_LOWPASS_SIMPLE, EFFECT_RESONANT_BANDPASS, EFFECT_RESONANT_LOWPASS, EFFECT_RESONATOR, EFFECT_LADSPA, EFFECT_DCFIX, EFFECT_PITCH_SHIFT, EFFECT_AUDIO_STAMP, EFFECT_CHANNEL_COPY, EFFECT_MIX_TO_CHANNEL, EFFECT_RC_LOWPASS_FILTER, ADVANCED_REVERB, EFFECT_DELAY, EFFECT_MULTITAP_DELAY, EFFECT_FAKE_STEREO, EFFECT_REVERB, EFFECT_FLANGER, EFFECT_CHORUS, EFFECT_PHASER, TIME_CROP_GATE, THRESHOLD_GATE, CONTROLLER_SOURCE, FILE_PRESET, GENERIC_CONTROLLER, GENERIC_LINEAR_ENVELOPE, GLOBAL_PRESET, LINEAR_ENVELOPE, MIDI_CONTROLLER, GENERIC_OSCILLATOR_FILE, GENERIC_OSCILLATOR, SINE_OSCILLATOR, PRESET, VOLUME_ANALYZE_CONTROLLER, and TWO_STAGE_LINEAR_ENVELOPE.

void OPERATOR::parameter_description (  int  param, struct PARAM_DESCRIPTION *  pd )  const [virtual]

An optional function for querying parameter descriptions. This is meant primarily for building generic user-interfaces. It's important to note that these values only serve as hints, they are not meant to be absolute. Parameters: param  parameter id Precondition: param > 0 && param <= number_of_params() Reimplemented in EFFECT_AMPLIFY, EFFECT_AMPLIFY_CLIPCOUNT, EFFECT_AMPLIFY_CHANNEL, EFFECT_LIMITER, EFFECT_COMPRESS, EFFECT_NOISEGATE, EFFECT_NORMAL_PAN, EFFECT_VOLUME_BUCKETS, EFFECT_VOLUME_PEAK, EFFECT_DCFIND, EFFECT_LADSPA, EFFECT_DCFIX, EFFECT_PITCH_SHIFT, EFFECT_AUDIO_STAMP, EFFECT_CHANNEL_COPY, EFFECT_MIX_TO_CHANNEL, ADVANCED_REVERB, EFFECT_DELAY, EFFECT_MULTITAP_DELAY, EFFECT_FAKE_STEREO, EFFECT_REVERB, EFFECT_MODULATING_DELAY, and PRESET.

---

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

• eca-operator.h
• eca-operator.cpp

---