soundbuffer_session.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"

class CL_SoundCard;
class CL_SoundFilter;
class CL_SoundBuffer;
class CL_SoundBuffer_Session_Impl;
class CL_SoundOutput;

class CL_API_SOUND CL_SoundBuffer_Session
{

public:
        CL_SoundBuffer_Session();

        CL_SoundBuffer_Session(const CL_SoundBuffer_Session &copy);

        virtual ~CL_SoundBuffer_Session();


public:
        int get_position() const;


        float get_position_relative() const;


        int get_length() const;

        int get_frequency() const;


        float get_volume() const;


        float get_pan() const;

        bool get_looping() const;

        bool is_playing();


public:

        bool set_position(int new_pos);


        bool set_position_relative(float new_pos);

        void set_frequency(int new_freq);


        void set_volume(float new_volume);


        void set_pan(float new_pan);

        void play();

        void stop();

        void set_looping(bool loop);

        void add_filter(CL_SoundFilter &filter);

        void remove_filter(CL_SoundFilter &filter);


private:
        CL_SoundBuffer_Session(CL_SoundBuffer &soundbuffer, bool looping, CL_SoundOutput &output);
        CL_SharedPtr<CL_SoundBuffer_Session_Impl> impl;

        friend class CL_SoundBuffer;
        friend class CL_SoundOutput_Impl;
};

---