Audaspace  1.3.0
A high level audio library.
Volume.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 "fx/Effect.h"
26 
28 
34 class AUD_API Volume : public Effect
35 {
36 private:
40  const float m_volume;
41 
42  // delete copy constructor and operator=
43  Volume(const Volume&) = delete;
44  Volume& operator=(const Volume&) = delete;
45 
46 public:
52  Volume(std::shared_ptr<ISound> sound, float volume);
53 
58  float getVolume() const;
59 
60  virtual std::shared_ptr<IReader> createReader();
61 };
62 
Volume::getVolume
float getVolume() const
Returns the volume.
Volume::Volume
Volume(std::shared_ptr< ISound > sound, float volume)
Creates a new volume sound.
Volume
This sound changes the volume of another sound.
Definition: Volume.h:35
Volume::createReader
virtual std::shared_ptr< IReader > createReader()
Creates a reader for playback of the sound source.
AUD_NAMESPACE_END
#define AUD_NAMESPACE_END
Closes the audaspace namespace aud.
Definition: Audaspace.h:119
Effect.h
The Effect class.
Effect
This sound is a base class for all effect factories that take one other sound as input.
Definition: Effect.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