FIFE
2008.0
|
#include <soundemitter.h>
Public Member Functions | |
uint32_t | getId () const |
void | setPositioning (bool relative) |
void | setRolloff (float rolloff) |
void | setSoundClip (SoundClipPtr soundclip) |
SoundClipPtr | getSoundClip () |
void | setCallback (const type_callback &cb) |
void | reset (bool defaultall=false) |
void | release () |
void | setLooping (bool loop) |
void | play () |
void | stop () |
void | pause () |
void | setGain (float gain) |
float | getGain () |
bool | isStereo () |
int16_t | getBitResolution () |
uint64_t | getSampleRate () |
uint64_t | getDecodedLength () |
uint64_t | getDuration () |
void | setCursor (SoundPositionType type, float value) |
float | getCursor (SoundPositionType type) |
void | setPosition (float x, float y, float z) |
void | setVelocity (float x, float y, float z) |
The class for playing audio files
Definition at line 46 of file soundemitter.h.
|
inline |
Returns the bit resolution
Definition at line 155 of file soundemitter.h.
References FIFE::SoundClip::getDecoder().
Referenced by getDuration().
float FIFE::SoundEmitter::getCursor | ( | SoundPositionType | type | ) |
Returns the cursor position in the audio file
Definition at line 245 of file soundemitter.cpp.
References FIFE::SoundClip::getStreamPos(), and FIFE::SoundClip::isStream().
|
inline |
Returns the length of the decoded length in bytes
Definition at line 173 of file soundemitter.h.
References FIFE::SoundClip::getDecoder().
Referenced by getDuration().
|
inline |
Returns the duration of the sound clip in milliseconds
Definition at line 183 of file soundemitter.h.
References getBitResolution(), getDecodedLength(), getSampleRate(), and isStereo().
|
inline |
Returns the gain of the emitter
Definition at line 136 of file soundemitter.h.
|
inline |
Returns the emitter-id
Definition at line 55 of file soundemitter.h.
|
inline |
Returns the sample rate
Definition at line 164 of file soundemitter.h.
References FIFE::SoundClip::getDecoder().
Referenced by getDuration().
|
inline |
Get the current sound clip used by this emitter.
Definition at line 85 of file soundemitter.h.
|
inline |
Tests if the audio data is stereo data or mono.
Definition at line 146 of file soundemitter.h.
References FIFE::SoundClip::getDecoder().
Referenced by getDuration().
|
inline |
Pauses playing the audio file
Definition at line 118 of file soundemitter.h.
void FIFE::SoundEmitter::play | ( | ) |
Plays the associated audio file.
Definition at line 175 of file soundemitter.cpp.
References FIFE::SoundClip::isStream(), and FIFE::TimeEvent::setPeriod().
void FIFE::SoundEmitter::release | ( | ) |
Releases the emitter
Definition at line 94 of file soundemitter.cpp.
void FIFE::SoundEmitter::reset | ( | bool | defaultall = false | ) |
Reset the emitter, free all internal buffers
defaultall | If set to true, emitter position, velocity, gain and type will be set to the default values |
Definition at line 65 of file soundemitter.cpp.
References FIFE::SoundClip::isStream(), FIFE::SoundClip::quitStreaming(), FIFE::SharedPtr< T >::reset(), setGain(), FIFE::TimeEvent::setPeriod(), setPosition(), setPositioning(), and setVelocity().
void FIFE::SoundEmitter::setCallback | ( | const type_callback & | cb | ) |
Sets the callback to use when the STREAM has finished being played. NOTE: This only works with streaming audio.
cb | function callback |
Definition at line 105 of file soundemitter.cpp.
void FIFE::SoundEmitter::setCursor | ( | SoundPositionType | type, |
float | value | ||
) |
Sets the cursor position in the audio file
Definition at line 197 of file soundemitter.cpp.
References FIFE::SoundClip::acquireStream(), FIFE::SoundClip::getBuffers(), FIFE::SoundClip::isStream(), FIFE::TimeEvent::setPeriod(), and FIFE::SoundClip::setStreamPos().
Referenced by stop().
|
inline |
Sets the gain of the emitter
gain | The gain value. 0=silence ... 1.0=normal loudness. |
Definition at line 128 of file soundemitter.h.
Referenced by reset().
void FIFE::SoundEmitter::setLooping | ( | bool | loop | ) |
Sets the playing mode
Definition at line 164 of file soundemitter.cpp.
References FIFE::SoundClip::isStream().
|
inline |
Sets the position of the SoundEmitter in the virtual audio space.
Definition at line 206 of file soundemitter.h.
Referenced by reset().
|
inline |
Sets Positioning-Type Default is false
relative | If set to true, the emitters position will be interpreted relative to the listener object |
Definition at line 65 of file soundemitter.h.
Referenced by reset().
|
inline |
Sets the AL_ROLEOFF_FACTOR. Rolloff factor judges the strength of attenuation over distance.
rolloff | Rolloff factor. You'll need to do a lot of testing to find a value which suits your needs. |
Definition at line 73 of file soundemitter.h.
void FIFE::SoundEmitter::setSoundClip | ( | SoundClipPtr | soundclip | ) |
Sets the sound clip to be used by this emitter.
SoundClipPtr | of the sound to be used. |
Definition at line 98 of file soundemitter.cpp.
|
inline |
Sets the velocity of the SoundEmitter in the virtual audio space.
Definition at line 212 of file soundemitter.h.
Referenced by reset().
void FIFE::SoundEmitter::stop | ( | ) |
Stops playing the audio file and rewinds to the beginning
Definition at line 184 of file soundemitter.cpp.
References FIFE::SoundClip::isStream(), setCursor(), and FIFE::TimeEvent::setPeriod().