View comments | RSS feed

Flash CS3  |  Go to CS4 Help

Parameters and attributes

The following tag attributes and parameters describe the HTML code that the Publish command creates. Refer to this list as you write custom HTML to show Flash content. Unless noted, all items apply to both the object and embed tags. Optional entries are noted. Internet Explorer recognizes parameters used with the object tag; Netscape recognizes the embed tag. Attributes are used with both the object and embed tags. When you customize a template, you can substitute a template variable (identified in the Value section for each parameter in the following list) for the value.

Note: The attributes and parameters listed in this section are shown in lowercase to comply with the XHTML standard.

devicefont attribute/parameter

Value

true
| false 

Template variable: $DE

Description

(Optional) Specifies whether static text objects are rendered in device fonts, even if the Device Font option is not selected. This attribute applies when the necessary fonts are available from the operating system.

src attribute

Value

movieName.swf

Template variable: $MO

Description

Specifies the name of the SWF file to be loaded. Applies to the embed tag only.

movie parameter

Value

movieName.swf

Template variable: $MO

Description

Specifies the name of the SWF file to be loaded. Applies to the object tag only.

classid attribute

Value

clsid:d27cdb6e-ae6d-11cf-96b8-444553540000

Description

Identifies the ActiveX control for the browser. The value must be entered exactly as shown. Applies to the object tag only.

width attribute

Value

n or n %

Template variable: $WI

Description

Specifies the width of the application either in pixels or as a percentage of the browser window.

height attribute

Value

n or n %

Template variable: $HE

Description

Specifies the height of the application either in pixels or as a percentage of the browser window.

Note: Because Flash applications are scalable, quality doesn’t degrade at different sizes if the aspect ratio is maintained. (For example, the following sizes all have a 4:3 aspect ratio: 640 x 480 pixels, 320 x 240 pixels, and 240 x 180 pixels.)

codebase attribute

Value

http://fpdownload.adobe.com/pub/shockwave/cabs/flash/swflash.cab#version=7,0,0,0

Description

Identifies the location of the Flash Player ActiveX control so that the browser can automatically download it if it is not already installed. The value must be entered exactly as shown. Applies to the object tag only.

pluginspage attribute

Value

http://www.adobe.com/shockwave/download/index.cgi?P1_Prod_Version=ShockwaveFlash 

Description

Identifies the location of the Flash Player plug‑in so that the user can download it if it is not already installed. The value must be entered exactly as shown. Applies to the embed tag only.

swliveconnect attribute

Value

true | false 

Description

(Optional) Specifies whether the browser should start Java when loading Flash Player for the first time. The default value is false if this attribute is omitted. If you use JavaScript and Flash on the same page, Java must be running for the fscommand() function to work. However, if you use JavaScript only for browser detection or another purpose unrelated to fscommand() actions, you can prevent Java from starting by setting SWLIVECONNECT to false. To force Java to start when you are not using JavaScript, explicitly set the SWLIVECONNECT attribute to true. Starting Java substantially increases the startup time for a SWF file; set this tag to true only when necessary. Applies to the embed tag only.

Use the fscommand() action to start Java from a stand-alone projector file.

play attribute/parameter

Value

true | false

Template variable: $PL

Description

(Optional) Specifies whether the application begins playing immediately on loading in the web browser. If your Flash application is interactive, let the user initiate play by clicking a button or performing another task. In this case, set the play attribute to false to prevent the application from starting automatically. The default value is true if this attribute is omitted.

loop attribute/parameter

Value

true | false

Template variable: $LO

Description

(Optional) Specifies whether the content repeats indefinitely or stops when it reaches the last frame. The default value is true if this attribute is omitted.

quality attribute/parameter

Value

low | medium | high | autolow | autohigh | best

Template variable: $QU

Description

(Optional) Specifies the level of anti-aliasing to be used. Because anti-aliasing requires a faster processor to smooth each frame of the SWF file before it is rendered on the viewer’s screen, select one of the following values based on whether your priority is speed or appearance:

Low
Favors playback speed over appearance and never uses anti-aliasing.

Autolow
Emphasizes speed at first but improves appearance whenever possible. Playback begins with anti-aliasing turned off. If Flash Player detects that the processor can handle it, anti-aliasing is turned on. Note: SWF files authored using ActionScript 3.0 do not recognize the autolow value.

Autohigh
Initially emphasizes playback speed and appearance equally, but sacrifices appearance for playback speed if necessary. Playback begins with anti-aliasing turned on. If the frame rate drops below the specified frame rate, anti-aliasing is turned off to improve playback speed. Use this setting to emulate the Antialias command (View > Preview Mode > Antialias).

Medium
Applies some anti-aliasing and does not smooth bitmaps. It produces a better quality than the Low setting but a lower quality than the High setting.

High
Favors appearance over playback speed and always applies anti-aliasing. If the SWF file does not contain animation, bitmaps are smoothed; if the SWF file has animation, bitmaps are not smoothed.

Best
Provides the best display quality and does not consider playback speed. All output is anti‑aliased, and all bitmaps are smoothed.

The default value for quality is high if this attribute is omitted.

bgcolor attribute/parameter

Value

#RRGGBB (hexadecimal RGB value)

Template variable: $BG

Description

(Optional) Specifies the background color of the application. Use this attribute to override the background color setting that the SWF file specifies. This attribute does not affect the background color of the HTML page.

scale attribute/parameter

Value

showall | noborder | exactfit

Template variable: $SC

Description

(Optional) Defines how the application is placed in the browser window when width and height values are percentages.

Showall (Default)
Makes the entire content visible in the specified area without distortion while maintaining the original aspect ratio of the application. Borders can appear on two sides of the application.

Noborder
Scales the content to fill the specified area, without distortion but possibly with some cropping, while maintaining the original aspect ratio of the application.

Exactfit
Makes the entire content visible in the specified area without trying to preserve the original aspect ratio. Distortion can occur.

The default value is showall if this attribute is omitted (and width and height values are percentages).

align attribute

Value

Default | L | R | T | B 

Template variable: $HA

Description

Specifies the align value for the object, embed, and img tags and determines how the SWF file is positioned within the browser window.

Default
Centers the application in the browser window and crops edges if the browser window is smaller than the application.

L, R, T, and B
Align the application along the left, right, top, and bottom edge, respectively, of the browser window and crop the remaining three sides as needed.

salign parameter

Value

L | R | T | B | TL | TR | BL | BR 

Template variable: $SA

Description

(Optional) Specifies where a scaled SWF file is positioned in the area that the width and height settings define.

L, R, T, And B
Align the application 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 application 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 application 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.

If this attribute is omitted, the content is centered in the browser window.

base attribute

Value

base directory or URL

Description

(Optional) Specifies the base directory or URL used to resolve all relative path statements in the SWF file. This attribute is helpful when you keep SWF files in a different folder from your other files.

menu attribute or parameter

Value

true | false

Template variable: $ME

Description

(Optional) Specifies what type of menu appears when the viewer Right-clicks (Windows) or Command-clicks (Macintosh) the application area in the browser.

true
shows the full menu, which gives the user several options to enhance or control playback.

false
shows a menu that contains only the About Adobe Flash Player 6 option and the Settings option.

The default value is true if this attribute is omitted.

wmode attribute or parameter

Value

Window | Opaque | Transparent

Template variable: $WM

Description

(Optional) Lets you use the transparent Flash content, absolute positioning, and layering capabilities available in Internet Explorer 4.0. For a list of browsers this attribute/parameter supports, see Publishing Flash documents.

Window
Plays the application in its own rectangular window on a web page. Window indicates that the Flash application has no interaction with HTML layers and is always the topmost item.

Opaque
Makes the application hide everything behind it on the page.

Transparent
Makes the background of the HTML page show through all the transparent portions of the application and can slow animation performance.

Opaque windowless and Transparent windowless
Both interact with HTML layers, letting layers above the SWF file block out the application. Transparent allows transparency so that HTML layers below the SWF file might show through if a section of the SWF file has transparency; opaque does not.

The default value is Window if this attribute is omitted. Applies to object only.

allowscriptaccess attribute or parameter

Value

always | never | samedomain

Description

Use allowscriptaccess to let your Flash application communicate with the HTML page hosting it. The fscommand() and getURL() operations can cause JavaScript to use the permissions of the HTML page, which can be different from the permissions of your Flash application. This has important implications for cross-domain security.

always
Permits scripting operations at all times.

never
Forbids all scripting operations.

samedomain
Permits scripting operations only if the Flash application is from the same domain as the HTML page.

The default value that all HTML publish templates use is samedomain.

SeamlessTabbing parameter

Value

true | false

Description

(Optional) Lets you set the ActiveX control to perform seamless tabbing, so that the user can tab out of a Flash application. This parameter works only in Windows with the Flash Player ActiveX control, version 7 and higher.

true
(or omitted) Sets the ActiveX control to perform seamless tabbing: After users tab through the Flash application, the next tab keypress moves the focus out of the Flash application and into the surrounding HTML content or to the browser status bar if nothing can have focus in the HTML following the Flash application.

false
Sets the ActiveX control to behave as it did in version 6 and earlier: After users tab through the Flash application, the next tab keypress wraps the focus around to the beginning of the Flash application. In this mode, you cannot use the tab key to advance the focus past the Flash application.



Comments

Comments are no longer accepted for Flash CS3. Flash CS4 is the current version. To discuss Flash CS3, please use the Adobe forum.

Comments


liquidleaf said on May 3, 2007 at 11:11 AM :
Question about the wmode parameter.

I need to have a flash movie that sits in a div which has an overflow:hidden style. It seems that this works fine in IE but not in FireFox, unless wmode is set to "transparent" or "opaque". The problem is that I need to be able to use fullscreen mode, and this is not available when wmode is transparent or opaque.

Is there a way to have an SWF which appears clipped in Firefox that doesn't use wmode, and therefore can allow FullScreen?

lauren at liquidleaf dot com

 

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flash/9.0/UsingFlash/WSd60f23110762d6b883b18f10cb1fe1af6-7ba7.html