• Overview
» New in this Version

• API Index
• Static Methods
• Static Properties
• Instance Methods
• Instance Properties

• Tutorials
• Compatibility
• Version History
• License
• Logic Flow chart

Version 2.2

There are several important changes and new features in FSAPI 2.x compared to 1.x including new methods for embedding players and some old features which are no longer supported. Also the FSAPI is now available under the open source Artistic License. Make sure you read the documentation carefully so you can understand how to modify your coding or sound only SWF to be compatible with FSAPI 2.x, before upgrading your web site.

Add Backing Music Sonification in any Browser
One of the important new features is limited sonification support for any browser that allows plug-in detection, such as MacIE. You can use the convenience of the FSAPI's player detection and embedding to add backing music to a web site for virtually any user with the Flash player.

Embed Graphical SWF
Another new feature is the customEmbedSWF( ) method which allows you to embed graphical SWF or hidden sound only SWF with customized attributes. As an example, you could use this method to embed a SWF with a start and stop sound control graphical interface.

New API Features

• embedSWF( ) and customEmbedSWF( ) static methods.
• customEmbedSWF( ) instance method.
• initiateAutoInstall( ) static method.
• getAttributeValue( ) instance method.
• hasMinPlayer( ) static method.
• hasMinInteractivePlayer( ) static method.
• configuredForInteraction( ) static method.
• engageInteraction( ) static method.
• engageInteraction instance property.
• renamed playback methods according to their ActionScript counterparts. Old style naming, staring with a T, is functional but depreciated.
• new methods for building HTML based load progress messages.

Summary of Changes to FSAPI

• added initiateAutoInstall( ) static method.
• FSAPI now detects HTTPS urls and changes the url in the CODEBASE parameter to use HTTPS as well to avoid browser messages about secure and insecure content on same page.
• added monitorLoadProgress(),onLoadChange() and onLoadComplete() instance methods.
• added playersIndex instance property.
• added embedSWF( ) and customEmbedSWF( ) static methods for all supported browsers.
• added customEmbedSWF( ) instance method for interactive player.
• all embed methods now default to LOOP = true, to comply with standard Flash embedding practice. Previous versions defaulted to LOOP = false.
• added getAttributeValue( ) instance method to read values of embed attributes.
• changed underlying code to support limited sonification for any browser that allows script based player detection.
• added hasMinPlayer( ) and hasMinInteractivePlayer( ) static methods.
• added configuredForInteraction( ) static method.
• added code to detect if ActiveX is enabled (this feature now disabled).
• added engageInteraction( ) static method
• added engageInteraction instance property.
• playerID instance property now starts at 0, instead of 1 to correlate with players[] array.
• removed FlashSound.engage which was made redundant by FlashSound.engageInteraction( ) static method and engageInteraction instance property.
• removed FlashSound.supportedBrowser static property made redundant by hasMinPlayer( ) static method.
• removed embed instance properties which were made redundant by customEmbedSWF( ) method.
• removed TLoaded( ) instance method and muteErrorMsg static property.
• removed ifNotMinPlayer( ) static method.
• renamed playback methods according to their ActionScript counterparts. Old style naming, staring with a T, is functional but depreciated.