Music.h
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef SFML_MUSIC_H
26 #define SFML_MUSIC_H
27 
29 // Headers
31 #include <SFML/Audio/Export.h>
32 #include <SFML/Audio/SoundStatus.h>
33 #include <SFML/Audio/Types.h>
34 #include <SFML/System/InputStream.h>
35 #include <SFML/System/Time.h>
36 #include <SFML/System/Vector3.h>
37 #include <stddef.h>
38 
39 
54 CSFML_AUDIO_API sfMusic* sfMusic_createFromFile(const char* filename);
55 
71 CSFML_AUDIO_API sfMusic* sfMusic_createFromMemory(const void* data, size_t sizeInBytes);
72 
87 CSFML_AUDIO_API sfMusic* sfMusic_createFromStream(sfInputStream* stream);
88 
95 CSFML_AUDIO_API void sfMusic_destroy(sfMusic* music);
96 
109 CSFML_AUDIO_API void sfMusic_setLoop(sfMusic* music, sfBool loop);
110 
119 CSFML_AUDIO_API sfBool sfMusic_getLoop(const sfMusic* music);
120 
129 CSFML_AUDIO_API sfTime sfMusic_getDuration(const sfMusic* music);
130 
143 CSFML_AUDIO_API void sfMusic_play(sfMusic* music);
144 
154 CSFML_AUDIO_API void sfMusic_pause(sfMusic* music);
155 
166 CSFML_AUDIO_API void sfMusic_stop(sfMusic* music);
167 
178 CSFML_AUDIO_API unsigned int sfMusic_getChannelCount(const sfMusic* music);
179 
191 CSFML_AUDIO_API unsigned int sfMusic_getSampleRate(const sfMusic* music);
192 
201 CSFML_AUDIO_API sfSoundStatus sfMusic_getStatus(const sfMusic* music);
202 
211 CSFML_AUDIO_API sfTime sfMusic_getPlayingOffset(const sfMusic* music);
212 
226 CSFML_AUDIO_API void sfMusic_setPitch(sfMusic* music, float pitch);
227 
238 CSFML_AUDIO_API void sfMusic_setVolume(sfMusic* music, float volume);
239 
249 //
251 CSFML_AUDIO_API void sfMusic_setPosition(sfMusic* music, sfVector3f position);
252 
266 CSFML_AUDIO_API void sfMusic_setRelativeToListener(sfMusic* music, sfBool relative);
267 
282 CSFML_AUDIO_API void sfMusic_setMinDistance(sfMusic* music, float distance);
283 
300 CSFML_AUDIO_API void sfMusic_setAttenuation(sfMusic* music, float attenuation);
301 
312 CSFML_AUDIO_API void sfMusic_setPlayingOffset(sfMusic* music, sfTime timeOffset);
313 
322 CSFML_AUDIO_API float sfMusic_getPitch(const sfMusic* music);
323 
332 CSFML_AUDIO_API float sfMusic_getVolume(const sfMusic* music);
333 
342 CSFML_AUDIO_API sfVector3f sfMusic_getPosition(const sfMusic* music);
343 
353 CSFML_AUDIO_API sfBool sfMusic_isRelativeToListener(const sfMusic* music);
354 
363 CSFML_AUDIO_API float sfMusic_getMinDistance(const sfMusic* music);
364 
373 CSFML_AUDIO_API float sfMusic_getAttenuation(const sfMusic* music);
374 
375 
376 #endif // SFML_MUSIC_H
Represents a time value.
Definition: Time.h:38
3-component vector of floats
Definition: Vector3.h:38
Set of callbacks that allow users to define custom file streams.
Definition: InputStream.h:44