soundoutput.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 
30 #pragma once
31 
32 #include "api_sound.h"
33 #include <memory>
34 
35 namespace clan
36 {
39 
40 class SoundFilter;
41 class SoundBuffer;
42 class SoundOutput_Description;
43 class SoundOutput_Impl;
44 
49 class CL_API_SOUND SoundOutput
50 {
53 
54 public:
56  SoundOutput();
57 
62  SoundOutput(int mixing_frequency, int latency = 50);
63 
68 
69  virtual ~SoundOutput();
70 
74 
75 public:
77  bool is_null() const { return !impl; }
78 
80  void throw_if_null() const;
81 
83  const std::string &get_name() const;
84 
86  int get_mixing_frequency() const;
87 
89  int get_mixing_latency() const;
90 
92  float get_global_volume() const;
93 
95  float get_global_pan() const;
96 
100 
101 public:
103  void stop_all();
104 
106  void set_global_volume(float volume);
107 
109  void set_global_pan(float pan);
110 
114  void add_filter(SoundFilter &filter);
115 
117  void remove_filter(SoundFilter &filter);
118 
122 
123 private:
124 
128  SoundOutput(const std::weak_ptr<SoundOutput_Impl> impl);
129 
130  std::shared_ptr<SoundOutput_Impl> impl;
131 
132  friend class SoundBuffer;
133  friend class Sound;
134  friend class SoundBuffer_Session;
136 };
137 
138 }
139 
Sound interface in ClanLib.
Definition: Sources/API/Sound/sound.h:47
SoundBuffer_Session provides control over a playing soundeffect.
Definition: soundbuffer_session.h:52
Sound output description class.
Definition: soundoutput_description.h:43
SoundOutput interface in ClanLib.
Definition: soundoutput.h:49
Sample interface in ClanLib.
Definition: soundbuffer.h:57
Sound Filter Class.
Definition: soundfilter.h:45
bool is_null() const
Returns true if this object is invalid.
Definition: soundoutput.h:77