Music.h
Go to the documentation of this file.
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>
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 
88 
96 
109 CSFML_AUDIO_API void sfMusic_setLoop(sfMusic* music, sfBool loop);
110 
120 
130 
144 
155 
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 
202 
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 //
252 
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 
343 
354 
364 
374 
375 
376 #endif // SFML_MUSIC_H
3-component vector of floats
Definition: Vector3.h:38
CSFML_AUDIO_API float sfMusic_getMinDistance(const sfMusic *music)
Get the minimum distance of a music.
CSFML_AUDIO_API sfMusic * sfMusic_createFromMemory(const void *data, size_t sizeInBytes)
Create a new music and load it from a file in memory.
CSFML_AUDIO_API void sfMusic_setLoop(sfMusic *music, sfBool loop)
Set whether or not a music should loop after reaching the end.
CSFML_AUDIO_API sfTime sfMusic_getPlayingOffset(const sfMusic *music)
Get the current playing position of a music.
CSFML_AUDIO_API unsigned int sfMusic_getSampleRate(const sfMusic *music)
Get the sample rate of a music.
CSFML_AUDIO_API void sfMusic_setMinDistance(sfMusic *music, float distance)
Set the minimum distance of a music.
CSFML_AUDIO_API sfBool sfMusic_isRelativeToListener(const sfMusic *music)
Tell whether a music&#39;s position is relative to the listener or is absolute.
CSFML_AUDIO_API void sfMusic_stop(sfMusic *music)
Stop playing a music.
CSFML_AUDIO_API sfMusic * sfMusic_createFromFile(const char *filename)
Create a new music and load it from a file.
Set of callbacks that allow users to define custom file streams.
Definition: InputStream.h:44
#define CSFML_AUDIO_API
Definition: Audio/Export.h:43
CSFML_AUDIO_API sfSoundStatus sfMusic_getStatus(const sfMusic *music)
Get the current status of a music (stopped, paused, playing)
CSFML_AUDIO_API void sfMusic_setAttenuation(sfMusic *music, float attenuation)
Set the attenuation factor of a music.
int sfBool
Definition: Config.h:153
CSFML_AUDIO_API sfVector3f sfMusic_getPosition(const sfMusic *music)
Get the 3D position of a music in the audio scene.
sfSoundStatus
Enumeration of statuses for sounds and musics.
Definition: SoundStatus.h:38
CSFML_AUDIO_API float sfMusic_getAttenuation(const sfMusic *music)
Get the attenuation factor of a music.
CSFML_AUDIO_API void sfMusic_setPlayingOffset(sfMusic *music, sfTime timeOffset)
Change the current playing position of a music.
Represents a time value.
Definition: Time.h:38
CSFML_AUDIO_API void sfMusic_setPitch(sfMusic *music, float pitch)
Set the pitch of a music.
CSFML_AUDIO_API void sfMusic_setRelativeToListener(sfMusic *music, sfBool relative)
Make a musics&#39;s position relative to the listener or absolute.
CSFML_AUDIO_API float sfMusic_getVolume(const sfMusic *music)
Get the volume of a music.
CSFML_AUDIO_API sfTime sfMusic_getDuration(const sfMusic *music)
Get the total duration of a music.
struct sfMusic sfMusic
Definition: Audio/Types.h:29
CSFML_AUDIO_API void sfMusic_play(sfMusic *music)
Start or resume playing a music.
CSFML_AUDIO_API void sfMusic_destroy(sfMusic *music)
Destroy a music.
CSFML_AUDIO_API void sfMusic_pause(sfMusic *music)
Pause a music.
CSFML_AUDIO_API unsigned int sfMusic_getChannelCount(const sfMusic *music)
Return the number of channels of a music.
CSFML_AUDIO_API void sfMusic_setVolume(sfMusic *music, float volume)
Set the volume of a music.
CSFML_AUDIO_API float sfMusic_getPitch(const sfMusic *music)
Get the pitch of a music.
CSFML_AUDIO_API sfMusic * sfMusic_createFromStream(sfInputStream *stream)
Create a new music and load it from a custom stream.
CSFML_AUDIO_API void sfMusic_setPosition(sfMusic *music, sfVector3f position)
Set the 3D position of a music in the audio scene.
CSFML_AUDIO_API sfBool sfMusic_getLoop(const sfMusic *music)
Tell whether or not a music is in loop mode.