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