audio_object.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 <string>
33 #include "audio_definition.h"
34 #include "../../Core/Math/vec3.h"
35 
36 namespace clan
37 {
38 
39 class SoundBuffer;
40 class AudioWorld;
41 class AudioObject_Impl;
42 
43 class CL_API_SOUND AudioObject
44 {
45 public:
46  AudioObject();
47  AudioObject(AudioWorld &world);
48  AudioObject(AudioWorld &world, AudioDefinition definition);
49 
50  bool is_null() const { return !impl; }
51 
52  Vec3f get_position() const;
53 
54  float get_attenuation_begin() const;
55  float get_attenuation_end() const;
56  float get_volume() const;
57  bool is_looping() const;
58  bool is_ambience() const;
59  bool is_playing() const;
60 
61  void set_position(const Vec3f &position);
62 
63  void set_attenuation_begin(float distance);
64  void set_attenuation_end(float distance);
65  void set_volume(float volume);
66 
67  void set_sound(const std::string &id);
68  void set_sound(const SoundBuffer &buffer);
69 
70  void set_looping(bool loop);
71  void set_ambience(bool ambience);
72 
73  void play();
74  void stop();
75 
76 private:
77  std::shared_ptr<AudioObject_Impl> impl;
78 
79  friend class AudioWorld;
80  friend class AudioWorld_Impl;
81 };
82 
83 }
Definition: audio_world.h:43
Definition: audio_object.h:43
Definition: audio_definition.h:39
Sample interface in ClanLib.
Definition: soundbuffer.h:57
bool is_null() const
Definition: audio_object.h:50