Blender V2.61 - r43446
Public Member Functions

AUD_SinusFactory Class Reference

#include <AUD_SinusFactory.h>

Inheritance diagram for AUD_SinusFactory:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 AUD_SinusFactory (float frequency, AUD_SampleRate sampleRate=AUD_RATE_44100)
float getFrequency () const
virtual AUD_Reference
< AUD_IReader
createReader ()

Detailed Description

This factory creates a reader that plays a sine tone.

Definition at line 38 of file AUD_SinusFactory.h.


Constructor & Destructor Documentation

AUD_SinusFactory::AUD_SinusFactory ( float  frequency,
AUD_SampleRate  sampleRate = AUD_RATE_44100 
)

Creates a new sine factory.

Parameters:
frequencyThe desired frequency.
sampleRateThe target sample rate for playback.

Definition at line 34 of file AUD_SinusFactory.cpp.


Member Function Documentation

AUD_Reference< AUD_IReader > AUD_SinusFactory::createReader ( ) [virtual]

Creates a reader for playback of the sound source.

Returns:
A pointer to an AUD_IReader object or NULL if there has been an error.
Exceptions:
AUD_ExceptionAn exception may be thrown if there has been a more unexpected error during reader creation.

Implements AUD_IFactory.

Definition at line 45 of file AUD_SinusFactory.cpp.

float AUD_SinusFactory::getFrequency ( ) const

Returns the frequency of the sine wave.

Definition at line 40 of file AUD_SinusFactory.cpp.


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