Flash Plugin

Name Flash Plugin
Vendor Bob Swift and other contributors
Authors Bob Swift
Homepage http://confluence.atlassian.com/display/CONFEXT/Flash+Plugin
Issue Management http://developer.atlassian.com/jira/browse/flash
Continuous Integration n/a
Categories Content Macros
Most Recent Version 3.0
Availability Confluence v2.2 to v3.0.0_01
State Stable
Support Unsupported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/CONFEXT/Flash+Plugin
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/confluence/flash-plugin/trunk
Download JAR flash-plugin-3.0.jar

Additions and corrections to above

Confluence testing tested on 2.2.8 and 2.3dr2
JVM requirements Java 1.4 and above
Installation requirements Confluence Repository Client
or upload from Confluence's administration console.
Cannot be installed in /WEB-INF/lib

Description


This macro is used to show flash based content in a confluence page. The flash file can exist in confluence page attachment or confluence home's folder.


Flash support in Confluence 2.0

Confluence 2.x has native support for flash - see Release Notes 2.0. This macro has additional capabilities.

Flash SWFObject Macro

As another alternative, the macro Flash SWFObject Macro embeds Deconcept's FlashObject javascript library.

Documentation

  • Help available in the notation guide.

Parameters

  • file - Location of flash file. One of the file or url parameters must be specified.
    • filename - Data is read from the file located in confluence home directory/flash/filename. Subdirectories can be specified.
    • ^attachment - Data is read from an attachment to the current page.
    • page^attachment - Data is read from an attachment to the page name provided.
    • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.
  • url - URL of flash file. Only used if file parameter is not provided.
    • http://... - Data is read from the URL specified.
  • width - The table width in pixels. Default is 100%.
  • height - The table height in pixels. Default is 100%.
  • show - Default is to show the flash content on the page. Set show=link to show as a link to the content.
  • title - Title to use for the link when show=link is specified. Default is the name of the flash file or url.
  • base - [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.

Other parameters about flash (optional, case insensitive)

  • ID - Identifies the Flash movie to the host environment (a web browser, for example) so that it can be referenced using a scripting language. OBJECT-specific.
  • NAME - Identifies the Flash movie to the host environment (a web browser, typically) so that it can be referenced using a scripting language such as JavaScript or VBScript. EMBED-specific.
  • SWLIVECONNECT - (true, false) Specifies whether the browser should start Java when loading the 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 to work.
  • PLAY - (true, false) Specifies whether the movie begins playing immediately on loading in the browser. The default value is true if this attribute is omitted.
  • LOOP - (true, false) Specifies whether the movie repeats indefinitely or stops when it reaches the last frame. The default value is true if this attribute is omitted.
  • 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.
  • QUALITY - (low, high, autolow, autohigh, best )
  • 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.
  • ALIGN - (l, t, r, b)
    • Default centers the movie in the browser window and crops edges if the browser window is smaller than the movie.
    • Left, Right, Top, and Bottom align the movie along the corresponding edge of the browser window and crop the remaining three sides as needed.
  • 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.
  • WMODE - (window, opaque, transparent) 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.
  • 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. This attribute does not affect the background color of the HTML page.

These are only some of the parameters. For a full list, see http://www.adobe.com/cfusion/knowledgebase/index.cfm?id=tn_12701

Usage

{flash:file=^example.swf}
{flash:file=example.swf}
{flash:file=example.swf|play=false|loop=false|bgcolor=#00FF00}
{flash:file=EXAMPLE:Example page^example.swf|show=link|title=Flash example}
{flash:url=http://.../example.swf}
{flash:file=^example.swf|base=http://www.yourdomain.com/download/attachments/1376344/}

Labels

embed embed Delete
movie movie Delete
video video Delete
plugin plugin Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Aug 30, 2005

    RefuX Zanzeenbarr says:

    Just recorded a screencast, wanted to put it up on our internal Confluence site,...

    Just recorded a screencast, wanted to put it up on our internal Confluence site, find your plugin, works great! I love you man!

  2. Feb 06, 2006

    Wes Williams says:

    This plugin is working great for me in fire fox but not internet explorer. Anyo...

    This plugin is working great for me in fire fox but not internet explorer. Anyone seen this issue? I did not see a jira issue for this. Is there a way to make it work? The native support does not seem to offer sizing (height, width) which I need. Thanks, Wes

    1. Feb 06, 2006

      Bob Swift says:

      I agree, it doesn't seem to work in IE . I will try to get a fix out shortly.

      I agree, it doesn't seem to work in IE . I will try to get a fix out shortly.

      1. Feb 06, 2006

        Bob Swift says:

        A temporary patch to get IE working is [^scripting-plugins-2.2.jar]. Wo...

        A temporary patch to get IE working is [^scripting-plugins-2.2.jar]. Works for attachments to page and url. Still not for all IE cases - will need more time to figure that out.

        1. Feb 07, 2006

          Wes Williams says:

          WOW, That was fast and it fixed the issue I was having. Thanks you very much.

          WOW, That was fast and it fixed the issue I was having. Thanks you very much.

          1. Feb 07, 2006

            Bob Swift says:

            IE doesn't like the default width and height. The workaround is to explicitly s...

            IE doesn't like the default width and height. The workaround is to explicitly set width and height. SCRP-52 tracks the issue.

      2. Feb 15, 2006

        Bob Swift says:

        This should be fixed with released 2.2 version of the plugin that is now availab...

        This should be fixed with released 2.2 version of the plugin that is now available. Although, still can't get IE to accept width and height values with a %. Must use pixel for size.

  3. Feb 07, 2006

    Alain Moran says:

    It would be useful if this plugin could support flashvars, since many of my movi...

    It would be useful if this plugin could support flashvars, since many of my movies will want to take parameters defined by the HTML that embeds them http://www.macromedia.com/cfusion/knowledgebase/index.cfm?id=tn_16417

    Another useful addition would be the optional inclusion of the CLASSID/PLUGINSPAGE so that you as the developer could decide whether the user should be automatically redirected to macromedia and have it install the latest player (I often remove these elements, since I tend to make most of my flash movies F6 compatible and dont want to disturb users with having them need to download the F8 player)

    1. Feb 07, 2006

      Bob Swift says:

      Thanks for the comments. I believe the flashvars should work today. All macro ...

      Thanks for the comments. I believe the flashvars should work today. All macro parameters (not explicitly defined) are passed through to flash. Try "FlashVars=foo=Hello%20World" as a macro parameter and it should go through. See if this works for you and let me know. Regarding your second point, write up an issue please.

      1. Feb 07, 2006

        Guy Fraser says:

        From a discussion on the conf-user mailing list, Confluence 2.1.4 will bring bac...

        From a discussion on the conf-user mailing list, Confluence 2.1.4 will bring back the ability to have spaces inside macro parameter values so as of Confluence 2.1.4 onwards you'll be able to use "FlashVars=foo=Hello World" hopefully

        1. Feb 19, 2006

          Alain Moran says:

          Flash should accept flashvars=myStr=Hello+World already, since this is the forma...

          Flash should accept flashvars=myStr=Hello+World already, since this is the format that spaces are encoded when loading data through a loadvars object, although I must admit I havent actually tried it!

          Failing that, using %20 in combination with the unescape() global function should allow you to workaround this for now.

  4. Apr 08, 2006

    didier says:

    I created a dashboard using the flash macro and the FusionCharts flash charts an...

    I created a dashboard using the flash macro and the FusionCharts flash charts and I get a blank page when I try to print it.
    I can manage to print  each chart individually from the macromedia prompt but not the entire page.  Anyone has an idea about the origin of this behaviour ?  Normal Flash behaviour ?

    Tx in advance for any help

  5. Jun 02, 2006

    Horacio Blanco says:

    Very cool plugin! When using it over HTTPS IE clients get a security popup "This...

    Very cool plugin! When using it over HTTPS IE clients get a security popup "This page contains both secure and nonsecure items".

    All it takes to fix this is to change the object codebase from:

    codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,29,0"

    to:

    codebase="https://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,29,0"

    Thanks and great job!

    1. Jul 05, 2007

      Mark Page says:

      Hi,  How do you get setting the codebase to an https endpoint to work? I h...

      Hi, 

      How do you get setting the codebase to an https endpoint to work? I have added it as a param in the markup but this seems to just add a param after the object declaration which references a codebase with a http endpoint so I still get mixed mode message popup/warning.

      Appreciate any help as otherwise this plugin does just what I need.

      Regards. 

  6. Feb 02, 2007

    Daniel Hannum says:

    I'm having trouble making the macro work from the scripts directory. I have a si...

    I'm having trouble making the macro work from the scripts directory. I have a simple swf file, and I put it both as an
    attachment on the page and also in the scripts directory.

    Both 

    !test.swf! and
    flash:file=^test.swf

     works on my page, but
    flash:file=/test.swf
     displays a big blank spot on the page. I have confirmed that the scripts directory is working in general (I can display an excel file out of the same directory)
    There aren't any errors on the page or in the log. Ideas? Why can't it load a swf file from the scripts directory?

    1. Feb 02, 2007

      Daniel Hannum says:

      Confluence version 2.2.8, forgot to mention

      Confluence version 2.2.8, forgot to mention

      1. Feb 02, 2007

        Bob Swift says:

        Try the flash directory... filename - Data is read from the file located in con...

        Try the flash directory...

        filename - Data is read from the file located in confluence home directory/flash/filename. Subdirectories can be specified.

        1. Feb 02, 2007

          Daniel Hannum says:

          well yeah, it works great when you follow the directions. Sorry

          well yeah, it works great when you follow the directions. Sorry

  7. Apr 12, 2007

    Elliot Braham says:

    I'm trying to use a Flash FLV player that requires arguments to specify where th...

    I'm trying to use a Flash FLV player that requires arguments to specify where the FLV is located.

    Is there anyway to specify arguments using this plugin?

    1. Apr 12, 2007

      Bob Swift says:

      The macro passes through parameters it does not understand like the optional fla...

      The macro passes through parameters it does not understand like the optional flash parameters. So just try it. View the HTML source after and make sure its what you expect.

  8. Apr 14, 2007

    Martin Cleaver says:

    Should this work with FLV? You have no FLV examples. http://www.boutell.com/ne...

    Should this work with FLV? You have no FLV examples.

    http://www.boutell.com/newfaq/creating/video.html suggests I need both FLV, SWF files on the server.

    Thanks, Martin.

    1. Apr 14, 2007

      Bob Swift says:

      I have no idea! And no time to investigate. Feel free to investigate and implem...

      I have no idea! And no time to investigate. Feel free to investigate and implement any necessary changes.

      1. Apr 15, 2007

        Martin Cleaver says:

        Well, it seems to partially work on my server. I'd like to test it elsewhere: c...

        Well, it seems to partially work on my server.

        I'd like to test it elsewhere: currently I see the content only partially loading.

        Thanks, Martin. 

        1. Apr 18, 2007

          Martin Cleaver says:

          Ok. Resolved the instructions didn't mention the base parameter, (but do now). ...

          Ok. Resolved the instructions didn't mention the base parameter, (but do now).

          Is there a way to write the base parameter using a variable rather than hardcoded?

          1. Apr 18, 2007

            Bob Swift says:

            Thanks for figuring this out. Variable? Well perhaps. Does the Run Plugin do ...

            Thanks for figuring this out. Variable? Well perhaps. Does the Run Plugin do what you want?

  9. Apr 27, 2007

    Martin Cleaver says:

    Anyone know of a way to determine whether a sufficient version of Flash is insta...

    Anyone know of a way to determine whether a sufficient version of Flash is installed? FLV files require flash 8, for example.

    http://blog.deconcept.com/swfobject/ has a js library for this sort of thing.

    1. May 07, 2007

      Martin Cleaver says:

      Although I dislike to duplicate, I've released Flash SWFObject Macro as a means ...

      Although I dislike to duplicate, I've released Flash SWFObject Macro as a means to embed the work at Deconcept.

  10. Sep 21, 2007

    Matti Kiviharju says:

    If I add a Flash Application that runs flv video it works but external control f...

    If I add a Flash Application that runs flv video it works but external control flash file not appear to application.

  11. Oct 16, 2007

    dc says:

    Bob, does this plugin only support flash?  What is used to support mpg, av...

    Bob,

    does this plugin only support flash?  What is used to support mpg, avi or wmv?

  12. Dec 10, 2007

    Tan Kheng Yeow says:

    I am currently stuck with a problem. Is mx.service.WebServiceClasses from action...

    I am currently stuck with a problem. Is
    mx.service.WebServiceClasses from actionscript 2.0 supported by the
    plugin?

    I am able to establish a connection through this WebService class using
    the standalone SWF but after uploading it to the confluence home
    directory, connection to my server through this WebService class was
    unsuccessful.

    The log message which I got from Log.VERBOSE was "faulting previously
    queued call".

    I would really appreciate all the help and advice.

  13. Dec 13, 2007

    Andy Brook says:

    I just tried this on Ubuntu 7.10 with output from gtk-recordMyDesktop, using ffm...

    I just tried this on Ubuntu 7.10 with output from gtk-recordMyDesktop, using ffmpg to transcode from ogg format to flv format. Unfortunately, Flash 9 doesn't like it, and it wont play in this plugin or in a Browser period.

    However, I have been able to get the generated flv files playing in the JW player.

    There isn't anything integrating the jwplayer for confluence, as the only way to use it otherwise is to deploy next to confluence and use fixed URLs...

    posting this for information... (any spare time bob?!)

    1. Dec 14, 2007

      Andy Brook says:

      I got the FLV playing a treat through jwplayer using the following: User Macro...

      I got the FLV playing a treat through jwplayer using the following:

      User Macro 'flvplayer'

      <embed src="http://staticserver/jwplayer/mediaplayer.swf" allowfullscreen="true" width='$param1' height='$param2' allowscriptaccess="always" flashvars='&file=$param0' >
      </embed>
      

      Usage is

      {flvplayer:http://server/fullurlto/file.flv|800|600}
      

      You'll need to extract the jwplayer stuff onto a static webserver somewhere.

      I have yet to figure out how to set the background color so black borders dissapear.

  14. Sep 08, 2008

    Daniel O'Connor says:

    Hi,  Trying to imbed a swf file on a page in confluence 2.8 (using FF3.1)....

    Hi,

     Trying to imbed a swf file on a page in confluence 2.8 (using FF3.1). Having some issues.

     My file is automatically sized at about a quarter of the size, so I get to see the bottom right quarter of whatever I actually want to watch. Not ideal.

     The play=false seems to work fine, but menu=true doesn't give me anything in particular, so there are no tools on the page to indicate to users that it's a fully functional video. Right clicks work in it's place, but this is probably above most of our users.

    Also, the drop down menus in confluence drop behind the macro, which also isn't ideal.

    I've tried experimenting with parameters, but haven't had any luck so far.

  15. Sep 10, 2008

    Thomas Schmidt says:

    We would like to use Confluence to make some flash videos available. Therefore ...

    We would like to use Confluence to make some flash videos available.

    Therefore I use the FLVPlayback Component to add some control buttons to the flash video.

    When I select the swf file on the attachments tab it works fine. On the page itself it doesn't.

  16. Oct 02, 2008

    Tomi Strugar says:

    I just want a really easy way to show flash files without having to set up addit...

    I just want a really easy way to show flash files without having to set up additional servers, etc. So sorry to cross post, but has anyone been able to get the Flash SWFObject Macro to work (see my comments on that page)? If so can you please put detailed instructions as comments on that macro's page? TIA

  17. Oct 09, 2008

    Josh Molina says:

    I have a .swf image with a hot-spot on it.  I hard-coded the URL (based on ...

    I have a .swf image with a hot-spot on it.  I hard-coded the URL (based on a wiki page) which works perfect.

     The only problem is that it opens in a new window.

    Is there a way to specify the plug in to open in the same window?

    Thanks,

    Josh

    P.S. I'd hate to use the html embed option, but if I have to, I have to.

    Thank you!

  18. Oct 14, 2008

    Glenn Engel says:

    Hi,  I had to tweak the source a bit to get it to pass the id= parameter t...

    Hi,

     I had to tweak the source a bit to get it to pass the id= parameter to the <object> tag.  It needs to be passed in a manner similar to height and width.  The Jira link doesn't work or I'd add a Jira issue for it.

     There are a lot of other 'optional' fields but id is particularly important as it allows the flash movie to be referred to by javascript.  This tag is also noted as 'Object tag only' where the other optional tags can be put into the params section (which the code does properly)

    Since id is 'object only' please add it to the tags put into the object tag.

     Thanks for the macro!

    --

    Glenn

    1. Oct 15, 2008

      Glenn Engel says:

      One extra note I didn't mention.  'id' is spelled 'name' on the embed tag.&...

      One extra note I didn't mention.  'id' is spelled 'name' on the embed tag.  That is, when adding to <object> it is id=value while for <embed> is is name=value.

  19. Jan 23

    jamiep77 says:

    I have the latest version of the Flash plugin installed, and can't see any embed...

    I have the latest version of the Flash plugin installed, and can't see any embedded SWF files in IE 7.  (Firefox works fine.)  Is anyone else having this problem?

    1. Feb 06

      Haddon Fisher says:

      I am also having this problem with IE6. I have Flash 10.0.12.36 and I can view v...

      I am also having this problem with IE6. I have Flash 10.0.12.36 and I can view videos in Firefox but in IE all I see is a blank screen. Users who have Flash 9 are able to view in both browsers. Any idea why this is happening?

    2. Feb 06

      Glenn Engel says:

      I am having the same problem.  Works fine with firefox though. Here is wha...

      I am having the same problem.  Works fine with firefox though.

      Here is what I've discovered.  If I place my swf file into my install dir/confluence directory and hard reference it it works OK which I assume causes it to be delivered by tomcat.

      Looking at the difference between what tomcat returns and what confluence returns the only difference I can spot is the content type returned by confluence is

      Content-Type: application/x-shockwave-flash;charset=UTF-8

      while tomcat returns

      Content-Type: application/x-shockwave-flash

      A binary compare of the two shows they are identical.

      It would appear the charset=UTF-8 is causing the IE flash plugin fits.  Is there a way to turn off the charset= argument from confluence for swf files?

       wget --save-headers http://localhost:8080/calculator.swf -O - | head
      --16:16:09--  http://localhost:8080/calculator.swf
                 => `-'
      Resolving localhost... 127.0.0.1
      Connecting to localhost|127.0.0.1|:8080... connected.
      HTTP request sent, awaiting response... 200 OK
      Length: 10,527 (10K) [application/x-shockwave-flash]
       0% [                                                                                                                     ] 0             --.--K/s             HTTP/1.1 200 OK
      Server: Apache-Coyote/1.1
      ETag: W/"10527-1173985166000"
      100%[====================================================================================================================>] 10,527        --.--K/s
      Last-Modified: Thu, 15 Mar 2007 18:59:26 GMT
      Content-Type: application/x-shockwave-flash
      Content-Length: 10527
      Date: Sat, 07 Feb 2009 00:16:09 GMT
      Connection: keep-alive
      CWSExÚ­[\É÷Ý$@ÐBWº¡I¨*F@:4
                                ¡
                                 iR»
                                   bA¥ZQÀvÆ`Á½*âY°ñݨ÷óî÷ûãÇäíîÌ{óÞ/Iv
      16:16:09 (17.50 MB/s) - `-' saved [10527/10527]
      
      glenne@lksgre-xp /cygdrive/c/temp
      $ wget --save-headers http://localhost:8080//download/attachments/3538984/calculator.swf?version=2 -O - | head
      --16:16:24--  http://localhost:8080//download/attachments/3538984/calculator.swf?version=2
                 => `-'
      Resolving localhost... 127.0.0.1
      Connecting to localhost|127.0.0.1|:8080... connected.
      HTTP request sent, awaiting response... 200 OK
      Length: 10,527 (10K) [application/x-shockwave-flash]
      100%[====================================================================================================================>] 10,527        --.--K/s
      HTTP/1.1 200 OK
      Server: Apache-Coyote/1.1
      X-Confluence-Request-Time: 1233965785041
      Last-Modified: Sat, 07 Feb 2009 00:04:53 GMT
      ETag: "1233965093000"
      Content-Disposition: inline; filename="calculator.swf"
      Expires: Thu, 01 Jan 1970 00:00:00 GMT
      Cache-Control: max-age=0, must-revalidate
      Content-Type: application/x-shockwave-flash;charset=UTF-8
      Content-Length: 10527
      16:16:25 (44.59 MB/s) - `-' saved [10527/10527]
      
      
    3. Feb 09

      Glenn Engel says:

      This appears to be directly related:  http://jira.atlassian.com/browse/CONF...

      This appears to be directly related:  http://jira.atlassian.com/browse/CONF-13974