GetVariable Function

Returns the value of the Flash variable specified by the parameter. Returns null if the variable does not exist. The argument type is string.

Public VT_BSTR GetVariable(VT_BSTR )

Type Name Description
  VT_BSTR name the name of the variable
       
Return Description
  VT_BSTR returns the value as a string


GotoFrame Function

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.

Public VT_VOID GotoFrame(VT_I4 )

Type Name Description
  VT_I4 FrameNum the frame number
       
Return Description
  VT_VOID  


IsPlaying Function

Returns true if the movie is currently playing

Public VT_BOOL IsPlaying()

Return Description
  VT_BOOL returns a boolean



LoadMovie Function

Loads the movie identified by "url" to the layer specified by "layer". The argument type is integer for layer and string for url.

Public VT_VOID LoadMovie(VT_INT , VT_BSTR )

Type Name Description
  VT_INT layer the layer to load to
  VT_BSTR url the movie
       
Return Description
  VT_VOID  


Pan Function

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.

Public VT_VOID Pan(VT_I4 , VT_I4 , VT_INT )

Type Name Description
  VT_I4 x the x value
  VT_I4 y the y value
  VT_INT mode the mode specifies whether the values are pixels (0) or percent (1)
       
Return Description
  VT_VOID  


PercentLoaded Function

Returns the percent of the Flash Player movie that has streamed into the browser so far; possible values are from 0 to 100.

Public VT_I4 PercentLoaded()

Return Description
  VT_I4

returns the percent as an integer



Play Function

Starts playing the movie

Public VT_VOID Play()

Return Description
  VT_VOID



Rewind Function

Goes to the first frame

Public VT_VOID Rewind()

Return Description
  VT_VOID



SetVariable Function

Sets the value of the Flash variable specified by name to the value specified by value. The argument type for both arguments is string

Public VT_VOID SetVariable(VT_BSTR , VT_BSTR )

Type Name Description
  VT_BSTR name the name of the variable
  VT_BSTR value the value to set
       
Return Description
  VT_VOID  


SetZoomRect Function

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

Public VT_VOID SetZoomRect(VT_I4 , VT_I4 , VT_I4 , VT_I4 )

Type Name Description
  VT_I4 left the left coordinate of rectangle
  VT_I4 top the top coordinate of rectangle
  VT_I4 right the right coordinate of rectangle
  VT_I4 bottom the bottom coordinate of rectangle
       
Return Description
  VT_VOID  


StopPlay Function

Stops playing the movie

Public VT_VOID StopPlay()

Return Description
  VT_VOID



Zoom Function

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.

Public VT_VOID Zoom(VT_INT )

Type Name Description
  VT_INT factor the scale factor
       
Return Description
  VT_VOID  


TCallFrame Function

In the timeline specified by target, executes the action in the frame specified by FrameNum.

Public VT_VOID TCallFrame(VT_BSTR , VT_INT )

Type Name Description
  VT_BSTR target the timeline
  VT_INT FrameNum the frame number
       
Return Description
  VT_VOID  


TCallLabel Function

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.

Public VT_VOID TCallLabel(VT_BSTR , VT_BSTR )

Type Name Description
  VT_BSTR target the timeline
  VT_BSTR label the label
       
Return Description
  VT_VOID  


TCurrentFrame Function

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.

Public VT_I4 TCurrentFrame(VT_BSTR )

Type Name Description
  VT_BSTR target the timeline
       
Return Description
  VT_I4 returns the current frame for the specified timeline


TCurrentLabel Function

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.

Public VT_BSTR TCurrentLabel(VT_BSTR )

Type Name Description
  VT_BSTR target the timeline
       
Return Description
  VT_BSTR returns the current label or an empty string if there is no label



TSetProperty Function

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.

Public VT_VOID TSetProperty(VT_BSTR , VT_INT , VT_BSTR )

Type Name Description
  VT_BSTR target the timeline
  VT_INT property the integer corresponding to the desired property
  VT_BSTR value the value to set
       
Return Description
  VT_VOID  


TGetProperty Function

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.

Public VT_BSTR TGetProperty(VT_BSTR , VT_INT )

Type Name Description
  VT_BSTR target the timeline
  VT_INT property the property
       
Return Description
  VT_BSTR returns the value of the property as a string



TSetPropertyNum Function

Sets the property specified by the timeline "target" and parameter "property" to the specified value.

Public VT_VOID TSetPropertyNum(VT_BSTR , VT_INT , VT_R8 )

Type Name Description
  VT_BSTR target the timeline
  VT_INT property the integer corresponding to the desired property
  VT_R8 value the value to set
       
Return Description
  VT_VOID  


TGetPropertyNum Function

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.

Public VT_R8 TGetPropertyNum(VT_BSTR , VT_INT )

Type Name Description
  VT_BSTR target the timeline
  VT_INT property the integer corresponding to the desired property
       
Return Description
  VT_R8 returns the value of the property as a number


TGotoFrame Function

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.

Public VT_VOID TGotoFrame(VT_BSTR , VT_I4 )

Type Name Description
  VT_BSTR target the timeline
  VT_I4 FrameNum the frame number
       
Return Description
  VT_VOID  


TGotoLabel Function

For the timeline indicated by target, goes to the frame label specified by label. The argument type for both arguments is string.

Public VT_VOID TGotoLabel(VT_BSTR , VT_BSTR )

Type Name Description
  VT_BSTR target the timeline
  VT_BSTR label the frame label
       
Return Description
  VT_VOID  


TPlay Function

Plays the timeline specified by target. The argument type is string.

Public VT_VOID TPlay(VT_BSTR )

Type Name Description
  VT_BSTR target the timeline
       
Return Description
  VT_VOID  


TStopPlay Function

Stops the timeline specified by target. The argument type is string.

Public VT_VOID TStopPlay(VT_BSTR )

Type Name Description
  VT_BSTR target the timeline
       
Return Description
  VT_VOID  


Stop Function

Stop playing the animation

Public VT_VOID Stop()

Return Description
  VT_VOID



Back Function

Go to the previous frame.

Public VT_VOID Back()

Return Description
  VT_VOID



Forward Function

Go to the next frame.

Public VT_VOID Forward()

Return Description
  VT_VOID



CurrentFrame Function

Retrieves the current frame number

Public VT_I4 CurrentFrame()

Return Description
  VT_14

returns the current frame number as an integer



FrameLoaded Function

Tests if the frame specified in the parameter has been loaded

Public VT_BOOL FrameLoaded(VT_I4 )

Type Name Description
  VT_I4 FrameNum the frame number to check
       
Return Description
  VT_BOOL returns true or false


FlashVersion Function

Retrieves Flash version information

Public VT_I4 FlashVersion()

Return Description
  VT_14

returns an integer containing the information



ReadyState VT_I4 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

Access: Public

Return Description
  VT_14



TotalFrames VT_I4 TotalFrames

Returns the total number of frames in the movie. This is not available until the movie has loaded.
Access: Get

Access: Public

Return Description
  VT_14



Playing VT_BOOL Playing

Specifies whether the movie is playing. Returns true if the movie is currently playing, false if it is paused.
Access: Get, Put

Access: Public

Return Description
  VT_BOOL



Quality VT_INT Quality

Returns or specifies the current rendering quality (0=Low, 1=High, 2=AutoLow, 3=AutoHigh)
Access: Get, Put

Access: Public

Return Description
  VT_INT



ScaleMode VT_INT ScaleMode

Returns or specifies the scale mode for the Flash movie (0=ShowAll, 1= NoBorder, 2 = ExactFit).
Access: Get, Put

Access: Public

Return Description
  VT_INT



AlignMode VT_INT AlignMode

Returns or specifies the align mode of bit flags. (Left=+1, Right=+2, Top=+4, Bottom=+8).
Access: Get, Put

Access: Public

Return Description
  VT_INT



BackgroundColor VT_I4 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

Access: Public

Return Description
  VT_14



Loop VT_BOOL Loop

Specifies the loop state of the Flash movie. Returns true if the movie loops, false to play once.
Access: Get, Put

Access: Public

Return Description
  VT_BOOL



Movie VT_BSTR Movie

Returns or specifies the URL source for the movie file. Setting this property will load a new movie.
Access: Get, Put

Access: Public

Return Description
  VT_BSTR  


FrameNum VT_I4 FrameNum

Returns or determines the currently displayed frame of the movie. Setting this property advances or rewinds the movie.
Access: Get, Put

Access: Public

Return Description
  VT_14



WMode VT_BSTR 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

Access: Public

Return Description
  VT_BSTR  


SAlign VT_BSTR 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

Access: Public

Return Description
  VT_BSTR  


Menu VT_BOOL 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

Access: Public

Return Description
  VT_BOOL



Base VT_BSTR 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

Access: Public

Return Description
  VT_BSTR  


scale VT_BSTR 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

Access: Public

Return Description
  VT_BSTR  


DeviceFont VT_BOOL 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

Access: Public

Return Description
  VT_BOOL



EmbedMovie VT_BOOL EmbedMovie

Specifies if the movie is embedded or not
Access: Get, Put

Access: Public

Return Description
  VT_BOOL



BGColor VT_BSTR 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

Access: Public

Return Description
  VT_BSTR  


Quality2 VT_BSTR Quality2

The current rendering quality (Low, High, AutoLow, AutoHigh)
Access: Get, Put

Access: Public

Return Description
  VT_BSTR  


SWRemote VT_BSTR SWRemote

Documentation not available
Access: Get, Put

Access: Public

Return Description
  VT_BSTR  


OnReadyStateChange Function

Generated when the ready state of the control changes. The possible states are 0=Loading, 1=Uninitialized, 2=Loaded, 3=Interactive, 4=Complete.

Public void OnReadyStateChange(int )

Type Name Description
  int state the state
       
Return Description
  void  


OnProgress Function

Generated as the Flash Player movie is downloading.

Public void OnProgress(int )

Type Name Description
  int percent percent complete
       
Return Description
  void  


FSCommand Function

Generated when an FSCommand action is performed in the movie with a URL and the URL starts with "FSCommand:". Use this to create a response to a frame or button action in the Flash movie.

Public void FSCommand(string , string )

Type Name Description
  string command the command
  string args the arguments
       
Return Description
  void