CSFML 3.0.0
Loading...
Searching...
No Matches
Music.h
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2026 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#pragma once
26
28// Headers
30#include <CSFML/Audio/Export.h>
31
32#include <CSFML/Audio/EffectProcessor.h>
33#include <CSFML/Audio/SoundChannel.h>
34#include <CSFML/Audio/SoundSourceCone.h>
35#include <CSFML/Audio/SoundStatus.h>
36#include <CSFML/Audio/Types.h>
37#include <CSFML/System/InputStream.h>
38#include <CSFML/System/Time.h>
39#include <CSFML/System/Vector3.h>
40
41#include <stddef.h>
42
43
48 typedef struct
49{
50 sfTime offset;
51 sfTime length;
52} sfTimeSpan;
53
54
69 CSFML_AUDIO_API sfMusic* sfMusic_createFromFile(const char* filename);
70
86 CSFML_AUDIO_API sfMusic* sfMusic_createFromMemory(const void* data, size_t sizeInBytes);
87
102 CSFML_AUDIO_API sfMusic* sfMusic_createFromStream(sfInputStream* stream);
103
110 CSFML_AUDIO_API void sfMusic_destroy(const sfMusic* music);
111
124 CSFML_AUDIO_API void sfMusic_setLooping(sfMusic* music, bool loop);
125
134 CSFML_AUDIO_API bool sfMusic_isLooping(const sfMusic* music);
135
146 CSFML_AUDIO_API void sfMusic_setEffectProcessor(sfMusic* music, sfEffectProcessor effectProcessor);
147
156 CSFML_AUDIO_API sfTime sfMusic_getDuration(const sfMusic* music);
157
175 CSFML_AUDIO_API sfTimeSpan sfMusic_getLoopPoints(const sfMusic* music);
176
198 CSFML_AUDIO_API void sfMusic_setLoopPoints(sfMusic* music, sfTimeSpan timePoints);
199
212 CSFML_AUDIO_API void sfMusic_play(sfMusic* music);
213
223 CSFML_AUDIO_API void sfMusic_pause(sfMusic* music);
224
235 CSFML_AUDIO_API void sfMusic_stop(sfMusic* music);
236
247 CSFML_AUDIO_API unsigned int sfMusic_getChannelCount(const sfMusic* music);
248
260 CSFML_AUDIO_API unsigned int sfMusic_getSampleRate(const sfMusic* music);
261
274 CSFML_AUDIO_API const sfSoundChannel* sfMusic_getChannelMap(const sfMusic* music, size_t* count);
275
284 CSFML_AUDIO_API sfSoundStatus sfMusic_getStatus(const sfMusic* music);
285
294 CSFML_AUDIO_API sfTime sfMusic_getPlayingOffset(const sfMusic* music);
295
309 CSFML_AUDIO_API void sfMusic_setPitch(sfMusic* music, float pitch);
310
323 CSFML_AUDIO_API void sfMusic_setPan(sfMusic* music, float pan);
324
335 CSFML_AUDIO_API void sfMusic_setVolume(sfMusic* music, float volume);
336
349 CSFML_AUDIO_API void sfMusic_setSpatializationEnabled(sfMusic* music, bool enabled);
350
362 CSFML_AUDIO_API void sfMusic_setPosition(sfMusic* music, sfVector3f position);
363
376 CSFML_AUDIO_API void sfMusic_setDirection(sfMusic* music, sfVector3f direction);
377
388 CSFML_AUDIO_API void sfMusic_setCone(sfMusic* music, sfSoundSourceCone cone);
389
402 CSFML_AUDIO_API void sfMusic_setVelocity(sfMusic* music, sfVector3f velocity);
403
414 CSFML_AUDIO_API void sfMusic_setDopplerFactor(sfMusic* music, float factor);
415
430 CSFML_AUDIO_API void sfMusic_setDirectionalAttenuationFactor(sfMusic* music, float factor);
431
445 CSFML_AUDIO_API void sfMusic_setRelativeToListener(sfMusic* music, bool relative);
446
461 CSFML_AUDIO_API void sfMusic_setMinDistance(sfMusic* music, float distance);
462
477 CSFML_AUDIO_API void sfMusic_setMaxDistance(sfMusic* music, float distance);
478
490 CSFML_AUDIO_API void sfMusic_setMinGain(sfMusic* music, float gain);
491
503 CSFML_AUDIO_API void sfMusic_setMaxGain(sfMusic* music, float gain);
504
521 CSFML_AUDIO_API void sfMusic_setAttenuation(sfMusic* music, float attenuation);
522
533 CSFML_AUDIO_API void sfMusic_setPlayingOffset(sfMusic* music, sfTime timeOffset);
534
543 CSFML_AUDIO_API float sfMusic_getPitch(const sfMusic* music);
544
553 CSFML_AUDIO_API float sfMusic_getPan(const sfMusic* music);
554
563 CSFML_AUDIO_API bool sfMusic_isSpatializationEnabled(const sfMusic* music);
564
573 CSFML_AUDIO_API float sfMusic_getVolume(const sfMusic* music);
574
583 CSFML_AUDIO_API sfVector3f sfMusic_getPosition(const sfMusic* music);
584
593 CSFML_AUDIO_API sfVector3f sfMusic_getDirection(const sfMusic* music);
594
603 CSFML_AUDIO_API sfSoundSourceCone sfMusic_getCone(const sfMusic* music);
604
613 CSFML_AUDIO_API sfVector3f sfMusic_getVelocity(const sfMusic* music);
614
623 CSFML_AUDIO_API float sfMusic_getDopplerFactor(const sfMusic* music);
624
633 CSFML_AUDIO_API float sfMusic_getDirectionalAttenuationFactor(const sfMusic* music);
634
644 CSFML_AUDIO_API bool sfMusic_isRelativeToListener(const sfMusic* music);
645
654 CSFML_AUDIO_API float sfMusic_getMinDistance(const sfMusic* music);
655
664 CSFML_AUDIO_API float sfMusic_getMaxDistance(const sfMusic* music);
665
674 CSFML_AUDIO_API float sfMusic_getMinGain(const sfMusic* music);
675
684 CSFML_AUDIO_API float sfMusic_getMaxGain(const sfMusic* music);
685
694 CSFML_AUDIO_API float sfMusic_getAttenuation(const sfMusic* music);
Export.h
CSFML_AUDIO_API
#define CSFML_AUDIO_API
Definition Audio/Export.h:42
Types.h
sfMusic
struct sfMusic sfMusic
Definition Audio/Types.h:27
EffectProcessor.h
sfEffectProcessor
void(* sfEffectProcessor)(const float *inputFrames, unsigned int *inputFrameCount, float *outputFrames, unsigned int *outputFrameCount, unsigned int frameChannelCount)
Callable that is provided with sound data for processing.
Definition EffectProcessor.h:102
InputStream.h
sfMusic_getStatus
sfSoundStatus sfMusic_getStatus(const sfMusic *music)
Get the current status of a music (stopped, paused, playing).
sfMusic_getPlayingOffset
sfTime sfMusic_getPlayingOffset(const sfMusic *music)
Get the current playing position of a music.
sfMusic_createFromStream
sfMusic * sfMusic_createFromStream(sfInputStream *stream)
Create a new music and load it from a custom stream.
sfMusic_setCone
void sfMusic_setCone(sfMusic *music, sfSoundSourceCone cone)
Set the cone properties of the sound in the audio scene.
sfMusic_getChannelMap
const sfSoundChannel * sfMusic_getChannelMap(const sfMusic *music, size_t *count)
Get the map of position in sample frame to sound channel.
sfMusic_getDirection
sfVector3f sfMusic_getDirection(const sfMusic *music)
Get the 3D direction of the sound in the audio scene.
sfMusic_getPosition
sfVector3f sfMusic_getPosition(const sfMusic *music)
Get the 3D position of a music in the audio scene.
sfMusic_setMaxGain
void sfMusic_setMaxGain(sfMusic *music, float gain)
Set the maximum gain of the sound.
sfMusic_setPlayingOffset
void sfMusic_setPlayingOffset(sfMusic *music, sfTime timeOffset)
Change the current playing position of a music.
sfMusic_getVolume
float sfMusic_getVolume(const sfMusic *music)
Get the volume of a music.
sfMusic_getChannelCount
unsigned int sfMusic_getChannelCount(const sfMusic *music)
Return the number of channels of a music.
sfMusic_getCone
sfSoundSourceCone sfMusic_getCone(const sfMusic *music)
Get the cone properties of the sound in the audio scene.
sfMusic_setLooping
void sfMusic_setLooping(sfMusic *music, bool loop)
Set whether or not a music should loop after reaching the end.
sfMusic_createFromMemory
sfMusic * sfMusic_createFromMemory(const void *data, size_t sizeInBytes)
Create a new music and load it from a file in memory.
sfMusic_getDopplerFactor
float sfMusic_getDopplerFactor(const sfMusic *music)
Get the doppler factor of the sound.
sfMusic_isLooping
bool sfMusic_isLooping(const sfMusic *music)
Tell whether or not a music is in loop mode.
sfMusic_setDirectionalAttenuationFactor
void sfMusic_setDirectionalAttenuationFactor(sfMusic *music, float factor)
Set the directional attenuation factor of the sound.
sfMusic_setAttenuation
void sfMusic_setAttenuation(sfMusic *music, float attenuation)
Set the attenuation factor of a music.
sfMusic_setLoopPoints
void sfMusic_setLoopPoints(sfMusic *music, sfTimeSpan timePoints)
Sets the beginning and end of the sound's looping sequence using sfTime.
sfMusic_isRelativeToListener
bool sfMusic_isRelativeToListener(const sfMusic *music)
Tell whether a music's position is relative to the listener or is absolute.
sfMusic_destroy
void sfMusic_destroy(const sfMusic *music)
Destroy a music.
sfMusic_setEffectProcessor
void sfMusic_setEffectProcessor(sfMusic *music, sfEffectProcessor effectProcessor)
Set the effect processor to be applied to the sound.
sfMusic_setRelativeToListener
void sfMusic_setRelativeToListener(sfMusic *music, bool relative)
Make a musics's position relative to the listener or absolute.
sfMusic_getAttenuation
float sfMusic_getAttenuation(const sfMusic *music)
Get the attenuation factor of a music.
sfMusic_createFromFile
sfMusic * sfMusic_createFromFile(const char *filename)
Create a new music and load it from a file.
sfMusic_setDirection
void sfMusic_setDirection(sfMusic *music, sfVector3f direction)
Set the 3D direction of the sound in the audio scene.
sfMusic_setPosition
void sfMusic_setPosition(sfMusic *music, sfVector3f position)
Set the 3D position of a music in the audio scene.
sfMusic_getVelocity
sfVector3f sfMusic_getVelocity(const sfMusic *music)
Get the 3D velocity of the sound in the audio scene.
sfMusic_getLoopPoints
sfTimeSpan sfMusic_getLoopPoints(const sfMusic *music)
Get the positions of the of the sound's looping sequence.
sfMusic_getMaxDistance
float sfMusic_getMaxDistance(const sfMusic *music)
Get the maximum distance of the sound.
sfMusic_setMinDistance
void sfMusic_setMinDistance(sfMusic *music, float distance)
Set the minimum distance of a music.
sfMusic_getMinGain
float sfMusic_getMinGain(const sfMusic *music)
Get the minimum gain of the sound.
sfMusic_getDuration
sfTime sfMusic_getDuration(const sfMusic *music)
Get the total duration of a music.
sfMusic_setDopplerFactor
void sfMusic_setDopplerFactor(sfMusic *music, float factor)
Set the doppler factor of the sound.
sfMusic_pause
void sfMusic_pause(sfMusic *music)
Pause a music.
sfMusic_getPan
float sfMusic_getPan(const sfMusic *music)
Get the pan of the sound.
sfMusic_stop
void sfMusic_stop(sfMusic *music)
Stop playing a music.
sfMusic_setVelocity
void sfMusic_setVelocity(sfMusic *music, sfVector3f velocity)
Set the 3D velocity of the sound in the audio scene.
sfMusic_getSampleRate
unsigned int sfMusic_getSampleRate(const sfMusic *music)
Get the sample rate of a music.
sfMusic_getMaxGain
float sfMusic_getMaxGain(const sfMusic *music)
Get the maximum gain of the sound.
sfMusic_setMaxDistance
void sfMusic_setMaxDistance(sfMusic *music, float distance)
Set the maximum distance of the sound.
sfMusic_getPitch
float sfMusic_getPitch(const sfMusic *music)
Get the pitch of a music.
sfMusic_play
void sfMusic_play(sfMusic *music)
Start or resume playing a music.
sfMusic_setSpatializationEnabled
void sfMusic_setSpatializationEnabled(sfMusic *music, bool enabled)
Set whether spatialization of the sound is enabled.
sfMusic_setMinGain
void sfMusic_setMinGain(sfMusic *music, float gain)
Set the minimum gain of the sound.
sfMusic_setVolume
void sfMusic_setVolume(sfMusic *music, float volume)
Set the volume of a music.
sfMusic_getMinDistance
float sfMusic_getMinDistance(const sfMusic *music)
Get the minimum distance of a music.
sfMusic_setPan
void sfMusic_setPan(sfMusic *music, float pan)
Set the pan of the sound.
sfMusic_getDirectionalAttenuationFactor
float sfMusic_getDirectionalAttenuationFactor(const sfMusic *music)
Get the directional attenuation factor of the sound.
sfMusic_setPitch
void sfMusic_setPitch(sfMusic *music, float pitch)
Set the pitch of a music.
sfMusic_isSpatializationEnabled
bool sfMusic_isSpatializationEnabled(const sfMusic *music)
Tell whether spatialization of the sound is enabled.
SoundChannel.h
sfSoundChannel
sfSoundChannel
Types of sound channels that can be read/written from sound buffers/files.
Definition SoundChannel.h:39
SoundSourceCone.h
SoundStatus.h
sfSoundStatus
sfSoundStatus
Enumeration of statuses for sounds and musics.
Definition SoundStatus.h:38
Time.h
Vector3.h
sfInputStream
Set of callbacks that allow users to define custom file streams.
Definition InputStream.h:46
sfSoundSourceCone
Structure defining the properties of a directional cone.
Definition SoundSourceCone.h:39
sfTimeSpan
Structure defining a time range.
Definition Music.h:49
sfTimeSpan::offset
sfTime offset
The beginning offset of the time range.
Definition Music.h:50
sfTimeSpan::length
sfTime length
The length of the time range.
Definition Music.h:51
sfTime
Represents a time value.
Definition Time.h:38
sfVector3f
3-component vector of floats
Definition Vector3.h:38