Sound.h

Go to the documentation of this file.
00001 
00002 //
00003 // SFML - Simple and Fast Multimedia Library
00004 // Copyright (C) 2007-2008 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_SOUND_H
00026 #define SFML_SOUND_H
00027 
00029 // Headers
00031 #include <SFML/Config.h>
00032 #include <SFML/Audio/SoundBuffer.h>
00033 #include <SFML/Audio/SoundStatus.h>
00034 
00035 
00040 typedef struct sfSound sfSound;
00041 
00042 
00049 CSFML_API sfSound* sfSound_Create();
00050 
00057 CSFML_API void sfSound_Destroy(sfSound* Sound);
00058 
00065 CSFML_API void sfSound_Play(sfSound* Sound);
00066 
00073 CSFML_API void sfSound_Pause(sfSound* Sound);
00074 
00081 CSFML_API void sfSound_Stop(sfSound* Sound);
00082 
00090 CSFML_API void sfSound_SetBuffer(sfSound* Sound, sfSoundBuffer* Buffer);
00091 
00100 CSFML_API sfSoundBuffer* sfSound_GetBuffer(sfSound* Sound);
00101 
00109 CSFML_API void sfSound_SetLoop(sfSound* Sound, sfBool Loop);
00110 
00119 CSFML_API sfBool sfSound_GetLoop(sfSound* Sound);
00120 
00129 CSFML_API sfSoundStatus sfSound_GetStatus(sfSound* Sound);
00130 
00138 CSFML_API void sfSound_SetPitch(sfSound* Sound, float Pitch);
00139 
00147 CSFML_API void sfSound_SetVolume(sfSound* Sound, float Volume);
00148 
00158 CSFML_API void sfSound_SetPosition(sfSound* Sound, float X, float Y, float Z);
00159 
00169 CSFML_API void sfSound_SetMinDistance(sfSound* Sound, float MinDistance);
00170 
00180 CSFML_API void sfSound_SetAttenuation(sfSound* Sound, float Attenuation);
00181 
00189 CSFML_API void sfSound_SetPlayingOffset(sfSound* Sound, float TimeOffset);
00190 
00199 CSFML_API float sfSound_GetPitch(sfSound* Sound);
00200 
00209 CSFML_API float sfSound_GetVolume(sfSound* Sound);
00210 
00220 CSFML_API void sfSound_GetPosition(sfSound* Sound, float* X, float* Y, float* Z);
00221 
00230 CSFML_API float sfSound_GetMinDistance(sfSound* Sound);
00231 
00240 CSFML_API float sfSound_GetAttenuation(sfSound* Sound);
00241 
00250 CSFML_API float sfSound_GetPlayingOffset(sfSound* Sound);
00251 
00252 
00253 #endif // SFML_SOUND_H