org.jrabbit.base.sound
Interface ControllableAudio

All Known Implementing Classes:
Channel, Sound, SoundBoard

public interface ControllableAudio

A ControllableAudio represents an Audio object that has dynamic volume and pitch settings.

Author:
Chris Molini

Method Summary
 float pitch()
          Accesses the pitch setting.
 void setPitch(float pitch)
          Redefines the pitch setting.
 void setVolume(float volume)
          Redefines the volume setting.
 float volume()
          Accesses the volume setting.
 

Method Detail

volume

float volume()
Accesses the volume setting.

Returns:
The value that multiplies the base volume of this audio object.

setVolume

void setVolume(float volume)
Redefines the volume setting.

Parameters:
volume - The new volume setting.

pitch

float pitch()
Accesses the pitch setting.

Returns:
The value that multiplies the base pitch of this audio object.

setPitch

void setPitch(float pitch)
Redefines the pitch setting.

Parameters:
pitch - The new pitch setting.