soundoutput.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/


#pragma once

#include "api_sound.h"
#include "../Core/Text/string_types.h"
#include "../Core/System/sharedptr.h"
#include "../Core/System/weakptr.h"

class CL_SoundFilter;
class CL_SoundBuffer;
class CL_SoundOutput_Description;
class CL_SoundOutput_Impl;

class CL_API_SOUND CL_SoundOutput
{

public:
        CL_SoundOutput();

        CL_SoundOutput(int mixing_frequency, int latency = 50);

        CL_SoundOutput(const CL_SoundOutput_Description &desc);

        CL_SoundOutput(const CL_SoundOutput &copy);

        virtual ~CL_SoundOutput();


public:
        const CL_String8 &get_name() const;

        int get_mixing_frequency() const;

        int get_mixing_latency() const;

        float get_global_volume() const;

        float get_global_pan() const;


public:
        void stop_all();

        void set_global_volume(float volume);

        void set_global_pan(float pan);

        void add_filter(CL_SoundFilter &filter);

        void remove_filter(CL_SoundFilter &filter);


private:

        CL_SoundOutput(const CL_WeakPtr<CL_SoundOutput_Impl> impl);

        CL_SharedPtr<CL_SoundOutput_Impl> impl;

        friend class CL_SoundBuffer;
        friend class CL_Sound;
        friend class CL_SoundBuffer_Session;
};

---