Inventua Flash Player for DotNetNuke

The Inventua FlashPlayer Module for DotNetNuke plays Macromedia Flash files in your DotNetNuke portal.

Try Before You Buy
All of Inventua's DNN modules are available on a try before you buy basis. You can download them freely from Inventua, and try them out for as long as you like. If you are happy with the product, you can buy it at SnowCovered.

Installation
The installation zip file is configured as a DotNetNuke "private assembly". To install Inventua DNN FlashPlayer to your DNN portal, log in as the DNN host user "host" and use the DNN Module Definitions page to upload the module. 

Compatibility
This module has versions for with DNN version 2.1.2. and 3.0/3.1/4.x. 

Microsoft Windows: Internet Explorer 6, Firefox 1.0, Mozilla 1.6  
Apple OS X: Safari 1.2.3, Mozilla 1.6, Netscape 7.1, Opera 6.0.3.
 
Configuration Options

Once you create a FlashPlayer instance, select the Options menu item from the module settings menu to display the Options page.

Movie Use 'Movie' to select the location (URL) of the movie to be loaded, or select a file from your DNN portal content files. If you use using this option in a skin, the option name is "movie".
Target Version Use 'Target Version' to select the Macromedia Flash Player version you want to target. If your Flash media was created in Flash 8, you should choose 'Version 8'.  If you use using this option in a skin, the option name is "targetversion", and you should use the value(s) 7 or 8.
Enable Filename Localization If enabled, the FlashPlayer module tries to find a filename matching your selection, plus a locale or language suffix. The module first looks for an exact locale code match, then does a wildcard match on the language name (so that for example, if you are using locale en-AU, any of en-US, en-GB, en-ZZ would match). The localized filenames need to be named originalfilename.locale.extension. For, example, for a filename of "test.swf", the Spanish-Mexico version would be named test.es-MX.swf).  If you use using this option in a skin, the option name is "EnableLocalizeFilename", and you should use the values "true" or "false".
Width Width of the movie in pixels, or as a percentage of the browser window.  If you use using this option in a skin, the option name is "width".
Height Height of the movie in pixels, or as a percentage of the browser window.  If you use using this option in a skin, the option name is "height".
Play Check (tick) this checkbox to make the movie start playing immediately once the page is loaded (default).  If you use using this option in a skin, the option name is "play", and you should use the values "true" or "false".
Loop Check (tick) this checkbox to repeat the movie indefinitely (default).  If you use using this option in a skin, the option name is "loop", and you should use the values "true" or "false".
Menu

Check (tick) this checkbox to show the full flash menu if the user right-clicks the movie - this includes a variety of options to enhance and control playback (default).  Un-check the checkbox to show only the "settings" and "about flash" options.  If you use using this option in a skin, the option name is "menu", and you should use the values "true" or "false".

Quality

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 the 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 actual frame rate drops below the specified frame rate, anti-aliasing is turned off to improve playback speed. Use this setting to emulate the View > Antialias setting in Flash.

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

High - favors appearance over playback speed and always applies anti-aliasing. If the movie does not contain animation, bitmaps are smoothed; if the movie 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.

If you use using this option in a skin, the option name is "quality", and you should use the values "Low", "Autolow", "Autohigh", "Medium", "High", or "Best".

Scale

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 (default).

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.

If you use using this option in a skin, the option name is "scale", and you should use the values "showall", "noborder" or "exactfit".

Align

Leave blank to center the movie in the browser window and crop 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.

If you use using this option in a skin, the option name is "align", and you should use the values "left", "top", "right" or "bottom".

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.

If you use using this option in a skin, the option name is "salign", and you should use the values "left", "top", "right", "bottom", "top-left", "top-right", "bottom-left" or "bottom-right".

WMode

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.

Note: This property is not supported in all browsers and platforms. For more information about WMODE see How to make a Flash movie with a transparent background (TechNote 14201).

If you use using this option in a skin, the option name is "wmode", and you should use the values "window", "opaque" or "transparent".

Background color

Specifies the background color of the movie in #RRGGBB format. Use this attribute to override the background color setting specified in the Flash file. This attribute does not affect the background color of the module, skin or portal.

If you use using this option in a skin, the option name is "backgroundcolor".

Flashvars

Used to send root level variables to the movie. The format of the string is a set of name=value combinations separated by '&'. Browsers will support string sizes of up to 64KB (65535 bytes) in length. For more information on FlashVars, please refer to Using FlashVars to pass variables to a SWF (Macromedia TechNote 16417).

The FlashVars variables can contain the following special values, which are replaced at run time:

[$\dnnportalid]:  Portal id (numeric) of the portal that the module is in.
[$\dnnmoduleid]:  Module id of the module instance.
[$\dnnuserid]:  User ID of the logged-in user.
[$\dnnusername]:  User name (login name) of the logged in user.
[$\dnnuserfullname]:  Full name (firstname and lastname) of the logged in user.
[$\dnnuseremail]:  Email address of the logged in user.

If you use using this option in a skin, the option name is "flashvars".

No Player Image

Image to display if the FlashPlayer detects that the Macromedia Flash Player is not installed.

If you use using this option in a skin, the option name is "noplayerimage".

No Player URL URL to navigate to is the user clicks the "no player" image.  If you use using this option in a skin, the option name is "noplayerurl".
No Player Target

Target page to use for the No Player URL. Use _blank to always open a new window.

If you use using this option in a skin, the option name is "noplayertarget".

Disable Codebase

Disables automatic download of the Flash player by suppressing the CODEBASE and PLIGINSPAGE elements.  The default value is "false".

If you use using this option in a skin, the option name is "disablecodebase", and you should use the values "true" or "false".

Allow Script Access

Controls whether to allow outbound scripting from within the flash (swf) file.

If you use using this option in a skin, the option name is "allowscriptaccess", and you should use the values "Never", "SameDomain" or "Always".  The default is "Never".  For backward compatibility, the values "True" and "False" will also work, and will set the value to "SameDomain" or "Never".

Use Device Font

If set and the font is installed on the system viewing the Flash movie, the font information installed on the system will be used. Text will be aliased (rough) regardless of the value of the 'quality' setting. If the font is not installed on the system, the text will be anti-aliased (smooth) as long as the quality of the movie is set at high.

If you use using this option in a skin, the option name is "usedevicefont", and you should use the values "true" or "false".


This information is sourced from Macromedia. Refer to http://www.macromedia.com/support/flash/ts/documents/tag_attributes.htm for more information on Macromedia Flash options.

Using FlashPlayer as a skin object

The Inventua FlashPlayer is installed as both a module and a skin object automatically when you install it using the DNN file manager.  Add the FlashPlayer to your portal skin by including a [INVFLASHPLAYER] token.  You can set the properties of the control using a skin.xml file as documented in the DNN Skinning Guide, Appendix B.  The "Configuration Options" section above describes the available properties. 

For example, to configure the FlashPlayer to display a flash movie called "mymovie.swf", use the following xml in yourskin.xml:


<Objects>
  <Object>
    <Token>[INVFLASHPLAYER]</Token>
    <Settings>
      <Setting>
        <Name>Movie</Name>
        <Value>mymovie.swf</Value>
      </Setting>
    </Settings>
  </Object>
</Objects>

 

Using QueryString items to control the FlashPlayer
If you pass querystring values matching FlashPlayer attribute names to a page, the FlashPlayer will use the values you pass.  For example, you could use the URL http://yoursite.com?movie=playthis.swf to play "playthis.swf".

Conditions of use

Permission is hereby granted, on a Try-before-you-buy basis, to any person obtaining a copy of the Inventua DNN FlashPlayer module and associated documentation files (the "Software"), to use the Software without restriction, including the rights to use, copy or otherwise use the software for commerical or non-commercial use, but excluding any rights to reverse engineer or remove Inventua logos and licensing information. This permission does not imply or otherwise grant any rights to any other Inventua intellectual property including but not limited to logos, trademarks, documentation and software products.

THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

This help file, the accompanying software and other materials supplied with the software are Copyright © Inventua, 2004-2008. All Rights Reserved.

About Macromedia Flash
The Inventua DNN FlashPlayer Module plays Macromedia Flash files. For more information on Macromedia and Macromedia Flash, visit http://www.macromedia.com.

About DotNetNuke
The Inventua DNN FlashPlayer Module is a DotNetNuke portal module. For more information on DotNetNuke, visit http://www.dotnetnuke.com.

About Inventua
Inventua provides software tools for information technology organisations that facilitate and maximise synergy and cohesion between development, support, marketing and management teams, improves software product quality and helps information technology organisations to provide great products and great support. Visit Inventua on the web at http://www.inventua.com