soundbuffer.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/System/sharedptr.h"
#include "soundbuffer_session.h"

class CL_ResourceManager;
class CL_SoundOutput;
class CL_SoundProvider;
class CL_SoundBuffer_Session;
class CL_SoundFilter;
class CL_SoundBuffer_Impl;
class CL_IODevice;
class CL_VirtualDirectory;

class CL_API_SOUND CL_SoundBuffer
{

public:

        CL_SoundBuffer();

        CL_SoundBuffer(
                const CL_String &res_id,
                CL_ResourceManager *manager);

        CL_SoundBuffer(
                CL_SoundProvider *provider);

        CL_SoundBuffer(
                const CL_String &fullname,
                bool streamed = false,
                const CL_String &format = cl_text(""));

        CL_SoundBuffer(
                const CL_String &filename,
                bool streamed,
                const CL_VirtualDirectory &directory,
                const CL_String &type = cl_text(""));

        CL_SoundBuffer(
                CL_IODevice &file,
                bool streamed,
                const CL_String &type);

        CL_SoundBuffer(const CL_SoundBuffer &copy);

        virtual ~CL_SoundBuffer();


public:
        CL_SoundProvider *get_provider() const;

        float get_volume() const;

        float get_pan() const;

        bool is_null();


public:


        void set_volume(float new_volume);


        void set_pan(float new_pan);

        void add_filter(CL_SoundFilter &filter);

        void remove_filter(CL_SoundFilter &filter);

        CL_SoundBuffer_Session play(bool looping = false, CL_SoundOutput *output = 0);

        CL_SoundBuffer_Session prepare(bool looping = false, CL_SoundOutput *output = 0);


private:
        CL_SharedPtr<CL_SoundBuffer_Impl> impl;
};

---