Sound (Nenya Core 1.6.1 API)

java.lang.Object
- com.threerings.openal.Sound

Direct Known Subclasses:

BlankSound
```
public class Sound
extends Object
```
Represents an instance of a sound clip which can be positioned in 3D space, gain and pitch adjusted and played or looped.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Sound.StartObserver
Used to await notification of the starting of a sound which may be delayed in loading.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Sound.StartObserver` Used to await notification of the starting of a sound which may be delayed in loading.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClipBuffer`	`getBuffer()` Returns the buffer of audio data associated with this sound.
`SoundGroup`	`getGroup()` Returns a reference to the group to which the sound belongs.
`boolean`	`isPending()` Called to check if this sound wants to start playing.
`boolean`	`isPlaying()` Called to check if this sound is currently playing.
`boolean`	`loop(boolean allowDefer)` Loops this sound, starting from the beginning of the audio data.
`void`	`pause()` Pauses this sound.
`boolean`	`play(boolean allowDefer)` Plays this sound from the beginning.
`boolean`	`play(Sound.StartObserver obs, boolean loop)` Plays this sound from the beginning, notifying the supplied observer when the audio starts.
`void`	`setConeInnerAngle(float angle)` Sets the inside angle of the sound cone.
`void`	`setConeOuterAngle(float angle)` Sets the outside angle of the sound cone.
`void`	`setConeOuterGain(float gain)` Sets the gain outside of the sound cone.
`void`	`setDirection(float x, float y, float z)` Sets the direction of the sound.
`void`	`setGain(float gain)` Sets the gain of the sound (which will be multiplied by the base gain).
`void`	`setMaxDistance(float distance)` Sets the maximum distance for attenuation.
`void`	`setMaxGain(float gain)` Sets the maximum gain.
`void`	`setMinGain(float gain)` Sets the minimum gain.
`void`	`setPitch(float pitch)` Sets the pitch multiplier.
`void`	`setPosition(float x, float y, float z)` Sets the position of the sound.
`void`	`setReferenceDistance(float distance)` Sets the reference distance for attenuation.
`void`	`setRolloffFactor(float rolloff)` Sets the rolloff factor for attenuation.
`void`	`setSourceRelative(boolean relative)` Sets whether or not the position, velocity, etc., of the sound are relative to the listener.
`void`	`setVelocity(float x, float y, float z)` Sets the velocity of the sound.
`void`	`stop()` Stops this sound and rewinds to its beginning.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getGroup
```
public SoundGroup getGroup()
```
    Returns a reference to the group to which the sound belongs.
  - getBuffer
```
public ClipBuffer getBuffer()
```
    Returns the buffer of audio data associated with this sound.
  - setPosition
```
public void setPosition(float x,
                        float y,
                        float z)
```
    Sets the position of the sound.
  - setVelocity
```
public void setVelocity(float x,
                        float y,
                        float z)
```
    Sets the velocity of the sound.
  - setGain
```
public void setGain(float gain)
```
    Sets the gain of the sound (which will be multiplied by the base gain).
  - setSourceRelative
```
public void setSourceRelative(boolean relative)
```
    Sets whether or not the position, velocity, etc., of the sound are relative to the listener.
  - setMinGain
```
public void setMinGain(float gain)
```
    Sets the minimum gain.
  - setMaxGain
```
public void setMaxGain(float gain)
```
    Sets the maximum gain.
  - setReferenceDistance
```
public void setReferenceDistance(float distance)
```
    Sets the reference distance for attenuation.
  - setRolloffFactor
```
public void setRolloffFactor(float rolloff)
```
    Sets the rolloff factor for attenuation.
  - setMaxDistance
```
public void setMaxDistance(float distance)
```
    Sets the maximum distance for attenuation.
  - setPitch
```
public void setPitch(float pitch)
```
    Sets the pitch multiplier.
  - setDirection
```
public void setDirection(float x,
                         float y,
                         float z)
```
    Sets the direction of the sound.
  - setConeInnerAngle
```
public void setConeInnerAngle(float angle)
```
    Sets the inside angle of the sound cone.
  - setConeOuterAngle
```
public void setConeOuterAngle(float angle)
```
    Sets the outside angle of the sound cone.
  - setConeOuterGain
```
public void setConeOuterGain(float gain)
```
    Sets the gain outside of the sound cone.
  - play
```
public boolean play(boolean allowDefer)
```
    Plays this sound from the beginning. While the sound is playing, an audio channel will be locked and then freed when the sound completes.
    
    Parameters:
    
    allowDefer - if false, the sound will be played immediately or not at all. If true, the sound will be queued up for loading if it is currently flushed from the cache and played once loaded.
    
    Returns:
    
    true if the sound could be played and was started (or queued up to be loaded and played ASAP if it was specified as deferrable) or false if the sound could not be played either because it was not ready and deferral was not allowed or because too many other sounds were playing concurrently.
  - loop
```
public boolean loop(boolean allowDefer)
```
    Loops this sound, starting from the beginning of the audio data. It will continue to loop until pause()d or stop()ped. While the sound is playing an audio channel will be locked.
    
    Returns:
    
    true if a channel could be obtained to play the sound (and the sound was thus started) or false if no channels were available.
  - play
```
public boolean play(Sound.StartObserver obs,
                    boolean loop)
```
    Plays this sound from the beginning, notifying the supplied observer when the audio starts.
    
    Parameters:
    
    loop - whether or not to loop the sampe until stop()ped.
  - pause
```
public void pause()
```
    Pauses this sound. A subsequent call to play(boolean) will resume the sound from the precise position that it left off. While the sound is paused, its audio channel will remain locked.
  - stop
```
public void stop()
```
    Stops this sound and rewinds to its beginning. The audio channel being used to play the sound will be released.
  - isPlaying
```
public boolean isPlaying()
```
    Called to check if this sound is currently playing.
  - isPending
```
public boolean isPending()
```
    Called to check if this sound wants to start playing.

Class Sound

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getGroup

getBuffer

setPosition

setVelocity

setGain

setSourceRelative

setMinGain

setMaxGain

setReferenceDistance

setRolloffFactor

setMaxDistance

setPitch

setDirection

setConeInnerAngle

setConeOuterAngle

setConeOuterGain

play

loop

play

pause

stop

isPlaying

isPending