Audaspace  1.3.0
A high level audio library.
Square.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright 2009-2016 Jörg Müller
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  ******************************************************************************/
16 
17 #pragma once
18 
25 #include "ISound.h"
26 #include "respec/Specification.h"
27 
29 
33 class AUD_API Square : public ISound
34 {
35 private:
39  const float m_frequency;
40 
44  const SampleRate m_sampleRate;
45 
46  // delete copy constructor and operator=
47  Square(const Square&) = delete;
48  Square& operator=(const Square&) = delete;
49 
50 public:
56  Square(float frequency,
57  SampleRate sampleRate = RATE_48000);
58 
62  float getFrequency() const;
63 
64  virtual std::shared_ptr<IReader> createReader();
65 };
66 
SampleRate
double SampleRate
Sample rate type.
Definition: Specification.h:106
ISound.h
The ISound interface.
Square::Square
Square(float frequency, SampleRate sampleRate=RATE_48000)
Creates a new square sound.
ISound
This class represents a type of sound source and saves the necessary values for it.
Definition: ISound.h:40
Square::createReader
virtual std::shared_ptr< IReader > createReader()
Creates a reader for playback of the sound source.
Square::getFrequency
float getFrequency() const
Returns the frequency of the square wave.
RATE_48000
@ RATE_48000
44100 Hz.
Definition: Specification.h:99
Specification.h
Defines all important macros and basic data structures for stream format descriptions.
AUD_NAMESPACE_END
#define AUD_NAMESPACE_END
Closes the audaspace namespace aud.
Definition: Audaspace.h:119
Square
This sound creates a reader that plays a square tone.
Definition: Square.h:34
AUD_NAMESPACE_BEGIN
#define AUD_NAMESPACE_BEGIN
Opens the audaspace namespace aud.
Definition: Audaspace.h:116
AUD_API
#define AUD_API
Used for exporting symbols in the shared library.
Definition: Audaspace.h:93