soundbuffer_session.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 SoundCard;
41 class SoundFilter;
42 class SoundBuffer;
43 class SoundBuffer_Session_Impl;
44 class SoundOutput;
45 
52 class CL_API_SOUND SoundBuffer_Session
53 {
56 
57 public:
60 
61  virtual ~SoundBuffer_Session();
62 
66 
67 public:
69  bool is_null() const { return !impl; }
70 
72  void throw_if_null() const;
73 
75  int get_position() const;
76 
82  float get_position_relative() const;
83 
88  int get_length() const;
89 
91  int get_frequency() const;
92 
97  float get_volume() const;
98 
103  float get_pan() const;
104 
108  bool get_looping() const;
109 
111  bool is_playing();
112 
116 
117 public:
122  bool set_position(int new_pos);
123 
132  bool set_position_relative(float new_pos);
133 
139  bool set_end_position(int pos);
140 
144  void set_frequency(int new_freq);
145 
153  void set_volume(float new_volume);
154 
163  void set_pan(float new_pan);
164 
166  void play();
167 
169  void stop();
170 
174  void set_looping(bool loop);
175 
179  void add_filter(SoundFilter &filter);
180 
182  void remove_filter(SoundFilter &filter);
183 
187 
188 private:
189  SoundBuffer_Session(SoundBuffer &soundbuffer, bool looping, SoundOutput &output);
190  std::shared_ptr<SoundBuffer_Session_Impl> impl;
191 
192  friend class SoundBuffer;
193  friend class SoundOutput_Impl;
195 };
196 
197 }
198 
bool is_null() const
Returns true if this object is invalid.
Definition: soundbuffer_session.h:69
SoundBuffer_Session provides control over a playing soundeffect.
Definition: soundbuffer_session.h:52
SoundOutput interface in ClanLib.
Definition: soundoutput.h:49
Sample interface in ClanLib.
Definition: soundbuffer.h:57
Sound Filter Class.
Definition: soundfilter.h:45