Visit SlideShowPro.net  Community Forums
SlideShowPro Support Wiki
  
SWF

Parameters

Note: As of June 28, 2011, we are no longer selling the SlideShowPro Player SWF product. We will continue to provide support (and this documentation) for those who purchased it prior to the aforementioned date. Click 'email support staff' in the left column if you have any questions or concerns.

The SlideShowPro player used in Standalone has nearly 150 parameters that control every aspect of the player -- from color to behavior to assigning a data source. We'll explain here how they're accessed and edited.

Parameters

A complete list of player parameters and their acceptable values is available here.

For a more detailed overview of what each parameter controls / modifies, we recommend checking out the SlideShowPro player user guide.

Customization

Once you know which parameters you want to customize, there are two methods for doing so: XML and flashvars. Which you use depends on the method you're most comfortable with and how many parameters you plan on editing.

XML

The default method for assigning parameters is through an external XML file. This keeps parameters abstracted from player embed code so you can easily swap or dynamically assign settings.

To see an example of a param.xml file, open the Standalone archive you downloaded when purchasing the player and look in Examples/Default. The param.xml file there contains all the default settings for the player.

By default, Standalone will automatically request a file named "param.xml" from the same directory where the HTML document embedding the SWF is located. If you want to assign/load "param.xml" (or whatever you want to name it) from a different location, you'd modify the path with a paramXMLPath flashvar in the player embed code, like so:

var flashvars = {
	paramXMLPath: "http://yoursite.com/path/to/param.xml"
}

Standalone will then request the parameter file from the new location.

Flashvars

"Flashvars" is shorthand for "Flash variables" and is the method by which variables are passed into SWF files. Standalone leverages flashvars to assign player parameters.

Because flashvars isn't the default method for applying variables (see "XML" above), we must instruct Standalone not to request an XML file. We do this with a flashvar named loadParams set to "false", like so:

var flashvars = {
	loadParams: "false"
}

In order for a variable to be recognized by the SWF as a parameter that belongs to Standalone, it must be named exactly the same as the parameter. For example, if you wanted to modify Standalone's "navAppearance" parameter to hide the navigation, you'd assign a navAppearance variable, like so:

var flashvars = {
	loadParams: "false",
	navAppearance: "Hidden"
}

navAppearance would then be assigned to Standalone and the navigation would be hidden in the slideshow.

To assign more than one variable, simply drop a line and add another, like so:

var flashvars = {
	loadParams: "false",
	navAppearance: "Hidden",
	captionAppearance: "Hidden"
}

Note: When editing flashvars, always make sure that every variable except the last includes a comma at the end!

Can I use both XML and Flashvars?

Yes. If you are loading a param.xml file but want to override any of the values contained therein, simply declare the variable you wish to override as a flashvar (without turning off XML loading). Like so:

var flashvars = {
	navAppearance: "Hidden"
}

The navAppearance value declared in the flashvar will then override the value loaded in the XML file.

Page last modified by tdominey on July 13, 2010, at 09:45 PM
© 2011 SlideShowPro. All Rights Reserved.