pt.tumba.parser.swf
Interface SWFSpriteTagTypes

All Superinterfaces:

SWFHeader, SWFTags

All Known Subinterfaces:

SWFTagTypes

All Known Implementing Classes:

FontLoader, MovieBuilder, SWF2HTML, SWFSaxParser, SWFTagDumper, SWFTagTypesImpl, TagWriter

public interface SWFSpriteTagTypes
extends SWFTags

Interface for passing SWF tag types that can be used in a movie or a sprite

Author:

unknown

Method Summary

SWFActions	tagDoAction()
void	tagEnd() Description of the Method
void	tagFrameLabel(java.lang.String label) Description of the Method
void	tagFreeCharacter(int charId) Description of the Method
void	tagPlaceObject(int charId, int depth, Matrix matrix, AlphaTransform cxform)
SWFActions	tagPlaceObject2(boolean isMove, int clipDepth, int depth, int charId, Matrix matrix, AlphaTransform cxform, int ratio, java.lang.String name, int clipActionFlags)
void	tagRemoveObject(int charId, int depth) Description of the Method
void	tagRemoveObject2(int depth) Description of the Method
void	tagShowFrame() Description of the Method
void	tagSoundStreamBlock(byte[] soundData)
void	tagSoundStreamHead(int playbackFrequency, boolean playback16bit, boolean playbackStereo, int streamFormat, int streamFrequency, boolean stream16bit, boolean streamStereo, int averageSampleCount) Only allows ADPCM encoding.
void	tagSoundStreamHead2(int playbackFrequency, boolean playback16bit, boolean playbackStereo, int streamFormat, int streamFrequency, boolean stream16bit, boolean streamStereo, int averageSampleCount) Allows any encoding.
void	tagStartSound(int soundId, SoundInfo info) Start/stop playing a sound

Methods inherited from interface pt.tumba.parser.swf.SWFTags

tag

Methods inherited from interface pt.tumba.parser.swf.SWFHeader

header

Method Detail

tagStartSound

void tagStartSound(int soundId,
                   SoundInfo info)
                   throws java.io.IOException

Start/stop playing a sound

Parameters:

soundId - Description of the Parameter

info - Description of the Parameter

Throws:

java.io.IOException - Description of the Exception

tagSoundStreamHead

void tagSoundStreamHead(int playbackFrequency,
                        boolean playback16bit,
                        boolean playbackStereo,
                        int streamFormat,
                        int streamFrequency,
                        boolean stream16bit,
                        boolean streamStereo,
                        int averageSampleCount)
                        throws java.io.IOException

Only allows ADPCM encoding.

Parameters:

streamFormat - must be SWFConstants.SOUND_FORMAT_ADPCM

playbackFrequency - one of the SWFConstants.SOUND_FREQ_* constants

streamFrequency - one of the SWFConstants.SOUND_FREQ_* constants

playback16bit - Description of the Parameter

playbackStereo - Description of the Parameter

stream16bit - Description of the Parameter

streamStereo - Description of the Parameter

averageSampleCount - Description of the Parameter

Throws:

java.io.IOException - Description of the Exception

tagSoundStreamHead2

void tagSoundStreamHead2(int playbackFrequency,
                         boolean playback16bit,
                         boolean playbackStereo,
                         int streamFormat,
                         int streamFrequency,
                         boolean stream16bit,
                         boolean streamStereo,
                         int averageSampleCount)
                         throws java.io.IOException

Allows any encoding.

Parameters:

streamFormat - one of the SWFConstants.SOUND_FORMAT_* constants

playbackFrequency - one of the SWFConstants.SOUND_FREQ_* constants

streamFrequency - one of the SWFConstants.SOUND_FREQ_* constants

playback16bit - Description of the Parameter

playbackStereo - Description of the Parameter

stream16bit - Description of the Parameter

streamStereo - Description of the Parameter

averageSampleCount - Description of the Parameter

Throws:

java.io.IOException - Description of the Exception

tagSoundStreamBlock

void tagSoundStreamBlock(byte[] soundData)
                         throws java.io.IOException

Parameters:

soundData - format-dependent sound data

Throws:

java.io.IOException - Description of the Exception

tagEnd

void tagEnd()
            throws java.io.IOException

Description of the Method

Throws:

java.io.IOException - Description of the Exception

tagShowFrame

void tagShowFrame()
                  throws java.io.IOException

Description of the Method

Throws:

java.io.IOException - Description of the Exception

tagDoAction

SWFActions tagDoAction()
                       throws java.io.IOException

Returns:

SWFActions to receive actions - or null to skip the data

Throws:

java.io.IOException - Description of the Exception

tagFreeCharacter

void tagFreeCharacter(int charId)
                      throws java.io.IOException

Description of the Method

Parameters:

charId - Description of the Parameter

Throws:

java.io.IOException - Description of the Exception

tagPlaceObject

void tagPlaceObject(int charId,
                    int depth,
                    Matrix matrix,
                    AlphaTransform cxform)
                    throws java.io.IOException

Parameters:

cxform - may be null

charId - Description of the Parameter

depth - Description of the Parameter

matrix - Description of the Parameter

Throws:

java.io.IOException - Description of the Exception

tagRemoveObject

void tagRemoveObject(int charId,
                     int depth)
                     throws java.io.IOException

Description of the Method

Parameters:

charId - Description of the Parameter

depth - Description of the Parameter

Throws:

java.io.IOException - Description of the Exception

tagPlaceObject2

SWFActions tagPlaceObject2(boolean isMove,
                           int clipDepth,
                           int depth,
                           int charId,
                           Matrix matrix,
                           AlphaTransform cxform,
                           int ratio,
                           java.lang.String name,
                           int clipActionFlags)
                           throws java.io.IOException

Parameters:

clipDepth - < 1 if not relevant

charId - < 1 if not relevant

name - of sprite instance - null if not relevant

ratio - < 0 if not relevant

matrix - null if not relevant

cxform - null if not relevant

clipActionFlags - == 0 if there are no clip actions - otherwise this is the OR of the condition flags on all the clip action blocks

isMove - Description of the Parameter

depth - Description of the Parameter

Returns:

null if there are no clip actions or they are irrelevant

Throws:

java.io.IOException - Description of the Exception

tagRemoveObject2

void tagRemoveObject2(int depth)
                      throws java.io.IOException

Description of the Method

Parameters:

depth - Description of the Parameter

Throws:

java.io.IOException - Description of the Exception

tagFrameLabel

void tagFrameLabel(java.lang.String label)
                   throws java.io.IOException

Description of the Method

Parameters:

label - Description of the Parameter

Throws:

java.io.IOException - Description of the Exception