admin/CSFML
1
0 Fork 0
mirror of https://github.com/SFML/CSFML.git synced 2026-10-28 13:46:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document MP3 support

Browse Source
This commit is contained in:
Chris Thrasher committed 2023-07-04 14:46:44 -06:00
1 parent 4c15108233
commit 7e2f6d4af8
2 files changed
+7 -7
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

include/SFML/Audio/Music.h
+3 -3
View File
@@ -54,7 +54,7 @@ typedef struct
/// This function doesn't start playing the music (call /// This function doesn't start playing the music (call
/// sfMusic_play to do so). /// sfMusic_play to do so).
/// Here is a complete list of all the supported audio formats: /// Here is a complete list of all the supported audio formats:
/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, /// ogg, wav, flac, mp3, aiff, au, raw, paf, svx, nist, voc, ircam,
/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64. /// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
/// ///
/// \param filename Path of the music file to open /// \param filename Path of the music file to open
@@ -70,7 +70,7 @@ CSFML_AUDIO_API sfMusic* sfMusic_createFromFile(const char* filename);
/// This function doesn't start playing the music (call /// This function doesn't start playing the music (call
/// sfMusic_play to do so). /// sfMusic_play to do so).
/// Here is a complete list of all the supported audio formats: /// Here is a complete list of all the supported audio formats:
/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, /// ogg, wav, flac, mp3, aiff, au, raw, paf, svx, nist, voc, ircam,
/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64. /// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
/// ///
/// \param data Pointer to the file data in memory /// \param data Pointer to the file data in memory
@@ -87,7 +87,7 @@ CSFML_AUDIO_API sfMusic* sfMusic_createFromMemory(const void* data, size_t sizeI
/// This function doesn't start playing the music (call /// This function doesn't start playing the music (call
/// sfMusic_play to do so). /// sfMusic_play to do so).
/// Here is a complete list of all the supported audio formats: /// Here is a complete list of all the supported audio formats:
/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, /// ogg, wav, flac, mp3, aiff, au, raw, paf, svx, nist, voc, ircam,
/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64. /// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
/// ///
/// \param stream Source stream to read from /// \param stream Source stream to read from
include/SFML/Audio/SoundBuffer.h
+4 -4
View File
@@ -39,7 +39,7 @@
/// \brief Create a new sound buffer and load it from a file /// \brief Create a new sound buffer and load it from a file
/// ///
/// Here is a complete list of all the supported audio formats: /// Here is a complete list of all the supported audio formats:
/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, /// ogg, wav, flac, mp3, aiff, au, raw, paf, svx, nist, voc, ircam,
/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64. /// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
/// ///
/// \param filename Path of the sound file to load /// \param filename Path of the sound file to load
@@ -53,7 +53,7 @@ CSFML_AUDIO_API sfSoundBuffer* sfSoundBuffer_createFromFile(const char* filename
/// \brief Create a new sound buffer and load it from a file in memory /// \brief Create a new sound buffer and load it from a file in memory
/// ///
/// Here is a complete list of all the supported audio formats: /// Here is a complete list of all the supported audio formats:
/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, /// ogg, wav, flac, mp3, aiff, au, raw, paf, svx, nist, voc, ircam,
/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64. /// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
/// ///
/// \param data Pointer to the file data in memory /// \param data Pointer to the file data in memory
@@ -68,7 +68,7 @@ CSFML_AUDIO_API sfSoundBuffer* sfSoundBuffer_createFromMemory(const void* data,
/// \brief Create a new sound buffer and load it from a custom stream /// \brief Create a new sound buffer and load it from a custom stream
/// ///
/// Here is a complete list of all the supported audio formats: /// Here is a complete list of all the supported audio formats:
/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, /// ogg, wav, flac, mp3, aiff, au, raw, paf, svx, nist, voc, ircam,
/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64. /// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
/// ///
/// \param stream Source stream to read from /// \param stream Source stream to read from
@@ -116,7 +116,7 @@ CSFML_AUDIO_API void sfSoundBuffer_destroy(sfSoundBuffer* soundBuffer);
/// \brief Save a sound buffer to an audio file /// \brief Save a sound buffer to an audio file
/// ///
/// Here is a complete list of all the supported audio formats: /// Here is a complete list of all the supported audio formats:
/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, /// ogg, wav, flac, mp3, aiff, au, raw, paf, svx, nist, voc, ircam,
/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64. /// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
/// ///
/// \param soundBuffer Sound buffer object /// \param soundBuffer Sound buffer object