This sound creates a reader that plays a sine tone. More...

#include <Sine.h>

Inheritance diagram for Sine:

Public Member Functions
	Sine (float frequency, SampleRate sampleRate=RATE_48000)
	Creates a new sine sound.

float	getFrequency () const
	Returns the frequency of the sine wave.

virtual std::shared_ptr< IReader >	createReader ()
	Creates a reader for playback of the sound source.

Public Member Functions inherited from ISound
virtual	~ISound ()
	Destroys the sound.

Detailed Description

This sound creates a reader that plays a sine tone.

Constructor & Destructor Documentation

Sine::Sine	(	float	frequency,
		SampleRate	sampleRate = RATE_48000 )

Creates a new sine sound.

Parameters

frequency	The desired frequency.
sampleRate	The target sample rate for playback.

virtual std::shared_ptr< IReader > Sine::createReader ( )

virtual

Creates a reader for playback of the sound source.

Returns: A pointer to an IReader object or nullptr if there has been an error.

Exceptions

Exception An exception may be thrown if there has been a more unexpected error during reader creation.

Implements ISound.

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