public interface SoundPlayerAPI
Modifier and Type | Method and Description |
---|---|
void |
applyLowPassFilter(float gain,
float gainHF) |
java.lang.String |
getCurrentMusicId()
Thread-safe - can be called from threads other than the main loop thread.
|
Vector2f |
getListenerPos() |
void |
pauseCustomMusic() |
void |
pauseMusic() |
void |
playCustomMusic(int fadeOutIfAny,
int fadeIn,
java.lang.String musicSetId)
Thread-safe - can be called from threads other than the main loop thread.
|
void |
playCustomMusic(int fadeOutIfAny,
int fadeIn,
java.lang.String musicSetId,
boolean looping) |
void |
playLoop(java.lang.String id,
java.lang.Object playingEntity,
float pitch,
float volume,
Vector2f loc,
Vector2f vel)
Loop a sound.
|
void |
playLoop(java.lang.String id,
java.lang.Object playingEntity,
float pitch,
float volume,
Vector2f loc,
Vector2f vel,
float fadeIn,
float fadeOut) |
void |
playMusic(int fadeOutIfAny,
int fadeIn,
java.lang.String musicSetId)
Deprecated.
|
SoundAPI |
playSound(java.lang.String id,
float pitch,
float volume,
Vector2f loc,
Vector2f vel)
Sound file must be *mono* for it to be properly played within the engine.
|
void |
playUILoop(java.lang.String id,
float pitch,
float volume) |
SoundAPI |
playUISound(java.lang.String id,
float pitch,
float volume)
UI sound files should be stereo.
|
void |
restartCurrentMusic()
Thread-safe - can be called from threads other than the main loop thread.
|
void |
resumeCustomMusic() |
void |
setListenerPosOverrideOneFrame(Vector2f listenerPosOverrideOneFrame) |
void |
setNextLoopFadeInAndOut(float nextLoopFadeIn,
float nextLoopFadeOut) |
void |
setSuspendDefaultMusicPlayback(boolean suspendMusicPlayback)
Thread-safe - can be called from threads other than the main loop thread.
|
SoundAPI playUISound(java.lang.String id, float pitch, float volume)
id
- pitch
- volume
- SoundAPI playSound(java.lang.String id, float pitch, float volume, Vector2f loc, Vector2f vel)
id
- pitch
- volume
- loc
- vel
- void playLoop(java.lang.String id, java.lang.Object playingEntity, float pitch, float volume, Vector2f loc, Vector2f vel)
id
- playingEntity
- Required. Used to help uniquely identify playing loops. Also used to figure out which loops to not play (i.e., same entity playing multiples of the same loop would only play the one.)pitch
- volume
- loc
- vel
- void restartCurrentMusic()
java.lang.String getCurrentMusicId()
void playCustomMusic(int fadeOutIfAny, int fadeIn, java.lang.String musicSetId)
fadeOutIfAny
- fadeIn
- musicSetId
- @Deprecated void playMusic(int fadeOutIfAny, int fadeIn, java.lang.String musicSetId)
fadeOutIfAny
- fadeIn
- musicSetId
- void setSuspendDefaultMusicPlayback(boolean suspendMusicPlayback)
suspendMusicPlayback
- Vector2f getListenerPos()
void pauseCustomMusic()
void resumeCustomMusic()
void playCustomMusic(int fadeOutIfAny, int fadeIn, java.lang.String musicSetId, boolean looping)
void playUILoop(java.lang.String id, float pitch, float volume)
void playLoop(java.lang.String id, java.lang.Object playingEntity, float pitch, float volume, Vector2f loc, Vector2f vel, float fadeIn, float fadeOut)
void applyLowPassFilter(float gain, float gainHF)
void setListenerPosOverrideOneFrame(Vector2f listenerPosOverrideOneFrame)
void pauseMusic()
void setNextLoopFadeInAndOut(float nextLoopFadeIn, float nextLoopFadeOut)
Copyright © 2013 Fractal Softworks, LLC. All Rights Reserved.