ClanLib  2.3.7
soundbuffer_session.h
Go to the documentation of this file.
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2011 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 
31 
32 #pragma once
33 
34 #include "api_sound.h"
35 #include "../Core/System/sharedptr.h"
36 
37 class CL_SoundCard;
38 class CL_SoundFilter;
39 class CL_SoundBuffer;
40 class CL_SoundBuffer_Session_Impl;
41 class CL_SoundOutput;
42 
51 {
54 
55 public:
58 
59  virtual ~CL_SoundBuffer_Session();
60 
64 
65 public:
67  bool is_null() const { return !impl; }
68 
70  void throw_if_null() const;
71 
73  int get_position() const;
74 
80  float get_position_relative() const;
81 
86  int get_length() const;
87 
89  int get_frequency() const;
90 
95  float get_volume() const;
96 
101  float get_pan() const;
102 
106  bool get_looping() const;
107 
109  bool is_playing();
110 
114 
115 public:
120  bool set_position(int new_pos);
121 
130  bool set_position_relative(float new_pos);
131 
137  bool set_end_position(int pos);
138 
142  void set_frequency(int new_freq);
143 
151  void set_volume(float new_volume);
152 
161  void set_pan(float new_pan);
162 
164  void play();
165 
167  void stop();
168 
172  void set_looping(bool loop);
173 
177  void add_filter(CL_SoundFilter &filter);
178 
180  void remove_filter(CL_SoundFilter &filter);
181 
185 
186 private:
187  CL_SoundBuffer_Session(CL_SoundBuffer &soundbuffer, bool looping, CL_SoundOutput &output);
188  CL_SharedPtr<CL_SoundBuffer_Session_Impl> impl;
189 
190  friend class CL_SoundBuffer;
191  friend class CL_SoundOutput_Impl;
193 };
194