Sound/sound.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Magnus Norddahl
00027 */
00028 
00031 
00032 #pragma once
00033 
00034 #include "api_sound.h"
00035 #include "../Core/Text/string_types.h"
00036 
00037 class CL_SoundOutput;
00038 
00041 //    <p>All the functions that share name with those in CL_SoundOutput have the
00042 //    same functionality. The only difference is, that the ones CL_Sound
00043 //    operate on a selected sound output. This saves the trouble of passing around
00044 //    a pointer to the sound output, when only a single one is used anyway.</p>
00046 class CL_API_SOUND CL_Sound
00047 {
00050 
00051 public:
00053         static const CL_String8 &get_name();
00054 
00056         static int get_mixing_frequency();
00057 
00059         static CL_SoundOutput get_current_output();
00060 
00064         static void select_output(const CL_SoundOutput &output);
00066 };
00067