Audaspace  1.3.0
A high level audio library.
SoundList.h
Go to the documentation of this file.
1 /*******************************************************************************
2 * Copyright 2015-2016 Juan Francisco Crespo Galán
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 
27 #include <vector>
28 #include <memory>
29 #include <mutex>
30 
32 
36 class AUD_API SoundList : public ISound
37 {
38 private:
42  std::vector<std::shared_ptr<ISound>> m_list;
43 
47  bool m_random = false;
48 
52  int m_index = -1;
53 
57  std::recursive_mutex m_mutex;
58 
59  // delete copy constructor and operator=
60  SoundList(const SoundList&) = delete;
61  SoundList& operator=(const SoundList&) = delete;
62 
63 public:
69  SoundList(bool random = false);
70 
76  SoundList(std::vector<std::shared_ptr<ISound>>& list, bool random = false);
77 
78  virtual std::shared_ptr<IReader> createReader();
79 
86  void addSound(std::shared_ptr<ISound> sound);
87 
93  void setRandomMode(bool random);
94 
101 
106  int getSize();
107 
108 };
109 
#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 class represents a type of sound source and saves the necessary values for it.
Definition: ISound.h:40
This class allows to have a list of sound that will play sequentially or randomly with each playback.
Definition: SoundList.h:37
SoundList(std::vector< std::shared_ptr< ISound >> &list, bool random=false)
Creates a new sound list and initializes it.
void setRandomMode(bool random)
Sets the playback mode of the sound list.
virtual std::shared_ptr< IReader > createReader()
Creates a reader for playback of the sound source.
bool getRandomMode()
Returns the playback mode of the sound list.
void addSound(std::shared_ptr< ISound > sound)
Adds a sound to the list.
int getSize()
Returns the amount of sounds in the list.
SoundList(bool random=false)
Creates a new, empty sound list.