|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.flagstone.transform.FSTransformObject
com.flagstone.transform.FSMovieObject
com.flagstone.transform.FSStartSound
public class FSStartSound
FSStartSound instructs the player to start or stop playing a sound defined using the FSDefineSound class.
Attributes | |
---|---|
type | Identifies the data structure when it is encoded. Read-only. |
sound | An FSSound object that identifies the sound and controls how it is played - how the sound fades in or out, whether it is repeated along with an envelope that controls the sound levels as it is played. |
The FSStartSound class represents the StartSound tag from the Macromedia Flash (SWF) File Format Specification. It was introduced in Flash 1. In the Macromedia Flash (SWF) File Format Specification the StartSound tag contains an identifier and an FSSoundInfo structure. The Transform FSSound object simply combines both to simplify the design of other sound classes. The information encoded is identical.
Field Summary |
---|
Constructor Summary | |
---|---|
FSStartSound(FSCoder coder)
Construct an FSStartSound object, initialising it with values decoded from an encoded object. |
|
FSStartSound(FSSound aSound)
Constructs an FSStartSound object with an FSSound object that identifies the sound and controls how it is played. |
|
FSStartSound(FSStartSound obj)
Constructs an FSStartSound object by copying values from an existing object. |
Method Summary | |
---|---|
void |
appendDescription(java.lang.StringBuffer buffer,
int depth)
AppendDescription is used to present a string description of the object including all nested objects up to a specified depth. |
java.lang.Object |
clone()
Creates a deep copy of the entire object. |
void |
decode(FSCoder coder)
|
void |
encode(FSCoder coder)
|
boolean |
equals(java.lang.Object anObject)
Returns true if anObject is equal to this one. |
FSSound |
getSound()
Gets the FSSound object describing how the sound will be played. |
int |
length(FSCoder coder)
|
void |
setSound(FSSound aSound)
Sets the FSSound object that describes how the sound will be played. |
Methods inherited from class com.flagstone.transform.FSMovieObject |
---|
getType |
Methods inherited from class com.flagstone.transform.FSTransformObject |
---|
name, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FSStartSound(FSCoder coder)
coder
- an FSCoder containing the binary data.public FSStartSound(FSSound aSound)
aSound
- the FSSound object.public FSStartSound(FSStartSound obj)
obj
- an FSStartSound object.Method Detail |
---|
public FSSound getSound()
public void setSound(FSSound aSound)
aSound
- the FSSound object that controls how the sound is played.public java.lang.Object clone()
FSTransformObject
clone
in class FSTransformObject
public boolean equals(java.lang.Object anObject)
FSMovieObject
equals
in class FSMovieObject
public void appendDescription(java.lang.StringBuffer buffer, int depth)
FSTransformObject
appendDescription
in class FSMovieObject
buffer
- a StringBuffer to which the description of each object is
appended.depth
- the maximum level of nesting up to which objects will be
displayed.public int length(FSCoder coder)
length
in class FSMovieObject
public void encode(FSCoder coder)
encode
in class FSMovieObject
public void decode(FSCoder coder)
decode
in class FSMovieObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |