audio_definition.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 #pragma once
30 
31 #include "../api_sound.h"
32 #include <memory>
33 
34 namespace clan
35 {
36 
37 class AudioDefinition_Impl;
38 
39 class CL_API_SOUND AudioDefinition
40 {
41 public:
43 
44  bool is_null() const { return !impl; }
45 
46  std::string get_sound_id() const;
47 
48  float get_attenuation_begin() const;
49  float get_attenuation_end() const;
50  float get_volume() const;
51 
52  bool is_looping() const;
53  bool is_ambience() const;
54 
55  void set_sound_id(const std::string &id);
56 
57  void set_attenuation_begin(float distance);
58  void set_attenuation_end(float distance);
59  void set_volume(float volume);
60 
61  void set_looping(bool loop);
62  void set_ambience(bool ambience);
63 
64 private:
65  std::shared_ptr<AudioDefinition_Impl> impl;
66 };
67 
68 }
Definition: audio_definition.h:39
bool is_null() const
Definition: audio_definition.h:44