- sfPtr
sfSoundStream* sfPtr;
Undocumented in source.
- ~this
~this()
Undocumented in source.
- initialize
void initialize(uint channelCount, uint sampleRate)
Undocumented in source. Be warned that the author may not have intended to support it.
- pitch
float pitch [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
- pitch
float pitch [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
- volume
float volume [@property setter]
- volume
float volume [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
- position
Vector3f position [@property setter]
The 3D position of the sound in the audio scene.
- position
Vector3f position [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
- isLooping
bool isLooping [@property setter]
Whether or not the stream should loop after reaching the end.
- isLooping
bool isLooping [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
- playingOffset
Time playingOffset [@property setter]
The current playing position (from the beginning) of the stream.
- playingOffset
Time playingOffset [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
- relativeToListener
bool relativeToListener [@property setter]
Make the sound's position relative to the listener (true) or absolute (false).
- relativeToListener
bool relativeToListener [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
- minDistance
float minDistance [@property setter]
The minimum distance of the sound.
- minDistance
float minDistance [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
- attenuation
float attenuation [@property setter]
The attenuation factor of the sound.
- attenuation
float attenuation [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
- channelCount
uint channelCount [@property getter]
The number of channels of the stream.
- sampleRate
uint sampleRate [@property getter]
The stream sample rate of the stream
- status
Status status [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
- play
void play()
Undocumented in source. Be warned that the author may not have intended to support it.
- pause
void pause()
Undocumented in source. Be warned that the author may not have intended to support it.
- stop
void stop()
Undocumented in source. Be warned that the author may not have intended to support it.
- onGetData
bool onGetData(const(short)[] samples)
Undocumented in source.
- onSeek
void onSeek(Time timeOffset)
Undocumented in source.
Streamed music played from an audio file.
Musics are sounds that are streamed rather than completely loaded in memory.
This is especially useful for compressed musics that usually take hundreds of MB when they are uncompressed: by streaming it instead of loading it entirely, you avoid saturating the memory and have almost no loading delay.
Apart from that, a Music has almost the same features as the SoundBuffer / Sound pair: you can play/pause/stop it, request its parameters (channels, sample rate), change the way it is played (pitch, volume, 3D position, ...), etc.
As a sound stream, a music is played in its own thread in order not to block the rest of the program. This means that you can leave the music alone after calling play(), it will manage itself very well.