BB FlashBack SDK: FBExportToSWFParams

Passing Parameters to Flash Exports

When you set properties of the FBExportToSWFParams class and export to Flash, the settings of these properties are passed to the exported SWF via FlashVars.  

If the export is embedded in a webpage, the FlashVars are set within the HTML code, e.g.

<OBJECT classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"
codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,0,28;"
WIDTH=960 HEIGHT=624>

...

<param name="flashVars" value="scaleMode=noScale&showToolbar=true&topToolbar=false..." >

<EMBED src="48ksoundtest2_toolbar.swf"
flashVars="scaleMode=noScale&showToolbar=true&topToolbar=false..." >

...

</EMBED>

</OBJECT>

When BB FlashBack SDK performs a Flash export, it generates an additional HTML file that contains code that embeds the SWF file and passes the FlashVars to it. This HTML file is named as the SWF filename passed in to FBMovie::ExportToSWF

When embedding the export in a PDF or other document, FlashVars are set from the application (e.g. Acrobat, Powerpoint) you use to embed the SWF file.

 

List of Properties passed via FlashVars

Property

FlashVar

ScaleMode

scaleMode

AddControlBar

showToolbar

ControlBarPosMode

topToolbar - set to True if the toolbar is above the movie, and false if below it

ShowFullScreen

showFullScreen

And setting ShowFullScreen to True creates an additional parameter in the embedding HTML of the form
<param name="allowFullScreen" value="True">
 

ControlBarAutoHide

autoHide

ShowAutoHide

showAutoHide

ShowTimer

showTimer

ShowTimeline

showTimeline

ShowNextPrev

showNextButton

ShowNextPrev

showPrevButton

ShowFBLogo

showFBLogo

ShowVolumeBar

showVolumeBar

PreviewMode

previewMode

ShowPausedOverlay

showPausedOverlay

PauseByClickingOnMovie

pauseByClickingOnMovie

StartingPlaybackMode

startingPlaybackMode

PreloadPercent

preloadPercent

Also passed in via FlashVars:

fileName: the name of the SWF or FLV file containing the movie, if FLV or multiple SWF export is used.


And 3 strings shown on the playback controls:

str1: string shown at the top of the popup window displayed when the BB FlashBack logo at the right end of the playback controls is clicked.

str2: the string shown at the top of the popup window that opens www.bbflashback.com when clicked

str3: the label for the Auto hide button