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-2024 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
36#include <CSFML/Audio/Types.h>
38#include <CSFML/System/Time.h>
40
41#include <stddef.h>
42
43
48typedef struct
49{
53
54
70
86CSFML_AUDIO_API sfMusic* sfMusic_createFromMemory(const void* data, size_t sizeInBytes);
87
103
111
125
135
147
157
176
199
213
224
236
248
261
275
285
295
309CSFML_AUDIO_API void sfMusic_setPitch(sfMusic* music, float pitch);
310
323CSFML_AUDIO_API void sfMusic_setPan(sfMusic* music, float pan);
324
335CSFML_AUDIO_API void sfMusic_setVolume(sfMusic* music, float volume);
336
350
363
377
389
403
415
431
446
461CSFML_AUDIO_API void sfMusic_setMinDistance(sfMusic* music, float distance);
462
477CSFML_AUDIO_API void sfMusic_setMaxDistance(sfMusic* music, float distance);
478
491
504
521CSFML_AUDIO_API void sfMusic_setAttenuation(sfMusic* music, float attenuation);
522
534
544
554
564
574
584
594
604
614
624
634
645
655
665
675
685
#define CSFML_AUDIO_API
struct sfMusic sfMusic
Definition Audio/Types.h:27
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.
sfSoundStatus sfMusic_getStatus(const sfMusic *music)
Get the current status of a music (stopped, paused, playing)
sfTime sfMusic_getPlayingOffset(const sfMusic *music)
Get the current playing position of a music.
sfMusic * sfMusic_createFromStream(sfInputStream *stream)
Create a new music and load it from a custom stream.
void sfMusic_setCone(sfMusic *music, sfSoundSourceCone cone)
Set the cone properties of the sound in the audio scene.
const sfSoundChannel * sfMusic_getChannelMap(const sfMusic *music, size_t *count)
Get the map of position in sample frame to sound channel.
sfVector3f sfMusic_getDirection(const sfMusic *music)
Get the 3D direction of the sound in the audio scene.
sfVector3f sfMusic_getPosition(const sfMusic *music)
Get the 3D position of a music in the audio scene.
void sfMusic_setMaxGain(sfMusic *music, float gain)
Set the maximum gain of the sound.
void sfMusic_setPlayingOffset(sfMusic *music, sfTime timeOffset)
Change the current playing position of a music.
float sfMusic_getVolume(const sfMusic *music)
Get the volume of a music.
unsigned int sfMusic_getChannelCount(const sfMusic *music)
Return the number of channels of a music.
sfSoundSourceCone sfMusic_getCone(const sfMusic *music)
Get the cone properties of the sound in the audio scene.
void sfMusic_setLooping(sfMusic *music, bool loop)
Set whether or not a music should loop after reaching the end.
sfMusic * sfMusic_createFromMemory(const void *data, size_t sizeInBytes)
Create a new music and load it from a file in memory.
float sfMusic_getDopplerFactor(const sfMusic *music)
Get the doppler factor of the sound.
bool sfMusic_isLooping(const sfMusic *music)
Tell whether or not a music is in loop mode.
void sfMusic_setDirectionalAttenuationFactor(sfMusic *music, float factor)
Set the directional attenuation factor of the sound.
void sfMusic_setAttenuation(sfMusic *music, float attenuation)
Set the attenuation factor of a music.
void sfMusic_setLoopPoints(sfMusic *music, sfTimeSpan timePoints)
Sets the beginning and end of the sound's looping sequence using sfTime.
bool sfMusic_isRelativeToListener(const sfMusic *music)
Tell whether a music's position is relative to the listener or is absolute.
void sfMusic_destroy(const sfMusic *music)
Destroy a music.
void sfMusic_setEffectProcessor(sfMusic *music, sfEffectProcessor effectProcessor)
Set the effect processor to be applied to the sound.
void sfMusic_setRelativeToListener(sfMusic *music, bool relative)
Make a musics's position relative to the listener or absolute.
float sfMusic_getAttenuation(const sfMusic *music)
Get the attenuation factor of a music.
sfMusic * sfMusic_createFromFile(const char *filename)
Create a new music and load it from a file.
void sfMusic_setDirection(sfMusic *music, sfVector3f direction)
Set the 3D direction of the sound in the audio scene.
void sfMusic_setPosition(sfMusic *music, sfVector3f position)
Set the 3D position of a music in the audio scene.
sfVector3f sfMusic_getVelocity(const sfMusic *music)
Get the 3D velocity of the sound in the audio scene.
sfTimeSpan sfMusic_getLoopPoints(const sfMusic *music)
Get the positions of the of the sound's looping sequence.
float sfMusic_getMaxDistance(const sfMusic *music)
Get the maximum distance of the sound.
void sfMusic_setMinDistance(sfMusic *music, float distance)
Set the minimum distance of a music.
float sfMusic_getMinGain(const sfMusic *music)
Get the minimum gain of the sound.
sfTime sfMusic_getDuration(const sfMusic *music)
Get the total duration of a music.
void sfMusic_setDopplerFactor(sfMusic *music, float factor)
Set the doppler factor of the sound.
void sfMusic_pause(sfMusic *music)
Pause a music.
float sfMusic_getPan(const sfMusic *music)
Get the pan of the sound.
void sfMusic_stop(sfMusic *music)
Stop playing a music.
void sfMusic_setVelocity(sfMusic *music, sfVector3f velocity)
Set the 3D velocity of the sound in the audio scene.
unsigned int sfMusic_getSampleRate(const sfMusic *music)
Get the sample rate of a music.
float sfMusic_getMaxGain(const sfMusic *music)
Get the maximum gain of the sound.
void sfMusic_setMaxDistance(sfMusic *music, float distance)
Set the maximum distance of the sound.
float sfMusic_getPitch(const sfMusic *music)
Get the pitch of a music.
void sfMusic_play(sfMusic *music)
Start or resume playing a music.
void sfMusic_setSpatializationEnabled(sfMusic *music, bool enabled)
Set whether spatialization of the sound is enabled.
void sfMusic_setMinGain(sfMusic *music, float gain)
Set the minimum gain of the sound.
void sfMusic_setVolume(sfMusic *music, float volume)
Set the volume of a music.
float sfMusic_getMinDistance(const sfMusic *music)
Get the minimum distance of a music.
void sfMusic_setPan(sfMusic *music, float pan)
Set the pan of the sound.
float sfMusic_getDirectionalAttenuationFactor(const sfMusic *music)
Get the directional attenuation factor of the sound.
void sfMusic_setPitch(sfMusic *music, float pitch)
Set the pitch of a music.
bool sfMusic_isSpatializationEnabled(const sfMusic *music)
Tell whether spatialization of the sound is enabled.
sfSoundChannel
Types of sound channels that can be read/written from sound buffers/files.
sfSoundStatus
Enumeration of statuses for sounds and musics.
Definition SoundStatus.h:38
Set of callbacks that allow users to define custom file streams.
Definition InputStream.h:46
Structure defining the properties of a directional cone.
Structure defining a time range.
Definition Music.h:49
sfTime offset
The beginning offset of the time range.
Definition Music.h:50
sfTime length
The length of the time range.
Definition Music.h:51
Represents a time value.
Definition Time.h:38
3-component vector of floats
Definition Vector3.h:38