SFML logo
  • Main Page
  • Data Structures
  • Files
  • File List
  • Globals

Music.h

Go to the documentation of this file.
00001 
00002 //
00003 // SFML - Simple and Fast Multimedia Library
00004 // Copyright (C) 2007-2009 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 #include <SFML/Audio/Types.h>
00034 
00035 
00044 CSFML_API sfMusic* sfMusic_CreateFromFile(const char* Filename);
00045 
00055 CSFML_API sfMusic* sfMusic_CreateFromMemory(const char* Data, size_t SizeInBytes);
00056 
00063 CSFML_API void sfMusic_Destroy(sfMusic* Music);
00064 
00072 CSFML_API void sfMusic_SetLoop(sfMusic* Music, sfBool Loop);
00073 
00082 CSFML_API sfBool sfMusic_GetLoop(sfMusic* Music);
00083 
00092 CSFML_API float sfMusic_GetDuration(sfMusic* Music);
00093 
00100 CSFML_API void sfMusic_Play(sfMusic* Music);
00101 
00108 CSFML_API void sfMusic_Pause(sfMusic* Music);
00109 
00116 CSFML_API void sfMusic_Stop(sfMusic* Music);
00117 
00126 CSFML_API unsigned int sfMusic_GetChannelsCount(sfMusic* Music);
00127 
00136 CSFML_API unsigned int sfMusic_GetSampleRate(sfMusic* Music);
00137 
00146 CSFML_API sfSoundStatus sfMusic_GetStatus(sfMusic* Music);
00147 
00156 CSFML_API float sfMusic_GetPlayingOffset(sfMusic* Music);
00157 
00165 CSFML_API void sfMusic_SetPitch(sfMusic* Music, float Pitch);
00166 
00174 CSFML_API void sfMusic_SetVolume(sfMusic* Music, float Volume);
00175 
00185 CSFML_API void sfMusic_SetPosition(sfMusic* Music, float X, float Y, float Z);
00186 
00196 CSFML_API void sfMusic_SetRelativeToListener(sfMusic* Music, sfBool Relative);
00197 
00207 CSFML_API void sfMusic_SetMinDistance(sfMusic* Music, float MinDistance);
00208 
00218 CSFML_API void sfMusic_SetAttenuation(sfMusic* Music, float Attenuation);
00219 
00228 CSFML_API float sfMusic_GetPitch(sfMusic* Music);
00229 
00238 CSFML_API float sfMusic_GetVolume(sfMusic* Music);
00239 
00249 CSFML_API void sfMusic_GetPosition(sfMusic* Music, float* X, float* Y, float* Z);
00250 
00260 CSFML_API sfBool sfMusic_IsRelativeToListener(sfMusic* Music);
00261 
00270 CSFML_API float sfMusic_GetMinDistance(sfMusic* Music);
00271 
00280 CSFML_API float sfMusic_GetAttenuation(sfMusic* Music);
00281 
00282 
00283 #endif // SFML_MUSIC_H

 ::  Copyright © 2007 Laurent Gomila, all rights reserved  ::  Documentation generated by doxygen 1.5.2  ::