CSFML - C binding of the Simple and Fast Multimedia Library

CSFML

- Main Page
- Related Pages
- Classes
- Files

- File List
- File Members

Music.h
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2023 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
44 typedef struct
45{
46 sfTime offset;
47 sfTime length;
48} sfTimeSpan;
49
50
65CSFML_AUDIO_API sfMusic* sfMusic_createFromFile(const char* filename);
66
82CSFML_AUDIO_API sfMusic* sfMusic_createFromMemory(const void* data, size_t sizeInBytes);
83
98CSFML_AUDIO_API sfMusic* sfMusic_createFromStream(sfInputStream* stream);
99
106CSFML_AUDIO_API void sfMusic_destroy(sfMusic* music);
107
120CSFML_AUDIO_API void sfMusic_setLoop(sfMusic* music, sfBool loop);
121
130CSFML_AUDIO_API sfBool sfMusic_getLoop(const sfMusic* music);
131
140CSFML_AUDIO_API sfTime sfMusic_getDuration(const sfMusic* music);
141
157CSFML_AUDIO_API sfTimeSpan sfMusic_getLoopPoints(const sfMusic* music);
158
179CSFML_AUDIO_API void sfMusic_setLoopPoints(sfMusic* music, sfTimeSpan timePoints);
180
193CSFML_AUDIO_API void sfMusic_play(sfMusic* music);
194
204CSFML_AUDIO_API void sfMusic_pause(sfMusic* music);
205
216CSFML_AUDIO_API void sfMusic_stop(sfMusic* music);
217
228CSFML_AUDIO_API unsigned int sfMusic_getChannelCount(const sfMusic* music);
229
241CSFML_AUDIO_API unsigned int sfMusic_getSampleRate(const sfMusic* music);
242
251CSFML_AUDIO_API sfSoundStatus sfMusic_getStatus(const sfMusic* music);
252
261CSFML_AUDIO_API sfTime sfMusic_getPlayingOffset(const sfMusic* music);
262
276CSFML_AUDIO_API void sfMusic_setPitch(sfMusic* music, float pitch);
277
288CSFML_AUDIO_API void sfMusic_setVolume(sfMusic* music, float volume);
289
301CSFML_AUDIO_API void sfMusic_setPosition(sfMusic* music, sfVector3f position);
302
316CSFML_AUDIO_API void sfMusic_setRelativeToListener(sfMusic* music, sfBool relative);
317
332CSFML_AUDIO_API void sfMusic_setMinDistance(sfMusic* music, float distance);
333
350CSFML_AUDIO_API void sfMusic_setAttenuation(sfMusic* music, float attenuation);
351
362CSFML_AUDIO_API void sfMusic_setPlayingOffset(sfMusic* music, sfTime timeOffset);
363
372CSFML_AUDIO_API float sfMusic_getPitch(const sfMusic* music);
373
382CSFML_AUDIO_API float sfMusic_getVolume(const sfMusic* music);
383
392CSFML_AUDIO_API sfVector3f sfMusic_getPosition(const sfMusic* music);
393
403CSFML_AUDIO_API sfBool sfMusic_isRelativeToListener(const sfMusic* music);
404
413CSFML_AUDIO_API float sfMusic_getMinDistance(const sfMusic* music);
414
423CSFML_AUDIO_API float sfMusic_getAttenuation(const sfMusic* music);
424
425
426#endif // SFML_MUSIC_H
sfInputStream
Set of callbacks that allow users to define custom file streams.
Definition InputStream.h:45
sfTimeSpan
Structure defining a time range.
Definition Music.h:45
sfTimeSpan::offset
sfTime offset
The beginning offset of the time range.
Definition Music.h:46
sfTimeSpan::length
sfTime length
The length of the time range.
Definition Music.h:47
sfTime
Represents a time value.
Definition Time.h:39
sfVector3f
3-component vector of floats
Definition Vector3.h:39