SoundStream.h

Go to the documentation of this file.
00001 
00002 //
00003 // SFML - Simple and Fast Multimedia Library
00004 // Copyright (C) 2007 Laurent Gomila (laurent.gom@gmail.com)
00005 //
00006 // This software is provided 'as-is', without any express or implied warranty.
00007 // In no event will the authors be held liable for any damages 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 freely,
00011 // subject to the following restrictions:
00012 //
00013 // 1. The origin of this software must not be misrepresented;
00014 //    you must not claim that you wrote the original software.
00015 //    If you use this software in a product, an acknowledgment
00016 //    in the product documentation would be appreciated but is not required.
00017 //
00018 // 2. Altered source versions must be plainly marked as such,
00019 //    and must not be misrepresented as being the original software.
00020 //
00021 // 3. This notice may not be removed or altered from any source distribution.
00022 //
00024 
00025 #ifndef SFML_SOUNDSTREAM_H
00026 #define SFML_SOUNDSTREAM_H
00027 
00029 // Headers
00031 #include <SFML/Config.h>
00032 #include <SFML/Audio/SoundStatus.h>
00033 
00034 
00041 typedef struct sfSoundStream sfSoundStream;
00042 
00047 typedef struct
00048 {
00049     sfInt16*     Samples;   
00050     unsigned int NbSamples; 
00051 } sfSoundStreamChunk;
00052 
00053 typedef sfBool (*sfSoundStreamStartCallback)(void*);                        
00054 typedef sfBool (*sfSoundStreamGetDataCallback)(sfSoundStreamChunk*, void*); 
00055 
00056 
00069 CSFML_API sfSoundStream* sfSoundStream_Create(sfSoundStreamStartCallback   OnStart,
00070                                               sfSoundStreamGetDataCallback OnGetData,
00071                                               unsigned int                 ChannelsCount,
00072                                               unsigned int                 SampleRate,
00073                                               void*                        UserData);
00074 
00081 CSFML_API void sfSoundStream_Destroy(sfSoundStream* SoundStreamStream);
00082 
00089 CSFML_API void sfSoundStream_Play(sfSoundStream* SoundStream);
00090 
00097 CSFML_API void sfSoundStream_Pause(sfSoundStream* SoundStream);
00098 
00105 CSFML_API void sfSoundStream_Stop(sfSoundStream* SoundStream);
00106 
00115 CSFML_API sfSoundStatus sfSoundStream_GetStatus(sfSoundStream* SoundStream);
00116 
00126 CSFML_API unsigned int sfSoundStream_GetChannelsCount(sfSoundStream* SoundStream);
00127 
00136 CSFML_API unsigned int sfSoundStream_GetSampleRate(sfSoundStream* SoundStream);
00137 
00145 CSFML_API void sfSoundStream_SetPitch(sfSoundStream* SoundStream, float Pitch);
00146 
00154 CSFML_API void sfSoundStream_SetVolume(sfSoundStream* SoundStream, float Volume);
00155 
00165 CSFML_API void sfSoundStream_SetPosition(sfSoundStream* SoundStream, float X, float Y, float Z);
00166 
00176 CSFML_API void sfSoundStream_SetMinDistance(sfSoundStream* SoundStream, float MinDistance);
00177 
00187 CSFML_API void sfSoundStream_SetAttenuation(sfSoundStream* SoundStream, float Attenuation);
00188 
00197 CSFML_API float sfSoundStream_GetPitch(sfSoundStream* SoundStream);
00198 
00207 CSFML_API float sfSoundStream_GetVolume(sfSoundStream* SoundStream);
00208 
00218 CSFML_API void sfSoundStream_GetPosition(sfSoundStream* SoundStream, float* X, float* Y, float* Z);
00219 
00228 CSFML_API float sfSoundStream_GetMinDistance(sfSoundStream* SoundStream);
00229 
00238 CSFML_API float sfSoundStream_GetAttenuation(sfSoundStream* SoundStream);
00239 
00240 
00241 #endif // SFML_SOUNDSTREAM_H