|
|||||||||
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.FSDefineObject
com.flagstone.transform.FSDefineVideo
public class FSDefineVideo
The FSDefineVideo class is used to display video within a Flash file.
Video objects contain a unique identifier and are treated in the same way as shapes, buttons, images, etc. The video data displayed is define using the FSVideoFrame class. Each frame of video is displayed whenever display list is updated using the FSShowFrame object - any timing information stored within the video data is ignored.
An FSDefineVideo is defined with the following information:
Attributes | |
---|---|
type | Identifies the data structure when it is encoded. Read-only. |
identifier | A unique identifier, in the range 1..65535, that is used to reference the video from other objects, e.g. when adding or removing from the display list. |
frameCount | The number of frames that will be displayed. |
width | Width of each frame in pixels |
height | Height of each frame in pixels. |
deblocking | Whether a filter is used when assembling the blocks of video data into a frame. This may be set to Off to turn off the deblock filter in the Flash Player; On to turn on the Flash Player's filter or UseVideo to allow the video data to specify whether the deblocking filter is used. |
smoothing | Controls whether the Flash Player performs smoothing to increase the quality of the image displayed albeit at the price of performance. |
codec | Identifies the format of the video data either FSDefineVideo.H263 for data encoded using the Sorenson modified H263 format or FSDefineVideo.ScreenVideo for data encoded using Macromedia's Screen Video format. |
The ScreenVideo format was introduced in Flash 7, only the H263 format was supported in Flash 6.
The FSDefineVideo class represents the DefineVideo of the Macromedia Flash (SWF) File Format Specification. It was introduced in Flash 6. The ScreenVideo format was introduced in Flash 7.
Field Summary | |
---|---|
static int |
H263
The video data was encoded using the Sorenson modified H263 format. |
static int |
Off
Instruct the Flash Player to turn the deblocking filter off. |
static int |
On
Instruct the Flash Player to turn the deblocking filter on. |
static int |
ScreenVideo
The video data was encoded using Macromedia's ScreenVideo format. |
static int |
UseVideo
Instruct the Flash Player to use the deblocking value specified in the video data. |
Fields inherited from class com.flagstone.transform.FSDefineObject |
---|
identifier |
Constructor Summary | |
---|---|
FSDefineVideo(FSCoder coder)
Construct an FSDefineVideo object, initialising it with values decoded from an encoded object. |
|
FSDefineVideo(FSDefineVideo obj)
Constructs an FSDefineVideo object by copying values from an existing object. |
|
FSDefineVideo(int anIdentifier,
int count,
int width,
int height,
int deblocking,
boolean smoothing,
int codec)
Constructs an FSDefineVideo object with the specified parameters. |
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. |
int |
getCodec()
Get the format used to encode the video data, either FSDefineVideo.H263 for data encoded using the Sorenson modified H263 format or FSDefineVideo.ScreenVideo (Flash 7 only) for data encoded using Macromedia's Screen Video format. |
int |
getDeblocking()
Gets the method used to control the Flash Player's deblocking filter. |
int |
getFrameCount()
Gets the number of frames in the video. |
int |
getHeight()
Gets the height of each frame in pixels. |
boolean |
getSmoothing()
Gets the method used to control Flash Player's smoothing filter. |
int |
getWidth()
Gets the width of each frame in pixels. |
int |
length(FSCoder coder)
|
void |
setCodec(int codec)
Set the format used to encode the video data, either FSDefineVideo.H263 for data encoded using the Sorenson modified H263 format or FSDefineVideo.ScreenVideo (Flash 7 only) for data encoded using Macromedia's Screen Video format. |
void |
setDeblocking(int deblocking)
Sets the method used to control the Flash Player's deblocking filter. |
void |
setFrameCount(int count)
Sets the number of frames in the video. |
void |
setHeight(int height)
Sets the height of each frame in pixels. |
void |
setSmoothing(boolean smoothing)
Sets the method used to control Flash Player's smoothing filter. |
void |
setWidth(int width)
Sets the width of each frame in pixels. |
Methods inherited from class com.flagstone.transform.FSDefineObject |
---|
getIdentifier, setIdentifier |
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 |
Field Detail |
---|
public static final int H263
public static final int ScreenVideo
public static final int UseVideo
public static final int Off
public static final int On
Constructor Detail |
---|
public FSDefineVideo(FSCoder coder)
coder
- an FSCoder containing the binary data.public FSDefineVideo(int anIdentifier, int count, int width, int height, int deblocking, boolean smoothing, int codec)
anIdentifier
- the unique identifier for this objectcount
- the number of video frames.width
- the width of each frame in pixels.height
- the height of each frame in pixels.deblocking
- controls whether the Flash Player's deblocking filter is used,
either Off, On or UseVideo to allow the video data to specify
whether the deblocking filter is used.smoothing
- turns smoothing on or off to improve the quality of the
displayed image.codec
- the format of the video data. Flash 6 supports
FSDefineVideo.H263. Support for Macromedia's ScreenVideo
format was added in Flash 7.public FSDefineVideo(FSDefineVideo obj)
obj
- an FSDefineVideo object.Method Detail |
---|
public int getFrameCount()
public void setFrameCount(int count)
count
- the number of video frames.public int getWidth()
public void setWidth(int width)
width
- the width of the frame.public int getHeight()
public void setHeight(int height)
height
- the height of the frame.public int getDeblocking()
public void setDeblocking(int deblocking)
deblocking
- the deblocking filter control, either FSDefineVideo.Off,
FSDefineVideo.On or FSDefineVideo.UseVideo to allow the video
data to specify whether the deblocking filter is used.public boolean getSmoothing()
public void setSmoothing(boolean smoothing)
smoothing
- true if smoothing is turned on, false if it is turned off.public int getCodec()
public void setCodec(int codec)
codec
- the format used encode the video, either FSDefineVideo.H263 or
FSDefineVideo.ScreenVideo.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 FSDefineObject
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 FSDefineObject
public void encode(FSCoder coder)
encode
in class FSDefineObject
public void decode(FSCoder coder)
decode
in class FSDefineObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |