Introduction

SWF Tools provides a lot of components and elements. While it is designed to work straight away when you download and install it you may want to (or need to) download and configure some additional software to make the best use of what it has to offer.

In particular the package that is downloaded from drupal.org doesn't, due to license requirements, include the javascript files for embedding methods like SWF Object 2, and it doesn't include the player files for media players like the JW Media player. To use these features you will need to follow the steps described below.

If you just want to try SWF Tools out, or just want to embed flash content and not use the media player features, then a basic installation is sufficient. The extra packages can be added at any time later.

Basic installation

Simply download the package from the project page, extract the files, and install the module under sites/all/modules/swftools (you could install it in the main module directory, but it is better practice to install contributed modules under sites/all/modules).

After the module has been installed, enable it from the Site building > Modules page. You will see that the SWF Tools modules are all grouped together under SWF Tools for convenience.

The "core" module is simply called SWF Tools and you must enable this one. This provides all the core functions of SWF Tools, and also includes the SWF Tools filter that can be assigned to input formats where you want to allow flash to be added. The core module provides the capability for direct embedding of flash content using a standards compliant version of the <object> syntax. The core package also provides access to a basic mp3 player, and a basic flv player. However, these players provide very limited functionality. SWF Tools is designed to work with a number of full-featured, third-party media players. You can take advantage of SWF Tools support for these players by downloading them from their respective vendors and configuring them to work within the module. See below!

Adding support for JavasScript replacement methods

You can enhance SWF Tools by enabling support for a JavasScript embedding method. SWF Tools is provided with modules to support SWF Object 2 (the preferred replacement technique) but it also includes support for SWF Object 1.5, jQuery Flash Replacement, and UFO (unobtrusive flash object). The latter techniques are more for legacy support and existing sites, and if you want to use JavasScript you should probably consider using SWF Object 2. SWF Object 2 code is also standards compliant.

To add support for a JavasScript method you will first need to download the supporting JavasScript package and add it to the correct location in the directory specified by your version of the module.

Note: File locations have changed between 6.x-2.x and 6.x-3.x

In 2.x and earlier versions, the methods and players go in the SWF Tools module directory, e.g. sites/all/modules/swftools/shared. In version 3.x, they instead go in sites/all/libraries. Refer to this page for details.

2.x and earlier

3.x and later

^* The distribution file swfobject_2_2.zip extracts by default to ~/swfobject/. As mentioned above, SWF Tools requires that the subdirectory be named swfobject2. You will need to rename that subdirectory from swfobject to swfobject2.

After making sure that the necessary JavasScript package has been installed you can then activate the module by going to the Site building > Modules page and activating the appropriate SWF Tools module for the method you want to use.

Finally, you need to tell SWF Tools to use the method now it is available. This is done at the Site configuration > SWF Tools > Embedding settings page. Open the Embedding settings and choose the method you want to use as the default, and save the settings.

Note - you can activate more than one embedding module, and you can change the default setting at any time. So you can try out different embedding methods to see which you prefer.

Adding support for media players

Media player modules are added in much the same way as adding support for embedding methods. You download the required support files from the appropriate website, add them to a sub-directory under modules/swftools/shared, and then activate the appropriate SWF Tools module to enable it.

The media player modules let you add support for flash based mp3 players, flv players and image rotators. Some players just support playback of one file, while others support playlists of several files, or even mixed types.

SWF Tools comes with support for players as listed in the table below. The table provides a link to where you can obtain the support files, and shows where to install the files to.

Note: The table below describes only the SWF Tools 3.x locations. For 2.x and earlier versions, replace sites/all/libraries with the sites/all/modules/swftools/shared as per the note above.

3.x and later

Additional notes about Flowplayer 3:

• Flowplayer 3 will extract to a flowplayer directory by default, but you need to rename this to flowplayer3.
• You need to install all three files if you wish to support streaming video (the rtmp plugin) and audio playback (the audio plugin). Place the plugin files inside your flowplayer3 directory at the same level as the main player (flowplayer-3.x.x.swf).
• You also need to tell the FlowPlayer 3 module what the player filename is, as this changes with each FlowPlayer release. You enter this at Administer > Site configuration > SWF Tools > FlowPlayer 3 (admin/settings/swftools/flowplayer3), under the Player and plugin files
  section.

After making sure that the necessary supporting files have been installed you can then activate the module by going to the Administer > Site building > Modules page and activating the appropriate SWF Tools module for the player you want to use.

Finally, you need to tell SWF Tools to use the player now it is available. This is done at the Administer > Site configuration > SWF Tools > File handling page. Open the File handling section, choose the player that you would like to associate with each type of media, and save the settings.

Note - you can activate as many media player modules as you like, and you can change the default setting at any time. So you can try out different players to see which you prefer!

SWF Tools status page (SWF Tools 6 only)

If when you go to the embedding settings or file handling pages you see Missing - Download here next to a method or player then it means that SWF Tools couldn't find the supporting files that are needed.

Check that you put the support files in the correct location and try the settings page again. If things still don't seem to be working then try the SWF Tools status page at Administer > Reports > SWF Tools status. This will show a series of tables indicating the current settings and status of available embedding methods and players. If a problem is detected then the tables will try to show a helpful message that suggest how to resolve the issue.

The correct placement of the supporting scripts and files is the key to a successful SWF Tools installation. Please make sure to follow the instructions carefully, particularly with regard to where you install the supporting files!