AuxPort 0.2
Modules for Audio Software Development
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
AuxPort::Audio::Oscillator Class Reference

Inheritable function that provides common functions for all Digital Oscillators. More...

#include <AuxOscillator.h>

Inheritance diagram for AuxPort::Audio::Oscillator:
AuxPort::Audio::BipolarSawtooth AuxPort::Audio::KPString AuxPort::Audio::PBSaw AuxPort::Audio::PBWSaw AuxPort::Audio::Sine AuxPort::Audio::Square AuxPort::Audio::Triangle AuxPort::Audio::UnipolarSawtooth AuxPort::Audio::WhiteNoise

Public Member Functions

 Oscillator (const Oscillator &osc)=default
 
virtual void setSampleRate (uint32_t sampleRate)
 Use this function to set the sample rate of the oscillator [Overridable].
 
virtual void setFrequency (float frequency)
 Use this function to set the frequency of the oscillator [Overridable].
 
virtual float process ()
 This function generates the sample from the Oscillator [Overridable].
 
virtual void stop ()
 Use this function to stop the Oscillator from generating samples [Overridable].
 
virtual bool isPlaying ()
 Checks whether the Oscillator is still generating samples [Overridable].
 

Protected Attributes

uint32_t sampleRate = 44100
 
float frequency = 100
 
float sample = 0
 
float mod = 0
 
float inc = 0
 

Detailed Description

Inheritable function that provides common functions for all Digital Oscillators.

Definition at line 16 of file AuxOscillator.h.

Member Function Documentation

◆ isPlaying()

bool AuxPort::Audio::Oscillator::isPlaying ( )
virtual

Checks whether the Oscillator is still generating samples [Overridable].

Definition at line 24 of file AuxOscillator.cpp.

◆ process()

float AuxPort::Audio::Oscillator::process ( )
virtual

This function generates the sample from the Oscillator [Overridable].

Reimplemented in AuxPort::Audio::BipolarSawtooth, AuxPort::Audio::KPString, AuxPort::Audio::PBSaw, AuxPort::Audio::PBWSaw, AuxPort::Audio::Sine, AuxPort::Audio::Square, AuxPort::Audio::Triangle, AuxPort::Audio::UnipolarSawtooth, and AuxPort::Audio::WhiteNoise.

Definition at line 14 of file AuxOscillator.cpp.

◆ setFrequency()

void AuxPort::Audio::Oscillator::setFrequency ( float frequency)
virtual

Use this function to set the frequency of the oscillator [Overridable].

Reimplemented in AuxPort::Audio::KPString.

Definition at line 8 of file AuxOscillator.cpp.

◆ setSampleRate()

void AuxPort::Audio::Oscillator::setSampleRate ( uint32_t sampleRate)
virtual

Use this function to set the sample rate of the oscillator [Overridable].

Reimplemented in AuxPort::Audio::KPString.

Definition at line 3 of file AuxOscillator.cpp.

◆ stop()

void AuxPort::Audio::Oscillator::stop ( )
virtual

Use this function to stop the Oscillator from generating samples [Overridable].

Definition at line 19 of file AuxOscillator.cpp.

Member Data Documentation

◆ frequency

float AuxPort::Audio::Oscillator::frequency = 100
protected

Definition at line 49 of file AuxOscillator.h.

◆ inc

float AuxPort::Audio::Oscillator::inc = 0
protected

Definition at line 52 of file AuxOscillator.h.

◆ mod

float AuxPort::Audio::Oscillator::mod = 0
protected

Definition at line 51 of file AuxOscillator.h.

◆ sample

float AuxPort::Audio::Oscillator::sample = 0
protected

Definition at line 50 of file AuxOscillator.h.

◆ sampleRate

uint32_t AuxPort::Audio::Oscillator::sampleRate = 44100
protected

Definition at line 48 of file AuxOscillator.h.

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