arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
ConverterScaler< T > Class Template Reference

Multiplies the values with the indicated factor adds the offset and clips at maxValue. To mute use a factor of 0.0! More...

#include <BaseConverter.h>

Inheritance diagram for ConverterScaler< T >:
BaseConverter

Public Member Functions

 ConverterScaler (float factor, T offset, T maxValue, int channels=2)
 
size_t convert (uint8_t *src, size_t byte_count)
 
float factor ()
 Determines the actual factor (volume)
 
T offset ()
 Determines the offset value.
 
void setFactor (float factor)
 Defines the factor (volume)
 
void setOffset (T offset)
 Defines the offset.
 

Protected Attributes

int channels
 
float factor_value
 
T maxValue
 
T offset_value
 

Detailed Description

template<typename T = int16_t>
class audio_tools::ConverterScaler< T >

Multiplies the values with the indicated factor adds the offset and clips at maxValue. To mute use a factor of 0.0!

Author
Phil Schatzmann
Template Parameters
T

Constructor & Destructor Documentation

◆ ConverterScaler()

template<typename T = int16_t>
ConverterScaler ( float  factor,
T  offset,
T  maxValue,
int  channels = 2 
)
inline

Member Function Documentation

◆ convert()

template<typename T = int16_t>
size_t convert ( uint8_t src,
size_t  byte_count 
)
inlinevirtual

Implements BaseConverter.

◆ factor()

template<typename T = int16_t>
float factor ( )
inline

Determines the actual factor (volume)

◆ offset()

template<typename T = int16_t>
T offset ( )
inline

Determines the offset value.

◆ setFactor()

template<typename T = int16_t>
void setFactor ( float  factor)
inline

Defines the factor (volume)

◆ setOffset()

template<typename T = int16_t>
void setOffset ( T  offset)
inline

Defines the offset.

Member Data Documentation

◆ channels

template<typename T = int16_t>
int channels
protected

◆ factor_value

template<typename T = int16_t>
float factor_value
protected

◆ maxValue

template<typename T = int16_t>
T maxValue
protected

◆ offset_value

template<typename T = int16_t>
T offset_value
protected

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