ClanLib  2.3.7
soundbuffer.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 #include "soundbuffer_session.h"
37 
38 class CL_ResourceManager;
39 class CL_SoundOutput;
40 class CL_SoundProvider;
42 class CL_SoundFilter;
43 class CL_SoundBuffer_Impl;
44 class CL_IODevice;
46 
54 {
57 
58 public:
61 
63 
77  const CL_String &res_id,
78  CL_ResourceManager *manager);
79 
81  CL_SoundProvider *provider);
82 
84  const CL_String &fullname,
85  bool streamed = false,
86  const CL_String &format = "");
87 
89  const CL_String &filename,
90  bool streamed,
91  const CL_VirtualDirectory &directory,
92  const CL_String &type = "");
93 
95  CL_IODevice &file,
96  bool streamed,
97  const CL_String &type);
98 
99  virtual ~CL_SoundBuffer();
100 
104 
105 public:
107  CL_SoundProvider *get_provider() const;
108 
110  float get_volume() const;
111 
113  float get_pan() const;
114 
116  bool is_null() const { return !impl; }
117 
119  void throw_if_null() const;
120 
124 
125 public:
126 
128 
131  void set_volume(float new_volume);
132 
134 
138  void set_pan(float new_pan);
139 
143  void add_filter(CL_SoundFilter &filter);
144 
146  void remove_filter(CL_SoundFilter &filter);
147 
154  CL_SoundBuffer_Session play(bool looping = false, CL_SoundOutput *output = 0);
155 
161  CL_SoundBuffer_Session prepare(bool looping = false, CL_SoundOutput *output = 0);
162 
166 
167 private:
168  CL_SharedPtr<CL_SoundBuffer_Impl> impl;
170 };
171