Audaspace  1.3.0
A high level audio library.
Effect.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 
28 
33 class AUD_API Effect : public ISound
34 {
35 private:
36  // delete copy constructor and operator=
37  Effect(const Effect&) = delete;
38  Effect& operator=(const Effect&) = delete;
39 
40 protected:
44  std::shared_ptr<ISound> m_sound;
45 
52  inline std::shared_ptr<IReader> getReader() const
53  {
54  return m_sound->createReader();
55  }
56 
57 public:
62  Effect(std::shared_ptr<ISound> sound);
63 
67  virtual ~Effect();
68 
73  std::shared_ptr<ISound> getSound() const;
74 };
75 
#define AUD_NAMESPACE_END
Closes the audaspace namespace aud.
Definition: Audaspace.h:119
#define AUD_NAMESPACE_BEGIN
Opens the audaspace namespace aud.
Definition: Audaspace.h:116
#define AUD_API
Used for exporting symbols in the shared library.
Definition: Audaspace.h:93
The ISound interface.
This sound is a base class for all effect factories that take one other sound as input.
Definition: Effect.h:34
virtual ~Effect()
Destroys the sound.
std::shared_ptr< IReader > getReader() const
Returns the reader created out of the sound.
Definition: Effect.h:52
std::shared_ptr< ISound > m_sound
If there is no reader it is created out of this sound.
Definition: Effect.h:44
std::shared_ptr< ISound > getSound() const
Returns the saved sound.
Effect(std::shared_ptr< ISound > sound)
Creates a new sound.
This class represents a type of sound source and saves the necessary values for it.
Definition: ISound.h:40