If this plugin is installed you will see a Flash movie displayed:
General syntax
%EMBEDFLASH{"filepath" <optional attributes> }%
Flash attributes
Pass Flash movie attributes within the %EMBEDFLASH{...}% accolades (all values within quotes). When a particular parameter is not specified, the default value will be used (see table below).
<-- -->
Argument
Comment
Example
Default value
Required attributes
filepath
Filepath of the movie; should have suffix .swf
mypath/flashmovie.swf
General attributes
width
Width of Flash movie in pixels, or a percentage. 100% means one hundred percent of the available width on the page.
"50%" or "500px"
"100%"
height
Height of Flash movie in pixels, or a percentage. 100% means one hundred percent of the available height on the page.
"50%" or "500px"
"100%"
bgcolor
Background color of Flash movie in hex string. When omitted, no background color will be specified and the background color of the Flash movie will be used.
"#cccccc"
""
version
Flash Player (plugin) version needed to view movie
"8"
"9"
Advanced attributes
align
Default centers the movie in the browser window and crops edges if the browser window is smaller than the movie. l (left), r (right), t (top), and b (bottom) align the movie along the corresponding edge of the browser window and crop the remaining three sides as needed.
"l", "r", "t", "b"
""
salign
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.
Should right-click on Flash movie show a (default) menu? Note that with the Flash 7 player the menu cannot be removed.
"true" or "false"
"true"
id
ID of Flash movie; for general use not necessary to specify.
"movie2"
the filename without suffix, eg. flashmovie
wmode
Sets the Window Mode property of the Flash movie for transparency, layering, and positioning in the browser. 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.
"window", "opaque" or "transparent"
""
play
Specifies whether the movie begins playing immediately on loading in the browser.
"true" or "false"
"true"
loop
Specifies whether the movie repeats indefinitely or stops when it reaches the last frame.
"true" or "false"
"true"
allowscriptaccess
Controls the ability to perform outbound scripting from within a Flash SWF. When allowScriptAccess is never, outbound scripting always fails. When allowScriptAccess is always, outbound scripting always succeeds. If allowScriptAccess is sameDomain (it is supported in SWFs from Flash Player 8), outbound scripting is allowed only if the SWF file resides in the same domain as the hosting web page.
"sameDomain", "always" or "never"
"sameDomain"
fullscreen
Enabled scriptable fullscreen mode. An overlay dialog box will appear when the movie enters full-screen mode, instructing the user how to exit and return to normal mode. The dialog box appears for a few seconds and then fades out.
"true" or "false"
"false"
base
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.
any directory URL, or empty string ""
"%ATTACHURL%/"
swliveconnect
Specifies whether the browser should start Java when loading the Flash Player for the first time.
"true" or "false"
""
Note that this plugin writes object and embed tags using Javascript to prevent annoying popup windows.
More information on Flash OBJECT and EMBED tag attributes (Adobe TechNote).
More examples
Image folder
The images are placed in separate folders. The Flash movie is also in its own folder. Adjust the filepath and base attribute to the Flash file:
Optionally, run EmbedFlashPlugin_installer to automatically check and install other TWiki modules that this module depends on. You can also do this step manually.
Alternatively, manually make sure the dependencies listed in the table below are resolved. None
Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
Version 1.1 - Added attributes. Write HTML embed/object tags with Javascript to prevent popup windows. If no javascript is available the noscript tag is used.
02 Nov 2006:
Version 1.01 - Updated Flash sample, small changes to documentation.