Sources/API/Sound/sound.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
30 #pragma once
31
32
33 namespace clan
34 {
37
38 class SoundOutput;
39
42 // <p>All the functions that share name with those in SoundOutput have the
43 // same functionality. The only difference is, that the ones Sound
44 // operate on a selected sound output. This saves the trouble of passing around
45 // a pointer to the sound output, when only a single one is used anyway.</p>
46 class Sound
47 {
50
51 public:
53 static const std::string &get_name();
54
56 static int get_mixing_frequency();
57
59 static SoundOutput get_current_output();
60
64 static void select_output(const SoundOutput &output);
66 };
67
68 }
69
clan::Sound
Sound interface in ClanLib.
Definition: Sources/API/Sound/sound.h:46
clan
Definition: clanapp.h:35
clan::Sound::get_mixing_frequency
static int get_mixing_frequency()
Returns the mixing frequency of the current sound output.
clan::SoundOutput
SoundOutput interface in ClanLib.
Definition: soundoutput.h:48
clan::Sound::get_current_output
static SoundOutput get_current_output()
Returns the current selected sound output.
clan::Sound::get_name
static const std::string & get_name()
Returns the name of the current sound output:
clan::StyleTokenType::string
@ keyword
clan::Sound::select_output
static void select_output(const SoundOutput &output)
Change the current selected sound output.