soundprovider_session.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/System/sharedptr.h"
00036 #include "../soundformat.h"
00037 
00038 class CL_SoundProvider_Session_Impl;
00039 
00044 class CL_API_SOUND CL_SoundProvider_Session
00045 {
00048 
00049 public:
00050         CL_SoundProvider_Session();
00051 
00052         virtual ~CL_SoundProvider_Session();
00053 
00057 
00058 public:
00060         virtual int get_num_samples() const = 0;
00061 
00063 
00064         virtual int get_frequency() const = 0;
00065 
00067         virtual int get_position() const = 0;
00068 
00070         virtual int get_num_channels() const = 0;
00071 
00075 
00076 public:
00078 
00080         virtual bool set_looping(bool loop) { return false; }
00081 
00083 
00084         virtual bool eof() const = 0;
00085 
00087         virtual void stop() = 0;
00088 
00090 
00091         virtual bool play() = 0;
00092 
00098         virtual bool set_position(int pos) = 0;
00099 
00105         virtual bool set_end_position(int pos) = 0;
00106 
00112         virtual int get_data(float **data_ptr, int data_requested) = 0;
00113 
00117 
00118 private:
00119 
00121 };
00122