SoundStream.h
Go to the documentation of this file.
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2015 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_SOUNDSTREAM_H
26 #define SFML_SOUNDSTREAM_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/Time.h>
35 #include <SFML/System/Vector3.h>
36 
37 
42 typedef struct
43 {
45  unsigned int sampleCount;
47 
49 typedef void (*sfSoundStreamSeekCallback)(sfTime, void*);
50 
51 
66  unsigned int channelCount,
67  unsigned int sampleRate,
68  void* userData);
69 
77 
91 
102 
114 
124 
135 CSFML_AUDIO_API unsigned int sfSoundStream_getChannelCount(const sfSoundStream* soundStream);
136 
148 CSFML_AUDIO_API unsigned int sfSoundStream_getSampleRate(const sfSoundStream* soundStream);
149 
163 CSFML_AUDIO_API void sfSoundStream_setPitch(sfSoundStream* soundStream, float pitch);
164 
175 CSFML_AUDIO_API void sfSoundStream_setVolume(sfSoundStream* soundStream, float volume);
176 
189 
204 
219 CSFML_AUDIO_API void sfSoundStream_setMinDistance(sfSoundStream* soundStream, float distance);
220 
237 CSFML_AUDIO_API void sfSoundStream_setAttenuation(sfSoundStream* soundStream, float attenuation);
238 
250 
264 
273 CSFML_AUDIO_API float sfSoundStream_getPitch(const sfSoundStream* soundStream);
274 
283 CSFML_AUDIO_API float sfSoundStream_getVolume(const sfSoundStream* soundStream);
284 
294 
305 
315 
325 
335 
345 
346 
347 #endif // SFML_SOUNDSTREAM_H
3-component vector of floats
Definition: Vector3.h:38
CSFML_AUDIO_API float sfSoundStream_getPitch(const sfSoundStream *soundStream)
Get the pitch of a sound stream.
CSFML_AUDIO_API void sfSoundStream_setLoop(sfSoundStream *soundStream, sfBool loop)
Set whether or not a sound stream should loop after reaching the end.
CSFML_AUDIO_API sfSoundStream * sfSoundStream_create(sfSoundStreamGetDataCallback onGetData, sfSoundStreamSeekCallback onSeek, unsigned int channelCount, unsigned int sampleRate, void *userData)
Create a new sound stream.
CSFML_AUDIO_API void sfSoundStream_setVolume(sfSoundStream *soundStream, float volume)
Set the volume of a sound stream.
CSFML_AUDIO_API unsigned int sfSoundStream_getSampleRate(const sfSoundStream *soundStream)
Get the sample rate of a sound stream.
CSFML_AUDIO_API float sfSoundStream_getAttenuation(const sfSoundStream *soundStream)
Get the attenuation factor of a sound stream.
CSFML_AUDIO_API void sfSoundStream_play(sfSoundStream *soundStream)
Start or resume playing a sound stream.
CSFML_AUDIO_API void sfSoundStream_setPitch(sfSoundStream *soundStream, float pitch)
Set the pitch of a sound stream.
CSFML_AUDIO_API void sfSoundStream_setAttenuation(sfSoundStream *soundStream, float attenuation)
Set the attenuation factor of a sound stream.
signed short sfInt16
Definition: Config.h:171
#define CSFML_AUDIO_API
Definition: Audio/Export.h:43
sfBool(* sfSoundStreamGetDataCallback)(sfSoundStreamChunk *, void *)
Type of the callback used to get a sound stream data.
Definition: SoundStream.h:48
CSFML_AUDIO_API sfBool sfSoundStream_getLoop(const sfSoundStream *soundStream)
Tell whether or not a sound stream is in loop mode.
CSFML_AUDIO_API void sfSoundStream_stop(sfSoundStream *soundStream)
Stop playing a sound stream.
CSFML_AUDIO_API float sfSoundStream_getVolume(const sfSoundStream *soundStream)
Get the volume of a sound stream.
int sfBool
Definition: Config.h:153
CSFML_AUDIO_API sfSoundStatus sfSoundStream_getStatus(const sfSoundStream *soundStream)
Get the current status of a sound stream (stopped, paused, playing)
sfInt16 * samples
Pointer to the audio samples.
Definition: SoundStream.h:44
sfSoundStatus
Enumeration of statuses for sounds and musics.
Definition: SoundStatus.h:38
CSFML_AUDIO_API void sfSoundStream_setMinDistance(sfSoundStream *soundStream, float distance)
Set the minimum distance of a sound stream.
CSFML_AUDIO_API void sfSoundStream_destroy(sfSoundStream *soundStream)
Destroy a sound stream.
Represents a time value.
Definition: Time.h:38
CSFML_AUDIO_API sfBool sfSoundStream_isRelativeToListener(const sfSoundStream *soundStream)
Tell whether a sound stream&#39;s position is relative to the listener or is absolute.
CSFML_AUDIO_API void sfSoundStream_pause(sfSoundStream *soundStream)
Pause a sound stream.
CSFML_AUDIO_API void sfSoundStream_setRelativeToListener(sfSoundStream *soundStream, sfBool relative)
Make a sound stream&#39;s position relative to the listener or absolute.
CSFML_AUDIO_API unsigned int sfSoundStream_getChannelCount(const sfSoundStream *soundStream)
Return the number of channels of a sound stream.
defines the data to fill by the OnGetData callback
Definition: SoundStream.h:42
void(* sfSoundStreamSeekCallback)(sfTime, void *)
Type of the callback used to seek in a sound stream.
Definition: SoundStream.h:49
CSFML_AUDIO_API void sfSoundStream_setPosition(sfSoundStream *soundStream, sfVector3f position)
Set the 3D position of a sound stream in the audio scene.
CSFML_AUDIO_API void sfSoundStream_setPlayingOffset(sfSoundStream *soundStream, sfTime timeOffset)
Change the current playing position of a sound stream.
unsigned int sampleCount
Number of samples pointed by Samples.
Definition: SoundStream.h:45
CSFML_AUDIO_API float sfSoundStream_getMinDistance(const sfSoundStream *soundStream)
Get the minimum distance of a sound stream.
CSFML_AUDIO_API sfTime sfSoundStream_getPlayingOffset(const sfSoundStream *soundStream)
Get the current playing position of a sound stream.
struct sfSoundStream sfSoundStream
Definition: Audio/Types.h:34
CSFML_AUDIO_API sfVector3f sfSoundStream_getPosition(const sfSoundStream *soundStream)
Get the 3D position of a sound stream in the audio scene.