Back
Products

FAQ
User guide
Tips
API
- Constructor
- Events
- Events (AS2)
- Methods
- Parameters
- EXTRAS
- ActionScript parameter list
Version history

Flash component Lightroom plugin SWF
Using without Director

Additional support

Company

Other Languages:
EN
ES ?
FR ?
IT ?

SlideShowPro Player

Parameters

Document player compatibility
SlideShowPro Director
SlideShowPro Player SWF
SlideShowPro Player for Flash
SlideShowPro Player for Lightroom

The SlideShowPro Player has over 100 parameters that control everything from color to behavior to playback. Parameters with values or behavior that is different between products incorporating the SlideShowPro Player are noted.

Quick Index: Loading...

albumBackgroundAlpha

A number that sets the alpha (transparency) value of each album background in the gallery. Setting this to 0 effectively removes each album's background.

Default values

SlideShowPro Director 1
SlideShowPro Player SWF 1
SlideShowPro Player for Flash (AS3) 1
SlideShowPro Player for Flash (AS2) 100
SlideShowPro Player for Lightroom 100

Acceptable parameters

SlideShowPro Director 0-1
SlideShowPro Player SWF 0-1
SlideShowPro Player for Flash (AS3) 0-1
SlideShowPro Player for Flash (AS2) 0-100
SlideShowPro Player for Lightroom 0-100

albumBackgroundColor

A hexadecimal value used as the color for each album background. The default value is 0x303030.

albumDescColor

A hexadecimal value used as the color for the descriptive text field of each album. The default value is 0xCCCCCC.

albumDescSize

A number containing the point size for the descriptive text field of each album. The default value is 9.

albumPadding

A number that indicates the amount of padding to apply around album previews and text fields in each album element. The default value is 8.

Note: This parameter is only used when albumPreviewStyle is set to "Inline" or "Banner".

albumPreviewFilter

SlideShowPro Player for Flash (AS3) only

An array containing one or more ShaderFilter. The array is applied to all album preview images. This parameter is only compatible with the ActionScript 3 version of the SlideShowPro Player for Flash, and must be used with Adobe Flash CS4 or higher. Published SWF must also target Flash Player 10 or higher.

See How to: Apply Pixel Bender filters for instructions on applying filters to SlideShowPro Player content.

albumPreviewScale

A string containing the type of scaling that should be applied to album previews (if included). Values include "None", "Crop to Fit", and "Proportional". The default value is "Proportional." See Galleries and albums for more information on these options.

albumPreviewSize

An array that assigns the width [0] and height [1] of each album preview image container in the gallery. This property is used when albumPreviewScale is set to either "Inline Crop to Fit" and "Inline Proportional", and ignored when set to "None" or "Scale Crop to Fit" (for in the former, preview images are loaded "as-is," while in the latter the container is scaled to match the widtheight of the album itself). The default values is [54,40] pixels.

Assigning parameters

SlideShowPro Player for Flash

Assign values using array notation. For example:

albumPreviewSize = [54,40]

SlideShowPro Director / SlideShowPro Player SWF

Use comma separated values. For example:

albumPreviewSize: "54,40"

albumPreviewStrokeColor

A hexadecimal value used as the color for the stroke around album preview images. The default value is 0xFFFFFF.

albumPreviewStrokeWeight

A number containing the pixel width of the stroke that is automatically applied to album previews. The default value is 1. Setting this property to 0 will remove the stroke.

albumPreviewStyle

A string containing the style of album preview graphic to use in each album element. Options include "Inline Left", which displays the preview graphic on the left and the album title/description on the right, "Inline Right" which is the reverse of "Inline Left", "Fill" which removes the album title and description and scales/crops the image to fill the entire element, and "Banner" which creates a preview area that auto-scales to the width of the album element, but with a configurable height (the second parameter of albumPreviewSize). Images are scaled/cropped to fit the banner area, and the album title/description is positioned underneath. See Galleries and albums for more information on these options.

albumRolloverColor

A hexadecimal value used as the color for an album's background when the user's mouse rolls-over. Album background returns to albumBackgroundColor on roll-out. The default value is 0x262626.

albumStrokeAppearance

A string that sets the visibility of the 1 pixel stroke around the edge of albums in the gallery. Options include "Hidden" and "Visible". The default value is "Visible."

albumStrokeColor

A hexadecimal value used as the color for all album outlines. The default value is 0x141414.

albumTextAlignment

String; A string containing the alignment value for album text fields. Accepted values are "Center", "Left" and "Right". The default value is "Left".

albumTitleColor

A hexadecimal value used as the color for the title text field of each album. The default value is 0xFFFFFF.

albumTitleSize

A number containing the point size for the title text field of each album. The default value is 10.

audioAutoStart

A string that specifies whether audio files associated with an album auto-start when loaded. Options include "Off" (for no auto-start) and "On". The default is "On".

When set to "Off," the media player interface will appear so users can initiate audio playback, and display a caption (assigned through textStrings) asking them to click the play button.

audioLoop

A string that controls whether an album's audio restarts upon completion. Options are "Off" or "On." The default value is "Off."

audioPause

A string that sets whether audio is stopped/started when a user changes displayMode from paused to play (and vice versa). When "On," audio will pause when displayMode is paused, and start playing again (at the point it previously paused) when displayMode starts up again. When "Off," audio does not respond to displayMode changes. The default value is "Off."

audioVolume

A number that sets the audio volume of mp3s and video. This is the volume level your media starts playback with. The user can then change volume on their own with the media player's volume slider thereafter if they choose to.

Default values

SlideShowPro Director .6
SlideShowPro Player SWF .6
SlideShowPro Player for Flash (AS3) .6
SlideShowPro Player for Flash (AS2) 60
SlideShowPro Player for Lightroom 60

Acceptable values

SlideShowPro Director 0-1
SlideShowPro Player SWF 0-1
SlideShowPro Player for Flash (AS3) 0-1
SlideShowPro Player for Flash (AS2) 0-100
SlideShowPro Player for Lightroom 0-100

autoFinishMode

Assigns playback behavior when reaching the final image/video in an album. If set to "Switch," auto-playback is maintained, and the next album is loaded. If set to "Stop," auto-playback changes to manual, and the slideshow stops. If set to "Restart," auto-playback is maintained, and the current album is restarted. If set to "Open Gallery" the gallery interface is opened. This mode functions with both Random and Sequential playback. The default value is "Switch."

cacheContent

A string that indicates whether the SlideShowPro Player should cache (in advance) images and video from albums when loaded. Options include "None", "Only Images", "Only Thumbnails", and "All". If set to "None", no content is cached and everything is loaded on-demand. If set to "Only Thumbnails", only thumbnail images for the navigation and link previews are cached in-advance, and all slideshow content is loaded on-demand. If set to "Only Images," only thumbnail images and slideshow images (no videos) are cached in advance. If set to "All", thumbnails, slideshow images, and slideshow videos are all cached in advance. The default value is "None".

captionAppearance

A string that indicates how image/video captions are displayed. This value can be "Hidden", "Fixed", "Fixed (if Available)", "Fixed on Rollover", "Fixed on Rollover (if Available)", "Inline", "Overlay on Rollover", "Overlay on Rollover (if Available)", "Overlay Auto", and "Overlay Auto (if Available)". The default value is "Overlay on Rollover (if Available)".

captionBackgroundAlpha

A number that sets the alpha (transparency) value of caption backgrounds. This value can be at or between from 0 to 1. Setting this to 0 effectively removes the caption background. The default setting is .6.

Default values

SlideShowPro Director .8
SlideShowPro Player SWF .8
SlideShowPro Player for Flash (AS3) 1
SlideShowPro Player for Flash (AS2) 80
SlideShowPro Player for Lightroom 80

Acceptable parameters

SlideShowPro Director 0-1
SlideShowPro Player SWF 0-1
SlideShowPro Player for Flash (AS3) 0-1
SlideShowPro Player for Flash (AS2) 0-100
SlideShowPro Player for Lightroom 0-100

captionBackgroundColor

A hexadecimal value used as the color for the photo caption background. The default value is 0x000000.

captionElements

A string that indicates which elements are drawn as part of captions. Options include "Header and Caption", "Header Only", and "Caption Only". The default setting is "Header and Caption".

When set to "Header and Caption", both the header bar (which displays the image title) and the caption bar (which displays the caption text) are displayed. When set to "Header Only", the caption bar is not drawn. When set to "Caption Only", the header bar is is not drawn.

Note: To hide the captions all-together, set captionAppearance to "Hidden".

captionHeaderBackgroundAlpha

A number that sets the alpha (transparency) value of the caption header background. Setting this to 0 effectively removes the caption header background. The default value is 0.

Acceptable parameters

SlideShowPro Director 0-1
SlideShowPro Player SWF 0-1
SlideShowPro Player for Flash (AS3) 0-1
SlideShowPro Player for Flash (AS2) 0-100
SlideShowPro Player for Lightroom 0-100

captionHeaderPadding

An array that dictates the amount of padding to apply around the header text field in the caption. Like CSS, the array assigns padding values in the following order: top, right, bottom, left. The default value is 6,6,2,6.

Assigning parameters

SlideShowPro Player for Flash

Assign values using array notation. For example:

captionHeaderPadding = [5,5,5,5]

SlideShowPro Director / SlideShowPro Player SWF

Use comma separated values. For example:

captionHeaderPadding: "5,5,5,5"

captionHeaderText

A string that populates the caption header text field with data. You can assign static text, placeholders, or both. When a placeholder is used, it is replaced by the SlideShowPro Player with dynamic data from your XML file. Here are the available placeholders:

{albumDescription}
{albumID}
{albumTitle}
{fileName}
{imageNumber}
{imageTitle}
{imageCount}

The default value is "{imageTitle}".

captionHeaderTextColor

The color of text inside the caption header (aka the caption "title"). The default value is 0xEEEEEE.

captionPadding

An array that dictates the amount of padding to apply around the caption text field in the caption area. Like CSS, the array assigns padding values in the following order: top, right, bottom, left. The default value is 2,6,6,6.

Assigning parameters

SlideShowPro Player for Flash

Assign values using array notation. For example:

captionPadding = [5,5,5,5]

SlideShowPro Director / SlideShowPro Player SWF

Use comma separated values. For example:

captionPadding: "5,5,5,5"

captionPosition

A string that indicates where captions should appear. Options include "Bottom" and "Top". The default value is "Top".

captionTextAlignment

A string containing the alignment value for caption text fields. Accepted values are "Center", "Left" and "Right". The default value is "Left".

captionTextColor

A hexadecimal value used as the color for all text fields in every photo caption. The default value is 0xAAAAAA.

captionTextShadowAlpha

A number containing the amount of drop shadow to apply underneath text in captions. The default value is 0 (no shadow).

Acceptable values

SlideShowPro Director 0-1
SlideShowPro Player SWF 0-1
SlideShowPro Player for Flash (AS3) 0-1
SlideShowPro Player for Flash (AS2) 0-100
SlideShowPro Player for Lightroom 0-100

captionTextSize

A number containing the point size of all caption text fields. The default value is 9.

contentAlign

A string that indicates where images and videos are aligned within the Content Area. Options include "Center", "Top Left", "Top Center", "Top Right", "Center Right", "Bottom Right", "Bottom Center", "Bottom Left", "Center Left". The default value is "Center".

contentAreaAction

A string that controls how the SlideShowPro Player responds when the mouse clicks inside the "action" area of the Content Area (see contentAreaInteractivity for more information).

Acceptable values include "Event", "Launch Hyperlink", "Toggle Display Mode", "Toggle Full Screen" and "Open Gallery".

When set to "Event", the SlideShowPro Player doesn't take any action other than broadcasting the imageClick event.

When set to "Launch Hyperlink", the SlideShowPro Player will check to see if a hyperlink has been assigned to the slideshow content, and if so will launch the URL associated with it in the web browser. (For more information on hyperlinks, see Creating slideshow content: hyperlinks.

When set to "Open Gallery", the gallery interface opens.

When set to "Toggle Display Mode", playback stops and starts.

When set to "Toggle Full Screen", the SlideShowPro Player enters and exits full screen mode.

contentAreaBackgroundAlpha

A number containing the transparency value for the general background behind everything in the SlideShowPro Player. Setting this to 0 effectively makes the background of the SlideShowPro Player invisible.

Default values

SlideShowPro Director 1
SlideShowPro Player SWF 1
SlideShowPro Player for Flash (AS3) 1
SlideShowPro Player for Flash (AS2) 100
SlideShowPro Player for Lightroom 100

Acceptable values

SlideShowPro Director 0-1
SlideShowPro Player SWF 0-1
SlideShowPro Player for Flash (AS3) 0-1
SlideShowPro Player for Flash (AS2) 0-100
SlideShowPro Player for Lightroom 0-100

contentAreaBackgroundColor

A hexadecimal value used as the color for the general background behind everything in the SlideShowPro Player. This color appears underneath all images, navigational elements, captions, and the outer stroke. The default value is 0x161616.

contentAreaInteractivity

A string that controls what type of rollover/click interactivity will be used in the Content Area. When set to "Action Area Only", loaded content is used as the "action" area for mouse clicks. When set to "Action Area and Navigation", the Content Area is divided up into three "zones" -- far left zone loads the previous slideshow content, far right zone loads the next slideshow content, and the center zone is treated like the aforementioned "action" area. In both options, the "action" area uses the value assigned to contentAreaAction to dictate how the SlideShowPro Player should respond to mouse clicks in that area.

Acceptable values include "Action Area Only" and "Action Area and Navigation".

The default value is "Action Area Only".

contentAreaStrokeAppearance

A string that sets the visibility of the hairline stroke around the SlideShowPro Player. This stroke appears above all other content. Acceptable values are "Hidden" and "Visible".

contentAreaStrokeColor

A hexadecimal value used as the color for the outer stroke around the SlideShowPro Player. This stroke appears above all other content. The default value is 0x262626.

contentFilter

SlideShowPro Player for Flash (AS3) only

An array containing one or more ShaderFilter. The array is applied to all slideshow content in every album. This parameter is only compatible with the ActionScript 3 version of the SlideShowPro Player for Flash, and must be used with Adobe Flash CS4 or higher. Published SWF must also target Flash Player 10 or higher.

See How to: Apply Pixel Bender filters for instructions on applying filters to SlideShowPro Player content.

contentFrameAlpha

A number containing the background transparency of content frames drawn around slideshow content. Setting this to 0 effectively makes the frame background of slideshow content.

Default values

SlideShowPro Director 1
SlideShowPro Player SWF 1
SlideShowPro Player for Flash (AS3) 1
SlideShowPro Player for Flash (AS2) 100
SlideShowPro Player for Lightroom 100

Acceptable values

SlideShowPro Director 0-1
SlideShowPro Player SWF 0-1
SlideShowPro Player for Flash (AS3) 0-1
SlideShowPro Player for Flash (AS2) 0-100
SlideShowPro Player for Lightroom 0-100

contentFrameColor

A hexadecimal value used as the color for the frame drawn around slideshow content. The default value is 0x262626.

Note: In order to see the frame around slideshow content, contentFramePadding must be assigned a number higher than 0.

contentFramePadding

A number that sets the number of pixels to be used for padding inside of the frame drawn around slideshow content. The number entered will be used around all four sides. Setting this to "0" removes the content frame background. The default value is 0.

contentFrameStrokeAppearance

A string that sets the visibility of the 1 pixel stroke that's drawn around slideshow content frames. Options are "Hidden" and "Visible." The default value is "Hidden."

contentFrameStrokeColor

A hexadecimal value used as the color for strokes applied around slideshow content backgrounds. The default value is 0x333333.

Note: In order to see content strokes, contentFrameStrokeAppearance must be set to "Visible"

contentOrder

A string that indicates the order in which slideshow content is loaded and displayed. This value can be "Random" or "Sequential". The default value is "Sequential".

If set to "Sequential," content is loaded in numerical order (the order in which they are placed in the xml). If set to "Random," content is loaded in true random order -- meaning you won't see the same image twice until all content from an album has loaded.

contentScale

A string that indicates how the SlideShowPro Player scales slideshow content. This value can be "None", "Crop to Fit", "Crop to Fit All", "Proportional", or "Downscale Only". The default value is "Downscale Only".

If set to "None" content is not scaled in any way. They're simply loaded as-is.

If set to "Crop to Fit" content will proportionally downscale or upscale to completely fill the content area of the component, with excess area cropped out.

If set to "Crop to Fit All" content scales/crops the same way as "Crop to Fit" but the entire area of the component is used.

If set to "Downscale Only" content will proportionally downscale if larger than the component, but will not be upscaled if smaller.

If set to "Proportional" content will proportionally downscale or upscale to fit the dimensions of the component.

contentScalePercent

A number that modifies the size of an image or video when loaded as slideshow content if scaled (through a "Downscale Only" or "Proportional" setting in contentScale). When set to the default, the content is proportionally scaled to fit the full dimensions of the Content Area. When set to a lower number (not 100%), the content is scaled to fit the Content Area, then reduced in size again by the percentage entered here. This setting allows you to proportionally scale images but allow some negative space around the inside of the Content Area.

Default values

SlideShowPro Director 1
SlideShowPro Player SWF 1
SlideShowPro Player for Flash (AS3) 1
SlideShowPro Player for Flash (AS2) 100
SlideShowPro Player for Lightroom 100

Acceptable values

SlideShowPro Director 0-1
SlideShowPro Player SWF 0-1
SlideShowPro Player for Flash (AS3) 0-1
SlideShowPro Player for Flash (AS2) 0-100
SlideShowPro Player for Lightroom 0-100

contentWatermark

SlideShowPro Player for Flash only::

A string containing Linkage Identifier (AS2) or Linkage Class (AS3) of the movie clip in the Flash Library panel to use as the watermark image. See [instructions].

contentWatermarkAlign

SlideShowPro Player for Flash only::

A string containing the position of the attached watermark clip (see watermark) in relation to each slideshow content asset. Options include "Center", "Top Left", "Top Center", "Top Right", "Center Right", "Bottom Right", "Bottom Center", "Bottom Left", "Center Left". The default value is "Bottom Right".

directorLargePublishing

A string that dictates whether optimized duplicates of uploaded content are published. Acceptable values are "Original", "Auto" and "Full Screen". The default value is "Auto".

When set to "Original", Director returns the original version of the uploaded image for slideshow content. When set to "Auto", Director will create a duplicate of the uploaded image that's formatted / optimized to fit the Content Area of the SlideShowPro Player. When set to "Full Screen", Director will return full screen formatted images for both the normal and full screen state.

Note: This parameter, when set to "Original" or "Full Screen", overrides the "On" setting for Full Screen Reformat. This is because either the original image from Director is re-used or a full screen image is being generated already, so full screen formatting is not necessary.

directorLargeQuality

A number that signifies the level of JPG quality SlideShowPro Director should use when publishing slideshow images. Acceptable values are from 0 to 100. The default value is 80.

directorLargeSharpening

A number that signifies the amount of unsharp mask SlideShowPro Director should use when publishing slideshow images. Acceptable values are from 0 to 5. The default value is 1 (light sharpening).

directorThumbQuality

A number that signifies the level of JPG quality SlideShowPro Director should use when publishing thumbnails for the navigation and for album previews. Acceptable values are from 0 to 100. The default value is 60.

directorThumbSharpening

A number that signifies the amount of unsharp mask SlideShowPro Director should use when publishing thumbnails for the navigation and for album previews. Acceptable values are from 0 to 5. The default value is 1 (light sharpening).

displayMode

A string that indicates the starting playback mode of the SlideShowPro Player. This value can be "Auto", "Always Auto" or "Manual". The default value is "Auto".

SlideShowPro Director 0-infinity
SlideShowPro Player SWF 0-infinity
SlideShowPro Player for Flash (AS3) 0-infinity
SlideShowPro Player for Flash (AS2) 0-infinity
SlideShowPro Player for Lightroom 0-infinity

fullScreenReformat

A string that controls whether alternate (full screen) content should be requested when entering full screen mode. Acceptable values include "Off" and "On".

When set to "Off", the slideshow content loaded in the HTML view are used while in full screen (and scaled depending on how contentScale is set). When set to "On", the SlideShowPro Player will either attempt to load content from a path designated through a fspath attribute in the album element, or through a fs path assigned directly to an img element, or if using SlideShowPro Director will simply request new images.

The default value is "On".

fullScreenTakeOver

A string that controls whether the SlideShowPro Player will scale to fill the user's display when entering full screen mode. Acceptable values include "Off" and "On". The default value is "On".

galleryAppearance

A string that controls whether the gallery interface is visible. Acceptable values include "Hidden", "Visible" and "Visible without Navigation". The default value is "Visible".

When set to "Hidden", the gallery button is removed from the navigation bar. When set to "Visible", the gallery button is included and makes the gallery interface available. When set to "Visible without Navigation", the primary navigation is temporarily hidden when the gallery interface is opened (then returns when closed).

galleryBackgroundAlpha

A number that sets the background transparency of the gallery. Setting this to 0 effectively removes the gallery background.

Default values

SlideShowPro Director 1
SlideShowPro Player SWF 1
SlideShowPro Player for Flash (AS3) 1
SlideShowPro Player for Flash (AS2) 100
SlideShowPro Player for Lightroom 100

Acceptable parameters

SlideShowPro Director 0-1
SlideShowPro Player SWF 0-1
SlideShowPro Player for Flash (AS3) 0-1
SlideShowPro Player for Flash (AS2) 0-100
SlideShowPro Player for Lightroom 0-100

galleryBackgroundColor

A hexadecimal value used as the color for each gallery screen's background. The default value is 0x1C1C1C

galleryColumns

A number that indicates the maximum number of columns in each gallery screen. The default value is 2. If value creates more columns than the gallery screen can display this value will automatically decrement the column count until reaching the maximum number that will fit. If the opposite is true and there is more horizontal gallery space than number of assigned columns, each column will expand horizontally to fill the available space.

galleryContentShadowAlpha

A number containing the amount of shadow to apply to gallery content, including album text, preview images, and the gallery screen navigation. The default value is 0.

Acceptable parameters

SlideShowPro Director 0-1
SlideShowPro Player SWF 0-1
SlideShowPro Player for Flash (AS3) 0-1
SlideShowPro Player for Flash (AS2) 0-100
SlideShowPro Player for Lightroom 0-100

galleryNavActiveColor

A hexadecimal value used as the color for the background of the gallery's screen navigation buttons when they are enabled. The default value is 0x303030.

galleryNavAppearance

A string that indicates whether the gallery screen navigation is included with the SlideShowPro Player when published. This value may be "Hidden" or "Visible". The default value is "Visible".

galleryNavInactiveColor

A hexadecimal value used as the color for the background of the gallery's screen navigation buttons when they are disabled. The default value is 0x000000.

galleryNavRolloverColor

A hexadecimal value used as the color for the background of the gallery's screen navigation buttons when they are rolled-over with the mouse pointer. The default value is 0x262626.

galleryNavStrokeAppearance

A string that controls the appearance of a hairline stroke around the gallery navigation buttons. Options include "Hidden" and "Visible". The default value is "Visible".

galleryNavStrokeColor

A hexadecimal value used as the color for the hairline stroke that's drawn around the gallery navigation buttons (if visible). The default value is 0x141414.

galleryNavTextColor

A hexadecimal value used as the color for the text fields inside the gallery navigation. The default value is 0xCCCCCC.

galleryNavTextSize

A number that controls the point size of the text fields in the gallery navigation. The default value is 9.

galleryOrder

A string that indicates the order in which albums are positioned in each gallery screen. This value can be "Left to Right" or "Top to Bottom". The default value is "Left to Right."

When "Left to Right" is chosen, the first album (as stipulated by the top-down sequence of the XML) is placed in the top-left corner of the gallery screen. Subsequent albums are then placed to the right of the first album until reaching the maximum amount of columns allowed. Albums then shift to the next row, starting again from the left.

When "Top to Bottom" is chosen, the first album (again stipulated by the XML) is placed in the top-left corner of the gallery screen. Subsequent albums are then placed below the first until reaching the maximum number of rows. Albums then shift to the next column, starting again from the top.

galleryPadding

A number that indicates the amount of padding to apply around all elements in the gallery. The default value is 10.

galleryRows

A number that indicates the maximum number of rows in each gallery screen. The default value is 4.

If value creates more rows than the gallery screen can display, the SlideShowPro Player will automatically decrement this value until reaching the maximum number that will fit. If the opposite is true and there is more vertical gallery space than number of assigned rows, each row will expand vertically to fill the available space.

Note: The minimum size of an album element is 160px wide by 66px high when albumPreviewStyle is set to "Fill". If "Inline Left" or "Inline Right" is used, the minimum size is 25px wide by 25px high.

keyboardControl

A string that indicates whether user keyboard input is allowed. Options include "Off" and "On." The default option is "On."

If set to "On", the SlideShowPro Player accepts the following character inputs:

F: Enter full screen

G: Open/close gallery

N: Hide/show navigation bar

Left arrow: Load previous image

Up arrow: Skip to next image number group

Right arrow: Load next image

Down arrow: Skip to previous image number group

Space Bar: Pause/Auto-Play

loop

A string that controls whether a user can continually navigate forwards / backwards through an album. Acceptable values are "On" and "Off".

When turned on, navigation buttons no longer deactivate, and you can navigate from the first image back to the last, and vice versa. The same also applies when using the Content Area navigation. The default setting is "Off".

mediaPlayerAppearance

A string that controls whether the media player interface is displayed when audio or video content is playing back. Options include "Hidden", "Always Visible" and "Visible on Rollover". The default value is "Visible on Rollover."

If set to "Hidden," the media player never appears. If set to "Always Visible," the player is constantly visible when audio/video playback is occurring. If set to "Visible on Rollover," the player appears when the mouse rolls over the Content Area.

mediaPlayerBackgroundAlpha

A number that sets the alpha (transparency) value of the media player's general background as well as the scrubber background.

Default values

SlideShowPro Director .25
SlideShowPro Player SWF .25
SlideShowPro Player for Flash (AS3) .25
SlideShowPro Player for Flash (AS2) 25
SlideShowPro Player for Lightroom 25

Acceptable parameters

SlideShowPro Director 0-1
SlideShowPro Player SWF 0-1
SlideShowPro Player for Flash (AS3) 0-1
SlideShowPro Player for Flash (AS2) 0-100
SlideShowPro Player for Lightroom 0-100

mediaPlayerBackgroundColor

A hexadecimal value used as the color for the media player background. The default value is 0x000000.

mediaPlayerBufferColor

A hexadecimal value used as the color for the video buffer load bar. The default value is black 0x000000.

mediaPlayerButtonColor

A hexadecimal value used as the color for the (embedded) play/pause icon. The default value is 0xCCCCCC.

mediaPlayerControlColor

A hexadecimal value used as the color for the circular control button in the progress area. The default value is 0xFFFFFF.

mediaPlayerElapsedBackgroundColor

A hexadecimal value used as the color for the background of the time elapsed pop-up. Appears when the progress bar in the media player is pressed. The default value is 0xFFFFFF.

mediaPlayerElapsedTextColor

A string containing the color of text in the time elapsed pop-up. Appears when the progress bar in the media player is pressed. The default value is 0xFFFFFF.

mediaPlayerPosition

A string that controls where in the component space the media player appears. Options include "Bottom" and "Top". The default value is "Bottom".

mediaPlayerProgressColor

A hexadecimal value used as the color for the video progress scrubber. The default value is light grey 0xCCCCCC.

mediaPlayerScale

A number that assigns a horizontal width to the media player. The value is calculated as a percentage of the overall width of the component. For example, if set to 50%, your media player will consume half of the total width of the component. The media player is always aligned center.

Default values

SlideShowPro Director .8
SlideShowPro Player SWF .8
SlideShowPro Player for Flash (AS3) .8
SlideShowPro Player for Flash (AS2) 80
SlideShowPro Player for Lightroom 80

Acceptable parameters

mediaPlayerTextColor

A hexadecimal value used as the color for the duration text field and audio caption text field. The default value is 0xEEEEEE.

mediaPlayerTextSize

A number containing the size of all text fields inside the media player. The default value is 9 pixels.

mediaPlayerVolumeBackgroundColor

A hexadecimal value used as the color for the background of the volume slider. The default value is black 0x000000.

mediaPlayerVolumeHighlightColor

A hexadecimal value used as the color for the top of the volume slider. The default value is light grey 0xCCCCCC.

navAppearance

navButtonInactiveAlpha

A number containing the amount of alpha transparency applied to inactive navigation icons.

During playback, the SlideShowPro Player automatically enables and disables icons when needed. This makes the user interface clearer for end-users so they can see which icons are accessible. Setting navButtonInactiveAlpha to 0 effectively removes icons when they are inactive. A setting of full opacity is not recommended for then there wouldn't be a visual difference between inactive and active icons.

Default values

SlideShowPro Director .4
SlideShowPro Player SWF .4
SlideShowPro Player for Flash (AS3) .4
SlideShowPro Player for Flash (AS2) 40
SlideShowPro Player for Lightroom 40

Acceptable parameters

SlideShowPro Director 0-1
SlideShowPro Player SWF 0-1
SlideShowPro Player for Flash (AS3) 0-1
SlideShowPro Player for Flash (AS2) 0-100
SlideShowPro Player for Lightroom 0-100

navIcons

SlideShowPro Player for Flash only

SlideShowPro Director 1
SlideShowPro Player SWF 1
SlideShowPro Player for Flash (AS3) 1
SlideShowPro Player for Flash (AS2) 100
SlideShowPro Player for Lightroom 100

Acceptable parameters

SlideShowPro Director 0-1
SlideShowPro Player SWF 0-1
SlideShowPro Player for Flash (AS3) 0-1
SlideShowPro Player for Flash (AS2) 0-100
SlideShowPro Player for Lightroom 0-100

navLinkPreviewBackgroundColor

A hexadecimal value used as the color for the background of the link pop-up preview. The default value is 0xFFFFFF.

navLinkPreviewScale

A string that represents how images should be scaled when used in link previews. Options include "None", "Proportional" and "Crop to Fit". When set to "Proportional," link preview images are proportionally scaled to the largest dimension of the preview width/height. When set to "Crop to Fit," link preview images are proportionally scaled until they fill the preview's width/height, and then cropped in the center. This latter option gives all your link preview images a consistent look. The default setting is "Proportional".

navLinkPreviewSize

An array containing the width and height (in pixels) of link preview images that appear on navigation link rollover. This value is used in conjunction with navLinkPreviewScale to calculate the available space for loaded images. The default values are 100 pixels wide by 100 pixels high.

Assigning parameters

SlideShowPro Player for Flash

Assign values using array notation. For example:

navLinkPreviewSize = [100,100]

SlideShowPro Director / SlideShowPro Player SWF

Use comma separated values. For example:

navLinkPreviewSize: "100,100"

navThumbLinkSize

An array containing the width and height of thumbnail content links in the navigation. Requires navLinkAppearance to be set to "Thumbnails". The default values are 16,16.

Assigning parameters

SlideShowPro Player for Flash

Assign values using array notation. For example:

navThumbLinkSize = [25,25]

SlideShowPro Director / SlideShowPro Player SWF

Use comma separated values. For example:

navThumbLinkSize: "25,25"

navThumbLinkStrokeWeight

A number containing the pixel width of the stroke applied around the edge of thumbnail content links in the navigation. Requires navLinkAppearance to be set to "Thumbnails". Setting this to 0 effectively removes the stroke. The default value is 1.

panZoom

A string value for activating pan zoom functionality. Options include "Off" and "On." The default value is "Off".

If set to "On", the slideshow content will upscale and/or downscale (using the range defined by panZoomScale and direction defined by panZoomDirectiion) and move from one set of x/y coordinates to another.

panZoomDirection

A string value for controlling the direction in which content is scaled when animating as part of the panZoom effect. Options include "In and Out", "In", "Out" and "Random". The default value is "Random".

When set to "In and Out", content upscales, downscales, upscales, downscales, and so on.

When set to "In", content always upscales.

When set to "Out", content always downscales.

When set to "Random", content randomly upscales or downscales.

panZoomFinish

A string value for controlling whether the pan zoom effect completes before the next piece of slideshow content loads (while in auto playback). Options include "Off" and "On". The default value is "Off".

When set to "On", the length of the pan zoom effect is equal to (in seconds) the sum of transitionLength and transitionPause.

When set to "Off", the length is equal to the same values as "On" but tripled so that the effect doesn't stop while new content is being loaded.

panZoomScale

An array value for controlling the minimum and maximum scale values that are used by the pan zoom effect. panZoomScale[0] is the minimum, panZoomScale[1] is the maximum.

Default values

SlideShowPro Director 1,1.2
SlideShowPro Player SWF 1,1.2
SlideShowPro Player for Flash (AS3) [1,1.2]
SlideShowPro Player for Flash (AS2) [100,120]
SlideShowPro Player for Lightroom [100,120]

Acceptable parameters

SlideShowPro Director 1-infinity
SlideShowPro Player SWF 1-infinity
SlideShowPro Player for Flash (AS3) 1-infinity
SlideShowPro Player for Flash (AS2) 100-infinity
SlideShowPro Player for Lightroom 100-infinity

Assigning parameters

SlideShowPro Player for Flash

Assign values using array notation. For example:

panZoomScale = [1,1.2]

SlideShowPro Director / SlideShowPro Player SWF

Use comma separated values. For example:

panZoomScale: "1,1.2"

permalinks

A string value for activating permalink functionality. Options include "Off" and "On." If set to "On," the document path in the browser will automatically update with a direct link to the currently viewed image/video. If set to "Off," the document path is not modified. Note: the use of permalinks requires additional modification of the HTML document used to present the SlideShowPro Player. See this how-to for more information.

smoothing

A string that specifies whether bitmaps and videos are smoothed (interpolated) when scaled. The default value is "On" (smoothing applied).

Cross domain note: You may run into problems when loading content from domains that are different than the one hosting your SWF when smoothing is set to "On." It's a limitation of the Flash Player's security sandbox, whereby it doesn't think it has permission to alter the content. With that, set smoothing to "Off" if you run into issues.

soundEffects

SlideShowPro Player for Flash only

An array containing the Linkage Identifiers (AS2) or Linkage Classes (AS3) of the sound clips in the FLA Library to be used for interface sound effects.

See Loading sound effects for instructions on how to apply sound effects.

soundEffectsVolume

SlideShowPro Player for Flash only

A number that sets the audio volume of sound effects. The default value is 40 (AS2) and .4 (AS3).

See Loading sound effects for instructions on how to apply sound effects.

startup

A string value that dictates what the component does after successfully loading its gallery data. Available options include "Load Album", "Load Album Then Wait", "Load Data Then Wait" and "Open Gallery".

When set to "Load Album", the SlideShowPro Player will startup by loading (by default) the first album in your gallery, and then request the first piece of content in that album.

When set to "Load Album Then Wait", the first album in the gallery is loaded, but no content is requested. The SlideShowPro Player then waits for the user to request an image/video.

When set to "Load Data Then Wait", the gallery data is loaded but no albums are loaded. The SlideShowPro Player then waits for the user to request an album.

When set to "Open Gallery", the gallery interface opens; allowing the user to choose which album they'd prefer to see.

The default setting is "Load Album".

textStrings

An array containing the English text values used for the SlideShowPro Player's user interface. They may be exchanged with English or non-English words, but their order in the array must be maintained.

The value of [0] is used for the left button in the gallery screen. The value of [1] is used for the right button in the gallery screen. The value of [2] is used as the screen-count field in the gallery screen. The value of [3] is used in both the caption title and the screen-count field in the gallery screen. The value of [4] is used as the content caption when caption data doesn't exist for an image. The value of [5] is used in the Caption Header when a title doesn't exist for an image. The value of [6] and [7] are used with audio captions in the media player. The value of [8] is used when audioAutoStart is set to "Off" and an audio file is loaded.

SlideShowPro Player for Flash

When assigning values in ActionScript, use array notation. For example::

textStrings[0] = "Previous Screen"
textStrings[1] = "Next Screen"
textStrings[2] = "Screen"
textStrings[3] = "of"
textStrings[4] = "No caption"
textStrings[5] = "No title"
textStrings[6] = "Playing"
textStrings[7] = "Paused"
textStrings[8] = "Click play to start audio"

SlideShowPro Director / SlideShowPro Player SWF

Use comma separated values. For example:

textStrings:"Previous Screen,Next Screen,Screen,of,No caption,No title,Playing,Paused,Click play to start audio"

toolAppearanceContentArea

A string that controls the appearance of tool tips when the mouse enters the Content Area. Options include "Hidden", "Visible" and "Action Area Hidden".

When set to "Hidden", tool tips are never displayed.

When set to "Visible", tool tips are displayed.

When set to "Action Area Hidden", the tool tip that would normally appear over the action area is hidden. The previous / next tool tips are visible.

The default value is "Hidden".

toolAppearanceNav

A string that controls the appearance of tool tips when the mouse rolls-over buttons in the navigation.

Acceptable values are "Hidden" and "Visible".

The default value is "Visible".

toolColor

A hexadecimal value used as the background color of tool tips. The default value is 0x222222.

toolDelayContentArea

A number representing the amount of time (in seconds) before tool tips appear in the Content Area on rollover. The default value is 0 (no delay).

toolDelayNav

A number representing the amount of time (in seconds) before tool tips appear in the Navigation when buttons are rolled over. The default value is .5 (half second delay).

toolLabels

An array containing the English words used for all tool tips that appear in the component.

The value of [0] appears over the navigation's gallery button.
The value of [1] appears over the navigation's previous content group button.
The value of [2] appears over the navigation's previous content button and with content area navigation.\\ The value of [3] appears over the navigation's next content button and with content area navigation.
The value of [4] appears over the navigation's next content group button.
The value of [5] appears over the navigation's pause button.\\ The value of [6] appears over the navigation's play button.\\ The value of [7] appears over the navigation's full screen button and over the action area when "Launch Full Screen" is used for contentAreaAction.
The value of [8] appears over the navigation's normal screen button and over the action area when "Launch Full Screen" is used for contentAreaAction.
The value of [9] appears over the action area when "Launch Hyperlink" is used for contentAreaAction.
The value of [10] appears over the action area when "Open Gallery" is used for contentAreaAction.

SlideShowPro Player for Flash

When assigning values in ActionScript, use array notation. For example::

toolLabels[0] = "Gallery"
toolLabels[1] = "Previous Group"
toolLabels[2] = "Previous"
toolLabels[3] = "Next"
toolLabels[4] = "Next Group"
toolLabels[5] = "Pause"
toolLabels[6] = "Play"
toolLabels[7] = "Full Screen"
toolLabels[8] = "Normal Screen"
toolLabels[9] = "Open Link"
toolLabels[10] = "Open Gallery"

SlideShowPro Director / SlideShowPro Player SWF

Use comma separated values. For example:

toolLabels: "Gallery,Previous Group,Previous,Next,Next Group,Pause,Play,Full Screen,Normal Screen,Open Link,Open Gallery"

toolTextColor

A hexadecimal value used as text color in tool tips. The default value is 0xEEEEEE.

toolTextSize

A number representing the point size of text displayed in tool tips. The default value is 9.

toolTimeoutContentArea

A number representing the amount of time (in seconds) a tool tip is visible in the Content Area before it disappears. The default value is 3 (seconds).

transitionDirection

A string containing the direction (if applicable) that transitionStyle should move in when animating. Options include "Top to Bottom", "Left to Right", "Right to Left", "Bottom to Top". The default value is "Left to Right".

Note: This parameter is only used by the "Dissolve", "Push", "Wipe", "Wipe and Fade", "Wipe to Background", and "Wipe and Fade to Background" transitions.

transitionLength

A number that indicates (in seconds) the duration of the assigned transition. The default value is 2.

transitionPause

A number that sets the duration, in seconds, of the pause between transitions. This property is only used if the SlideShowPro Player is in Auto play mode. The default value is 4.

transitionStyle

A string containing the type of transition to be applied when slideshow content unloads and loads. Available options are "None", "Blur", "Cross Fade", "Fade to Background", "Dissolve", "Drop" "Lens", "Photo Flash", "Push", "Wipe", "Wipe and Fade", "Wipe to Background" and "Wipe and Fade to Background". The default value is "Cross Fade".

typeface

A string containing one or more typeface names to be used as the general font for the SlideShowPro Player. The default value is "Lucida Grande,Lucida Sans Unicode,Verdana,Arial,_sans". When using "System" fonts -- typefaces on nearly every user computer -- this value may be a comma-separated list of typeface names (with no spaces between them). The SlideShowPro Player will use the fist available typeface in the comma-separated list.

typefaceHead

A string containing one or more typeface names to be used as the header font for the SlideShowPro Player. The default value is "Lucida Grande,Lucida Sans Unicode,Verdana,Arial,_sans". When using "System" fonts -- typefaces on nearly every user computer -- this value may be a comma-separated list of typeface names (with no spaces between them). The SlideShowPro Player will use the fist available typeface in the comma-separated list.

typefaceAntiAlias

A string that sets the type of anti-aliasing that should be applied to text fields. This can improve the appearance of some typefaces. Options include "Normal" and "Advanced". The default value is "Advanced".

typefaceEmbed

SlideShowPro Player for Flash only

A string value for whether the SlideShowPro Player embeds the typeface(s) entered for both typeface and typefaceHead in all text fields. Options include "Off" and "On." The default value is "Off."

Note: this should be set to "On" only when you wish to use a non-system typeface in the SlideShowPro Player.

version

A string containing the version number of the SlideShowPro Player.

videoAutoStart

A string that specifies whether videos auto-start when they are loaded. Options include "Off" (for no auto-start) and "On". The default is "On".

When set to "Off," the SlideShowPro Player will look for a preview/poster graphic to display in the video area. This graphic is assigned through a vidpreview attribute in an img node in the XML file, and should be a complete URL to the file in relative or absolute form. The graphic should also be the same size as the video.

To add a preview graphic in the XML, modify the img node containing your video, like so:

<img src="myvideo.flv" vidpreview="gallery/album1/vid/preview.jpg" />

Or in absolute form, like so:

<img src="myvideo.flv" vidpreview="http://mydomain.com/gallery/album1/vid/preview.jpg" />

videoBufferTime

Specifies how long to buffer video before starting to display the stream. For example, to make sure that 15 seconds of a stream can play without interruption, set videoBufferTime to 15; the application plays the stream only after 15 seconds of data are buffered. If the buffer becomes empty again (if their connection is slow), it will buffer another 15 seconds before playback starts again.

The default value is 5 (seconds).

Note: This does not necessarily equate to the amount of time a user waits before video playback begins. You can set this to 30 seconds, for example, and if a user is on a fast connection playback may begin immediately. It simply ensures that at least 30 seconds worth of video is buffered and available for playback without interruption. Users on slower connection speeds may actually wait 30 seconds, or longer, for 30 seconds worth of video to be progressively buffered.

videoPreviewURL

For use with the "Single Content" option for xmlFileType, this allows you an alternate way to assign a video poster graphic due to the lack of an XML document being loaded. The parameter is null by default, and accepts a URL string for the image.

xmlFilePath

A string that indicates an absolute or relative URL of the xml file to load into the SlideShowPro Player. Default value is "images.xml".

xmlFileType

A string that dictates the type of xml content assigned through xmlFilePath. Acceptable values include "Default", "Director", "Media RSS" or "OPML". The default value is "Default".

Use the "Default" type for manually created data using the default SlideShowPro Player xml structure. Use "Director" when loading content from SlideShowPro Director 1.1 or higher. Use "Media RSS" when loading RSS 2.0 feeds from web sites that use Media RSS (MRSS) markup to syndicate photos or videos. Lastly, use "OPML" to load an OPML document containing links to one ore more XML files.

Quick index:

Page last modified by tdominey on February 29, 2012, at 05:44 AM