kuusisto.tinysound

Interface Sound

All Known Implementing Classes:

MemSound, StreamSound

public interface Sound

The Sound interface is an abstraction for sound effects. Sound objects should only be loaded via the TinySound loadSound() functions. Sounds can be played repeatedly in an overlapping fashion.

Author:

Finn Kuusisto

Method Summary

Methods

Modifier and Type	Method and Description
void	play() Plays this Sound.
void	play(double volume) Plays this Sound with a specified volume.
void	play(double volume, double pan) Plays this Sound with a specified volume and pan.
void	stop() Stops this Sound from playing.
void	unload() Unloads this Sound from the system.

Method Detail

play

void play()

Plays this Sound.

play

void play(double volume)

Plays this Sound with a specified volume.

Parameters:

volume - the volume at which to play this Sound

play

void play(double volume,
        double pan)

Plays this Sound with a specified volume and pan.

Parameters:

volume - the volume at which to play this Sound

pan - the pan value to play this Sound [-1.0,1.0], values outside the valid range will assume no panning (0.0)

stop

void stop()

Stops this Sound from playing. Note that if this Sound was played repeatedly in an overlapping fashion, all instances of this Sound still playing will be stopped.

unload

void unload()

Unloads this Sound from the system. Attempts to use this Sound after unloading will result in error.