Async  0.18.0
Public Member Functions | Protected Member Functions
Async::AudioClipper Class Reference

An audio pipe class to clip audio to a given maximum level. More...

#include <AsyncAudioClipper.h>

Inheritance diagram for Async::AudioClipper:
Async::AudioProcessor Async::AudioSink Async::AudioSource

List of all members.

Public Member Functions

Protected Member Functions


Detailed Description

An audio pipe class to clip audio to a given maximum level.

Author:
Tobias Blomberg / SM0SVX
Date:
2005-08-01

This is an audio pipe class that is used to clip an audio stream to a given maximum level.


Constructor & Destructor Documentation

Async::AudioClipper::AudioClipper ( float  clip_level = 1.0) [inline, explicit]

Default constuctor.

Parameters:
clip_levelThe level to clip at (1.0 is default)

Definition at line 120 of file AsyncAudioClipper.h.

Async::AudioClipper::~AudioClipper ( void  ) [inline]

Destructor.

Definition at line 125 of file AsyncAudioClipper.h.


Member Function Documentation

virtual void Async::AudioClipper::processSamples ( float *  dest,
const float *  src,
int  count 
) [inline, protected, virtual]

Process incoming samples and put them into the output buffer.

Parameters:
destDestination buffer
srcSource buffer
countNumber of samples in the source buffer

This function should be reimplemented by the inheriting class to do the actual processing of the incoming samples. All samples must be processed, otherwise they are lost and the output buffer will contain garbage.

Implements Async::AudioProcessor.

Definition at line 135 of file AsyncAudioClipper.h.

void Async::AudioClipper::setClipLevel ( float  level) [inline]

Set the clip level.

Parameters:
levelThe level to set

Definition at line 131 of file AsyncAudioClipper.h.


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