pt.tumba.parser.swf
Class SoundInfo

java.lang.Object
  extended by pt.tumba.parser.swf.SoundInfo

public class SoundInfo
extends java.lang.Object

A Sound Information structure - defines playback style and envelope

Author:
unknown

Nested Class Summary
static class SoundInfo.EnvelopePoint
          A Point in a sound envelope
 
Field Summary
protected  SoundInfo.EnvelopePoint[] envelope
          Description of the Field
protected  int inPoint
          Description of the Field
protected  int loopCount
          Description of the Field
protected  boolean noMultiplePlay
          Description of the Field
protected  int outPoint
          Description of the Field
protected  boolean stopPlaying
          Description of the Field
 
Constructor Summary
SoundInfo(boolean noMultiplePlay, boolean stopSound, SoundInfo.EnvelopePoint[] envelope, int inPoint, int outPoint, int loopCount)
           
SoundInfo(InStream in)
          Constructor for the SoundInfo object
 
Method Summary
 SoundInfo.EnvelopePoint[] getEnvelope()
          Gets the envelope attribute of the SoundInfo object
 int getInPoint()
          Gets the inPoint attribute of the SoundInfo object
 int getLoopCount()
          Gets the loopCount attribute of the SoundInfo object
 int getOutPoint()
          Gets the outPoint attribute of the SoundInfo object
 boolean isNoMultiplePlay()
          Gets the noMultiplePlay attribute of the SoundInfo object
 boolean isStopPlaying()
          Gets the stopPlaying attribute of the SoundInfo object
 java.lang.String toString()
          Description of the Method
 void write(OutStream out)
          Description of the Method
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

noMultiplePlay

protected boolean noMultiplePlay
Description of the Field


stopPlaying

protected boolean stopPlaying
Description of the Field


envelope

protected SoundInfo.EnvelopePoint[] envelope
Description of the Field


inPoint

protected int inPoint
Description of the Field


outPoint

protected int outPoint
Description of the Field


loopCount

protected int loopCount
Description of the Field

Constructor Detail

SoundInfo

public SoundInfo(boolean noMultiplePlay,
                 boolean stopSound,
                 SoundInfo.EnvelopePoint[] envelope,
                 int inPoint,
                 int outPoint,
                 int loopCount)
Parameters:
noMultiplePlay - true = only play if not already playing
stopSound - true = stop playing the sound
envelope - may be null or empty for no envelope
inPoint - -1 for no in-point
outPoint - -1 for no out-point
loopCount - >1 for a loop count

SoundInfo

public SoundInfo(InStream in)
          throws java.io.IOException
Constructor for the SoundInfo object

Parameters:
in - Description of the Parameter
Throws:
java.io.IOException - Description of the Exception
Method Detail

isNoMultiplePlay

public boolean isNoMultiplePlay()
Gets the noMultiplePlay attribute of the SoundInfo object

Returns:
The noMultiplePlay value

isStopPlaying

public boolean isStopPlaying()
Gets the stopPlaying attribute of the SoundInfo object

Returns:
The stopPlaying value

getEnvelope

public SoundInfo.EnvelopePoint[] getEnvelope()
Gets the envelope attribute of the SoundInfo object

Returns:
The envelope value

getInPoint

public int getInPoint()
Gets the inPoint attribute of the SoundInfo object

Returns:
The inPoint value

getOutPoint

public int getOutPoint()
Gets the outPoint attribute of the SoundInfo object

Returns:
The outPoint value

getLoopCount

public int getLoopCount()
Gets the loopCount attribute of the SoundInfo object

Returns:
The loopCount value

write

public void write(OutStream out)
           throws java.io.IOException
Description of the Method

Parameters:
out - Description of the Parameter
Throws:
java.io.IOException - Description of the Exception

toString

public java.lang.String toString()
Description of the Method

Overrides:
toString in class java.lang.Object
Returns:
Description of the Return Value