Music.h

Go to the documentation of this file.

 
//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef SFML_MUSIC_H
#define SFML_MUSIC_H
 
// Headers
#include <SFML/Audio/Export.h>
#include <SFML/Audio/SoundStatus.h>
#include <SFML/Audio/Types.h>
#include <SFML/System/InputStream.h>
#include <SFML/System/Time.h>
#include <SFML/System/Vector3.h>
#include <stddef.h>
 
 
typedef struct
{
    sfTime offset; 
    sfTime length; 
} sfTimeSpan;
 
 
CSFML_AUDIO_API sfMusic* sfMusic_createFromFile(const char* filename);
 
CSFML_AUDIO_API sfMusic* sfMusic_createFromMemory(const void* data, size_t sizeInBytes);
 
CSFML_AUDIO_API sfMusic* sfMusic_createFromStream(sfInputStream* stream);
 
CSFML_AUDIO_API void sfMusic_destroy(sfMusic* music);
 
CSFML_AUDIO_API void sfMusic_setLoop(sfMusic* music, sfBool loop);
 
CSFML_AUDIO_API sfBool sfMusic_getLoop(const sfMusic* music);
 
CSFML_AUDIO_API sfTime sfMusic_getDuration(const sfMusic* music);
 
CSFML_AUDIO_API sfTimeSpan sfMusic_getLoopPoints(const sfMusic* music);
 
CSFML_AUDIO_API void sfMusic_setLoopPoints(sfMusic* music, sfTimeSpan timePoints);
 
CSFML_AUDIO_API void sfMusic_play(sfMusic* music);
 
CSFML_AUDIO_API void sfMusic_pause(sfMusic* music);
 
CSFML_AUDIO_API void sfMusic_stop(sfMusic* music);
 
CSFML_AUDIO_API unsigned int sfMusic_getChannelCount(const sfMusic* music);
 
CSFML_AUDIO_API unsigned int sfMusic_getSampleRate(const sfMusic* music);
 
CSFML_AUDIO_API sfSoundStatus sfMusic_getStatus(const sfMusic* music);
 
CSFML_AUDIO_API sfTime sfMusic_getPlayingOffset(const sfMusic* music);
 
CSFML_AUDIO_API void sfMusic_setPitch(sfMusic* music, float pitch);
 
CSFML_AUDIO_API void sfMusic_setVolume(sfMusic* music, float volume);
 
CSFML_AUDIO_API void sfMusic_setPosition(sfMusic* music, sfVector3f position);
 
CSFML_AUDIO_API void sfMusic_setRelativeToListener(sfMusic* music, sfBool relative);
 
CSFML_AUDIO_API void sfMusic_setMinDistance(sfMusic* music, float distance);
 
CSFML_AUDIO_API void sfMusic_setAttenuation(sfMusic* music, float attenuation);
 
CSFML_AUDIO_API void sfMusic_setPlayingOffset(sfMusic* music, sfTime timeOffset);
 
CSFML_AUDIO_API float sfMusic_getPitch(const sfMusic* music);
 
CSFML_AUDIO_API float sfMusic_getVolume(const sfMusic* music);
 
CSFML_AUDIO_API sfVector3f sfMusic_getPosition(const sfMusic* music);
 
CSFML_AUDIO_API sfBool sfMusic_isRelativeToListener(const sfMusic* music);
 
CSFML_AUDIO_API float sfMusic_getMinDistance(const sfMusic* music);
 
CSFML_AUDIO_API float sfMusic_getAttenuation(const sfMusic* music);
 
 
#endif // SFML_MUSIC_H