Parameters and attributes

The following tag attributes and parameters describe the HTML code created by the Publish command. You can refer to this list as you write your own HTML to display Flash content. Unless noted, all items apply to both object and embed tags. Optional entries are noted. Parameters are used with the object tag and are recognized by Internet Explorer, whereas, the embed tag is recognized by Netscape. Attributes are used with both the object tag and the embed tag. When customizing a template, you can substitute a template variable listed here for the value. See Customizing HTML publishing templates.

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

devicefont attribute/parameter

Value

true | false

Template variable: $DE

Description

(Optional) Specifies whether static text objects for which the Device Font option is not selected will be drawn using a device font anyway, if the fonts needed 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 embed only.

movie parameter

Value

movieName.swf

Template variable: $MO

Description

Specifies the name of the SWF file to be loaded. Applies to object 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 object 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, their quality won'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://active.macromedia.com/flash7/cabs/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 object only.

pluginspage attribute

Value

http://www.macromedia.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 embed 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 are using JavaScript only for browser detection or another purpose unrelated to fscommand()actions, you can prevent Java from starting by setting SWLIVECONNECT to false. You can also force Java to start when you are not using JavaScript with Flash by explicitly setting the SWLIVECONNECT attribute to true. Starting Java substantially increases the time it takes to start a SWF file; set this tag to true only when necessary. Applies to embed 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 browser. If your Flash application is interactive, you may want to let the user initiate play by clicking a button or performing some other 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 Flash 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 during playback of your application. 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 a value based on whether speed or appearance is your top priority:

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.

Autohigh emphasizes playback speed and appearance equally at first 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 in Flash (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 specified in the Flash SWF file. 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 within the browser window when width and height values are percentages.

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

Noborder scales the Flash 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 Flash content visible in the specified area without trying to preserve the original aspect ratio. Distortion may 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 Flash 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 Flash SWF file is positioned within the area defined by the width and height settings. For more information about these conditions, see scale attribute/parameter.

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 Flash 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 Flash SWF file. This attribute is helpful when your SWF files are kept in a different directory from your other files.

menu attribute/parameter

Value

true | false

Template variable: $ME

Description

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

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 About Macromedia Flash Player 6 option and the Settings option.

The default value is true if this attribute is omitted.

wmode attribute/parameter

Value

Window | Opaque | Transparent

Template variable: $WM

Description

(Optional) Lets you take advantage of the transparent Flash content, absolute positioning, and layering capabilities available in Internet Explorer 4.0. This attribute/parameter works only in Windows with the Flash Player ActiveX control.

Window plays the application in its own rectangular window on a web page. Window indicates that the Flash application has no interaction at all 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 may slow animation performance.

Opaque windowless and Transparent windowless both interact with HTML layers, allowing layers above the SWF file to block out the application. The difference between the two is that Transparent allows transparency so that HTML layers below the SWF file might show through if a section of the SWF file has transparency.

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

allowscriptaccess attribute/parameter

Value

always | never | samedomain

Description

Use allowscriptaccess to enable your Flash application to communicate with the HTML page hosting it. This is required because fscommand() and getURL() operations can cause JavaScript to use the permissions of the HTML page, which may 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 used by all HTML publish templates is samedomain.