de.lessvoid.nifty.spi.sound
Interface SoundHandle


public interface SoundHandle

A interface to a piece of sound. Ready to be played.

Author:
void

Method Summary
 void dispose()
          This Sound is not needed anymore and should be removed from the system.
 float getVolume()
           
 boolean isPlaying()
          Checks if this sound is still playing.
 void play()
          Play the sound.
 void setVolume(float volume)
          Change volume of the sound while it is playing.
 void stop()
          Stop the sound.
 

Method Detail

play

void play()
Play the sound.


stop

void stop()
Stop the sound.


setVolume

void setVolume(float volume)
Change volume of the sound while it is playing.

Parameters:
volume - new value in range 0 to 1

getVolume

float getVolume()

isPlaying

boolean isPlaying()
Checks if this sound is still playing.

Returns:
true if the sound is playing and false if not

dispose

void dispose()
This Sound is not needed anymore and should be removed from the system.



Copyright © 2012. All Rights Reserved.