audiobox-doc  2.4.3.28
 All Classes Files Functions Variables
Public Member Functions | List of all members
AL::Generator Class Reference

#include <generator.hpp>

Public Member Functions

void start ()
 
void stop ()
 
void abort ()
 
void setFrequency (float freq)
 
float getFrequency () const
 
void setType (enum generatorType type)
 
enum generatorType getType () const
 
void setVolume (float volume)
 
float getVolume () const
 
void setVolumePercent (float volume)
 
float getVolumePercent () const
 
void setBalance (float balance)
 
float getBalance () const
 

Detailed Description

Simple sinus generator at a specific frequency.

Member Function Documentation

float AL::Generator::getBalance ( ) const

Get the current Balance of the Track.

Returns
Balance value -1..1.
float AL::Generator::getFrequency ( ) const

Get the signal frequency.

Returns
current frequency.
enum generatorType AL::Generator::getType ( ) const

Get the signal type.

Returns
current type generated.
float AL::Generator::getVolume ( ) const

Get the current playing volume in dB.

Returns
Volume value [-121..0]
float AL::Generator::getVolumePercent ( ) const

Get the current playing volume in %.

Returns
Volume value [0..100]
void AL::Generator::setBalance ( float  balance)

Set the current Balance of the Playing file.

Parameters
[in]balanceBalance value -1..1.
Exceptions
std::runtime_errorif out of range
void AL::Generator::setFrequency ( float  freq)

Set the signal frequency.

Parameters
[in]freqNew frequency to set [10..24k]
Exceptions
std::runtime_errorif out of range
void AL::Generator::setType ( enum generatorType  type)

Set the signal type.

Parameters
[in]typeNew type to set.
Exceptions
std::runtime_errorif out of range
void AL::Generator::setVolume ( float  volume)

Set the current volume of the player in dB.

Parameters
[in]volumeVolume to set [-121..0]
Exceptions
std::runtime_errorif out of range
void AL::Generator::setVolumePercent ( float  volume)

Set the current volume of the player in %.

Parameters
[in]volumeVolume to set [0..100]
Exceptions
std::runtime_errorif out of range

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