com.threerings.openal

Class Stream

java.lang.Object

com.threerings.openal.Stream

Direct Known Subclasses:

URLStream

public abstract class Stream
extends Object

Represents a streaming source of sound data.

Constructor Summary

Constructors

Constructor and Description
Stream(SoundManager soundmgr) Creates a new stream.

Method Summary

Modifier and Type	Method and Description
void	dispose() Releases the resources held by this stream and removes it from the manager.
void	fadeIn(float interval) Fades this stream in over the specified interval.
void	fadeOut(float interval, boolean dispose) Fades this stream out over the specified interval.
Source	getSource() Returns a reference to the stream source.
boolean	isPlaying() Determines whether this stream is currently playing.
void	pause() Pauses this stream.
void	play() Starts playing this stream.
void	setGain(float gain) Sets the base gain of the stream.
void	stop() Stops this stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Stream

public Stream(SoundManager soundmgr)

Creates a new stream. Call dispose() when finished with the stream.

Parameters:

soundmgr - a reference to the sound manager that will update the stream

Method Detail

setGain

public void setGain(float gain)

Sets the base gain of the stream.

getSource

public Source getSource()

Returns a reference to the stream source.

isPlaying

public boolean isPlaying()

Determines whether this stream is currently playing.

play

public void play()

Starts playing this stream.

pause

public void pause()

Pauses this stream.

stop

public void stop()

Stops this stream.

fadeIn

public void fadeIn(float interval)

Fades this stream in over the specified interval. If the stream isn't playing, it will be started.

fadeOut

public void fadeOut(float interval,
                    boolean dispose)

Fades this stream out over the specified interval.

Parameters:

dispose - if true, dispose of the stream when done fading out

dispose

public void dispose()

Releases the resources held by this stream and removes it from the manager.