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