Music.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_MUSIC_H
00026 #define SFML_MUSIC_H
00027 
00029 // Headers
00031 #include <SFML/Config.h>
00032 #include <SFML/Audio/SoundStatus.h>
00033 
00034 
00039 typedef struct sfMusic sfMusic;
00040 
00041 
00050 CSFML_API sfMusic* sfMusic_CreateFromFile(const char* Filename);
00051 
00061 CSFML_API sfMusic* sfMusic_CreateFromMemory(const char* Data, size_t SizeInBytes);
00062 
00069 CSFML_API void sfMusic_Destroy(sfMusic* Music);
00070 
00078 CSFML_API void sfMusic_SetLoop(sfMusic* Music, sfBool Loop);
00079 
00088 CSFML_API sfBool sfMusic_GetLoop(sfMusic* Music);
00089 
00098 CSFML_API float sfMusic_GetDuration(sfMusic* Music);
00099 
00106 CSFML_API void sfMusic_Play(sfMusic* Music);
00107 
00114 CSFML_API void sfMusic_Pause(sfMusic* Music);
00115 
00122 CSFML_API void sfMusic_Stop(sfMusic* Music);
00123 
00132 CSFML_API unsigned int sfMusic_GetChannelsCount(sfMusic* Music);
00133 
00142 CSFML_API unsigned int sfMusic_GetSampleRate(sfMusic* Music);
00143 
00152 CSFML_API sfSoundStatus sfMusic_GetStatus(sfMusic* Music);
00153 
00161 CSFML_API void sfMusic_SetPitch(sfMusic* Music, float Pitch);
00162 
00170 CSFML_API void sfMusic_SetVolume(sfMusic* Music, float Volume);
00171 
00181 CSFML_API void sfMusic_SetPosition(sfMusic* Music, float X, float Y, float Z);
00182 
00191 CSFML_API float sfMusic_GetPitch(sfMusic* Music);
00192 
00201 CSFML_API float sfMusic_GetVolume(sfMusic* Music);
00202 
00212 CSFML_API void sfMusic_GetPosition(sfMusic* Music, float* X, float* Y, float* Z);
00213 
00214 
00215 #endif // SFML_MUSIC_H