| Methods |
Description |
| GetVariable |
Returns the value
of the Flash variable specified by the parameter. Returns
null if the variable does not exist. The argument type
is string. |
| GotoFrame |
Activates the frame number specified by
frameNum in the current movie. If the data for a requested
frame is not yet available, the player goes to the last
frame available and stops, causing unexpected results
during playback. Use the PercentLoaded() method to determine
if enough of the movie is available to execute the GotoFrame()
method. The argument frameNum is zero-based; that is,
frameNum is 0 in the first frame of the movie, 1 for the
second frame, and so on. This differs from the Goto action
within Flash, which begins at 1. The argument type is
integer. |
| IsPlaying |
Returns true if
the movie is currently playing |
| LoadMovie |
Loads the movie identified by "url" to
the layer specified by "layer". The argument type is integer
for layer and string for url. |
| Pan |
Pans a zoomed-in
movie to the coordinates specified by x and y. Use mode
to specify whether the values for x and y are pixels or
a percent of the window. When mode is 0, the coordinates
are pixels; when mode is 1, the coordinates are percent
of the window. Pan does not pan beyond the boundaries
of the zoomed-in movie. The argument type for all arguments
is integer. |
| PercentLoaded |
Returns the percent of the Flash Player
movie that has streamed into the browser so far; possible
values are from 0 to 100. |
| Play |
Starts playing the
movie |
| Rewind |
Goes to the first frame |
| SetVariable |
Sets the value of
the Flash variable specified by name to the value specified
by value. The argument type for both arguments is string
|
| SetZoomRect |
Zooms in on a rectangular area of the movie.
The units of the coordinates are in twips (1440 units
per inch). To calculate a rectangle in Flash, set the
ruler units to Points and multiply the coordinates by
20 to get twips. (There are 72 points per inch.) The argument
type for all arguments is integer |
| StopPlay |
Stops playing the
movie |
| Zoom |
Zooms the view by a relative scale factor
specified by "factor". Zoom(50) doubles the size of the
objects in the view. Zoom(200) reduces the size of objects
in the view by one half. Zoom(0) resets the view to 100%.
You cannot specify a reduction in the size of objects
in the view when the current view is already 100%. The
argument type is integer. |
| TCallFrame |
In the timeline
specified by target, executes the action in the frame
specified by FrameNum. |
| TCallLabel |
In the Timeline indicated by target, executes
the action in the frame specified by the label frame label.
The argument type for both arguments is string. |
| TCurrentFrame |
Returns the number
of the current frame for the timeline specified by target.
The frame number returned is zero-based, meaning frame
1 of the Flash movie would be 0, frame 2 would be 1, and
so on. The argument type is string. |
| TCurrentLabel |
Returns the label of the current frame
of the timeline specified by target. If there is no current
frame label, an empty string is returned. The argument
type is string. |
| TSetProperty |
For the timeline
indicated by target, sets the value of the property specified
by property to the value specified by value, which can
be a string or a number. For property, enter the integer
corresponding to the desired property. |
| TGetProperty |
For the timeline indicated by target, returns
a string indicating the value of the property specified
by property. For property, enter the integer corresponding
to the desired property. |
| TSetPropertyNum |
Sets the property
specified by the timeline "target" and parameter "property"
to the specified value. |
| TGetPropertyNum |
For the timeline indicated by target, returns
a number indicating the value of the property specified
by property. For property, enter the integer corresponding
to the desired property. |
| TGotoFrame |
For the timeline
indicated by target, goes to the frame number specified
by FrameNum. The argument type for target is string. The
argument type for FrameNum is integer. |
| TGotoLabel |
For the timeline indicated by target, goes
to the frame label specified by label. The argument type
for both arguments is string. |
| TPlay |
Plays the timeline
specified by target. The argument type is string. |
| TStopPlay |
Stops the timeline specified by target.
The argument type is string. |
| Stop |
Stop playing the
animation |
| Back |
Go to the previous frame. |
| Forward |
Go to the next frame.
|
| CurrentFrame |
Retrieves the current frame number |
| FrameLoaded |
Tests if the frame
specified in the parameter has been loaded |
| FlashVersion |
Retrieves Flash version information |
| Properties |
Description |
| ReadyState |
Returns the state
of the Flash movie. Use to check for availability.
Access: Get
0=Loading, 1=Uninitialized, 2=Loaded, 3=Interactive, 4=Complete
|
| TotalFrames |
Returns the total number of frames in the
movie. This is not available until the movie has loaded.
Access: Get |
| Playing |
Specifies whether
the movie is playing. Returns true if the movie is currently
playing, false if it is paused.
Access: Get, Put |
| Quality |
Returns or specifies the current rendering
quality (0=Low, 1=High, 2=AutoLow, 3=AutoHigh)
Access: Get, Put |
| ScaleMode |
Returns or specifies
the scale mode for the Flash movie (0=ShowAll, 1= NoBorder,
2 = ExactFit).
Access: Get, Put |
| AlignMode |
Returns or specifies the align mode of
bit flags. (Left=+1, Right=+2, Top=+4, Bottom=+8).
Access: Get, Put |
| BackgroundColor |
Override the background
color of a movie. An integer of the form red*65536+green*256+blue
use -1 for the default movie color.
Access: Get, Put |
| Loop |
Specifies the loop state of the Flash movie.
Returns true if the movie loops, false to play once.
Access: Get, Put |
| Movie |
Returns or specifies
the URL source for the movie file. Setting this property
will load a new movie.
Access: Get, Put |
| FrameNum |
Returns or determines the currently displayed
frame of the movie. Setting this property advances or
rewinds the movie.
Access: Get, Put |
| WMode |
Window Mode property
(window, opaque, transparent)
Window movie plays in its own rectangular window
on a web page.
Opaque the movie hides everything on the page behind
it .
Transparent the background of the HTML page shows
through all transparent portions of the movie, this may
slow animation performance.
Access: Get, Put |
| SAlign |
(l, t, r, b, tl, tr, bl, br)
L, R, T, and B align the movie along the
left, right, top or bottom edge, respectively, of the
browser window and crop the remaining three sides as needed.
TL and TR align the movie to the top left
and top right corner, respectively, of the browser window
and crop the bottom and remaining right or left side as
needed.
BL and BR align the movie to the bottom
left and bottom right corner, respectively, of the browser
window and crop the top and remaining right or left side
as needed.
Access: Get, Put |
| Menu |
(true, false)
True displays the full menu, allowing the user
a variety of options to enhance or control playback.
False displays a menu that contains only the Settings
option and the About Flash option.
Access: Get, Put |
| Base |
( . or base directory or URL)
Specifies the base directory or URL used to resolve all
relative path statements in the Flash Player movie. This
attribute is helpful when your Flash Player movies are
kept in a different directory from your other files.
Access: Get, Put |
| scale |
(showall, noborder,
exactfit)
Default (Show all) makes the entire movie visible
in the specified area without distortion, while maintaining
the original aspect ratio of the movie. Borders may appear
on two sides of the movie.
No Border scales the movie to fill the specified
area, without distortion but possibly with some cropping,
while maintaining the original aspect ratio of the movie.
Exact Fit makes the entire movie visible in the
specified area without trying to preserve the original
aspect ratio. Distortion may occur.
Access: Get, Put |
| DeviceFont |
If text is used in a Flash movie, there
is some control of the way the font displays in a browser
by using the device font attribute. The attribute can
be set to true or false. If set to true and the font is
installed on the system viewing the Flash movie, the font
information installed on the system will be substituted.
Text will be aliased (rough) despite the value of the
quality attribute. If the font is not installed on the
system, the text will come out anti-aliased (smooth) as
long as the quality of the movie is set at high.
Access: Get, Put |
| EmbedMovie |
Specifies if the
movie is embedded or not
Access: Get, Put |
| BGColor |
(#RRGGBB, hexadecimal RGB value)
Specifies the background color of the movie. Use this
attribute to override the background color setting specified
in the Flash file.
Access: Get, Put |
| Quality2 |
The current rendering
quality (Low, High, AutoLow, AutoHigh)
Access: Get, Put |
| SWRemote |
Documentation not available
Access: Get, Put |
Much of this information is found in the Flash
documentation.
|
