audio_definition.h Source File - ClanLib SDK
Description: audio_definition.h Source File

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