XML Flash Slideshow v4 Help    |    Support Home    |    DWUser.com Home  Download Help PDF (29MB)    |    Search:

The <galleries> section - Image Data

This section contains all of the actual image data.    The <galleries> section has the following general format:

<galleries ... >
    <!-- One or more galleries in each slideshow (zero if using dynamic data source(s)) -->
    <gallery ... >
        <!-- One or more slides/images in each gallery -->
        <img ... />
    </gallery>
</galleries>

The main <galleries> node has various attributes which apply to all galleries.    Inside this node are placed the <gallery> node(s).    Each <gallery> node has various attributes which specify setttings specific to that gallery.    Each <gallery> node is filled with one or more <img ... /> nodes, each of which define a slide/image.    If dynamic data is being used with a given gallery, then adding <img ... /> nodes is optional.    The following sections of this topic detail the format of each of these nodes.

The <galleries> node

The <galleries> node holds all of the gallery definitions.    It has several properties / attributes which apply to all galleries:

Attribute / Property Values Description
randomize true or false

Specifies if the order of the galleries in the slideshow (not their images) should be shuffled.

Optional; defaults to false

randomizeEveryGallery true or false

Specifies if the image order of all galleries should be randomized when they are opened.  This allows for randomized playback.  If enabled, this value overrides the gallery-specific randomize setting.

Optional; defaults to false

autoplay true or false

Specifies if autoplay should be initially enabled when the slideshow is opened.

Optional; defaults to false

autoplayDelay Autoplay Delay (see desc.)

Specifies the delay between images when autoplay is enabled.    For details on the format used for this value, see the com.dwuser.ss4.managers.AutoplayManager class in the API Reference.    This value can be overridden for individual galleries and images.

Optional; has no default value.    Required if autoplay is enabled.

autoplayLoop true or false

Specifies if the slideshow should loop back to the first image in the first gallery when the final image in the last gallery has been reached.    If the autoplayLoop setting is enabled for a single gallery, autoplay will loop within the gallery instead of skipping to the next gallery.

Optional; defaults to false

audio MP3 file URL

Specifies the URL of the MP3 background audio for the slideshow; its options are controlled via the AudioIntro selector (see the com.dwuser.ss4.pseudoStyleClasses.AudioIntro class in the API Reference).

Optional; has no default value.

audioLabel String label

If an audio attribute has been specified, this attribute specifies the audio label associated with the background audio.

Optional; defaults to empty string.

effectType Effect name(s); comma separated if more than 1.

Specifies the default transition effect between all slides if using the ImagesStandard element for image display.    This value can be overridden for individual galleries.    If using more than one effect, each of their names must be separated with a comma (no spaces).    For more information about supported transitions, see Setting the Image Transition.    For example: ...effectType="FadeStandard,Cube" ...

Optional; defaults to FadeStandard

linkTarget Link target (e.g. _self, _blank, etc).

Specifies the default link target for all image links.  This value can be overridden for individual galleries and images.

Optional; defaults to _self

kbMouseControlEnabled true or false

Specifies the global default for whether Ken Burns (KB) effects may be controlled by the user.  If enabled, allows the user to use their mouse to pan around photos that have Ken Burns effects applied and, when in their maximum magnification, are larger than the visible area.

May be overridden by setting this same property on <gallery> or <img> nodes.

Optional; defaults to false

    The following parameters control dynamic data sources; these advanced parameters usually should not be modified.
rssSize largest, smallest, or default

When using Media RSS feeds (as external image data sources) that have multiple image sizes defined, this parameter can be used to specify which of the image sizes to use.  If no value is specified or default (the default) is used, whichever size is marked as the default will be used; if none is marked as the default, the first will be used.

Optional; defaults to default

flickrSize square, thumb, medium, big, default (AKA standard, 640

When using Flickr Feeds or the Flickr API to provide external image data, this parameter can be used to specify which photo size should be loaded.  To learn more about each of the supported sizes, see the Flickr API reference.  It is almost always best to leave the default value or use 640; using other sizes may yield undesirable results, including non-functional slideshows.

Optional; defaults to default

flickrThumbSize square, thumb or medium

When using the Flickr API to provide external image data, this parameter can be used to specify which photo size should be used for thumbnails.  Using square will load a 75x75 pixel small square thumbnail; using thumb (the default) will load a thumbnail that is 100 pixels on the longest side; using medium will load a large thumbnail that is 240 pixels on the longest side.

Note: When using an RSS feed dynamic data source that comes from GoDaddy's photo hosting service, specify a value of medium to disable the program from automatically attempting to create thumbnail URLs.  Only make this modification if you receive errors about thumbnails failing to load.

Optional; defaults to thumb

flickrVideoSize site, mobile, hd, or orig

When using the Flickr API to provide external image data that includes video, this parameter can be used to specify which video size should be loaded.  To learn more about each size, see the Flickr Code BlogPlease note!  Using any value other than the default may yield undesirable results, including non-functional slideshows.

Optional; defaults to site

flickrIgnoreLink true or false

When using Flickr Feeds or the Flickr API to provide external image data, by default the photo's link will point to the associated Flickr photo page.  This parameter can be used to prevent the default action and prevent a link from being added. 

Please Note!  You are solely responsible for understanding and complying with the Flickr TOS.  It is your responsibility to verify that removing the default Flickr photo links will not violate the Flickr TOS in your specific usage case.

Optional; defaults to false

 

The <gallery> nodes

Each gallery is represented by a <gallery> node which is placed inside the <galleries> holder node.    Each <gallery> node has the following properties / attributes:

Attribute / Property Values Description
id Unique ID string

This optional value is only applicable if you plan to use dynamic data with the gallery or if you plan to use permalinks or javascript interfacing.  When you create and use a dynamic data source, the data can be added to a new gallery or added to an existing gallery at runtime.    If it is added to a new gallery, you won't have control over the gallery settings such as title, description, thumbnail, etc.  If you want control over these settings, you must create a gallery in the wizard, assign it a linkage id value, then associate this gallery linkage ID with your dynamic data source in the External Image Data section.    Then, when the dynamic data is loaded, the image information will be added to the gallery you created and any explicitly-specified parameters will not be modified.

If an ID is specified, the gallery can later be referenced by using this value in a permalink (e.g. linking directly to a specific gallery) or a javascript interface call.  See the linked topics for more information about how these features work.

Note: This value must only contain letters, numbers, and underscores.

Optional; has no default value.  If omitted, the gallery can still be referenced in permalinks and javascript interface calls by using its zero-based numeric index.

touchEnabled true (default) or false

Specifies if the gallery should be omitted from the alternate touchscreen-optimized presentation.  Set to false to make the gallery only appear in the Flash-based presentation.

Optional; if not set to false the gallery will be included in the touchscreen-optimized presentation.

flashEnabled true (default) or false

Specifies if the gallery should be omitted from the standard Flash-based presentation and only shown in the alternate touchscreen-optimized presentation.  Set to false to make the gallery only appear in the touchscreen-optimized presentation.

Optional; if not set to false the gallery will be included in the standard Flash-based presentation.

fullPathPrefix String If specified, this optional value is prepended to all image URL's (the src attribute on each <img> node).    This allows for redundant path structures to be listed only once, instead of bloating the configuration file by being listed for every image.
thumbPathPrefix String If specified, this optional value is prepended to all thumbnail URL's (the thumb attribute on each <img> node).    This allows for redundant path structures to be listed only once, instead of bloating the configuration file by being listed for every image.
hqPathPrefix String Generally should not be used.    If specified, this optional value is prepended to all high-quality image URL's (the hq attribute on each <img> node).    This allows for redundant path structures to be listed only once, instead of bloating the configuration file by being listed for every image.
videoPathPrefix String Generally should not be used.   If specified, this optional value is prepended to all slide video URL's (the video attribute on each <img> node).    This allows for redundant path structures to be listed only once, instead of bloating the configuration file by being listed for every image.
title String

This is the title value associated with the gallery.  This value will be displayed in any gallery selection elements as the gallery's title.    HTML can be included, but must be encoded (see Overview of XML Structure).

Optional, but recommended.    If omitted, has no default value.

description String

This is the text description value associated with the gallery.    This value will be displayed to provide information about the gallery in some gallery selection elements.    HTML can be included, but must be encoded (see Overview of XML Structure).

Optional, but recommended.    If omitted, has no default value.

thumb String

This is the URL to the gallery's thumbnail image.  This image is displayed with the gallery in various gallery selection elements.

Optional, but recommended.    If omitted, has no default value.

linkTarget Link target (e.g. _self, _blank, etc).

The link target represents the window in which image links (links applied to images in the gallery) will be opened.  This is the default value for all images in the gallery.  It can be overridden on a per-image basis by setting the link target on an individual image.    Setting this value overrides the global default on the <galleries> node.    The default value of _self will open the link in the current window.  Using _blank will open the link in a new browser window.  Using _parent will open the link in the parent page if using frames.  Specifying any other value will control a specific frame in a frameset.

Tip: For control over the appearance and size of the new window, you can use a javascript call in the image link to open a true popup window.  In the wizard, you can use the Popup Link Generator.

Optional; defaults to _self

defaultLink Link URL

This is the default image link value for all images in the gallery.  It is only applicable for images that have no per-image link defined; on those images, the image-specific value will be used as the image's link.  For more information on the format of this attribute, see the link attribute for the <img> node below.

Note that replacement values are very helpful in this attribute (see the <img> node's link attribute for more information about replacement values).

defaultTitle String

This is the default image title value for all images in the gallery.  It is only applicable for images that have no per-image title defined; on those images, the image-specific value will be used as the image's title.  For more information on the format of this attribute, see the title attribute for the <img> node below.

Note that replacement values are very helpful in this attribute (see the <img> node's title attribute for more information about replacement values).

defaultCaption String

This is the default image caption/description value for all images in the gallery.  It is only applicable for images that have no per-image caption defined; on those images, the image-specific value will be used as the image's caption.  For more information on the format of this attribute, see the caption attribute for the <img> node below.

Note that replacement values are very helpful in this attribute (see the <img> node's caption attribute for more information about replacement values).

defaultToolTip String

This is the default image tooltip value for all images in the gallery.  It is only applicable for images that have no per-image tooltip defined; on those images, the image-specific value will be used as the image's tooltip.  For more information on the format of this attribute, see the toolTip attribute for the <img> node below.

Note that replacement values are very helpful in this attribute (see the <img> node's toolTip attribute for more information about replacement values).

password String

Optionally specifies a gallery password.    If a gallery password has been specified, the user will receive a password prompt when attempting to open the gallery, and will be required to enter the password correctly.

Note: In the wizard, this value is encrypted using a proprietary encryption algorithm.    If you generate your own XML, you must use un-encrypted string value.

Optional; has no default value.

randomize true or false

Specifies if the gallery should be randomized each time it is opened.    This allows for randomized playback.   Overrides the global setting on the <galleries> node.

Optional; defaults to false

autoplayDelay Autoplay Delay (see desc.)

Specifies the delay between images when autoplay is enabled.    For details on the format used for this value, see the com.dwuser.ss4.managers.AutoplayManager class in the API Reference.    This value overrides the global default on the <galleries> node and can be overridden for individual images.

Optional; has no default value.    Required if Autoplay is being used.

autoplayLoop true or false

Enables/disables looping within the gallery.  If enabled, autoplay will jump back to the first image in the gallery when the final image is reached.  If disabled, autoplay will jump to the first image in the next gallery when the final image is reached.

Optional; defaults to false

effectType Effect name(s); comma separated if more than 1.

Specifies the default transition effect between all slides if using the ImagesStandard element for image display.    This value overrides the global default on the <galleries> node and can be overridden for individual images.    If using more than one effect, each of their names must be separated with a comma (no spaces).    For more information about supported transitions, see Setting the Image Transition.    For example: ...effectType="FadeStandard,Cube" ...

Optional; defaults to FadeStandard

audio MP3 file URL

Specifies the URL of the MP3 gallery-level audio.    This is the audio which plays only while this gallery is open.    The audio file must be in MP3 format; for necessary formatting guidelines, see Avoiding "Chipmunks" Audio: MP3 Formatting Guidelines.    The URL must be relative to the HTML page which holds the slideshow.

Note: If you are loading audio from a different domain than the one on which the slideshow is displayed, you will be affected by Flash Player crossdomain loading security restrictions.  To learn more, see this topic.    

Note: If you're audio plays back at a distorted speed, like "chipmunks", you need to review the MP3 formatting guidelines referenced above.

The options for gallery-level audio are controlled via the AudioGallery selector (see the com.dwuser.ss4.pseudoStyleClasses.AudioGallery class in the API Reference).

Optional; has no default value.

audioLabel String label

If an audio attribute has been specified, this attribute specifies the audio label associated with the gallery-level audio.

Optional; defaults to empty string.

kbEffect KB Effect ID(s); comma separated if more than 1. Also, Random can be used.

Specifies a default Ken Burns effect (or effects) for all images in the gallery.    Ken Burns effects (KB effects) are packages which incorporate both panning and zooming.  You can learn more about KB effects in the <kenburns> section reference.  If you specify an effect for this gallery-wide default, it will be used by each image in the gallery unless you override it on an individual image node via its kbEffect attribute.

You can specify multiple KB effect ID values; when doing this, separate each ID with a comma (no spaces).    One of these multiple effects will be randomly chosen each time an effect is to be applied.

If you specify Random as the attribute value, an effect will randomly be chosen from among all defined effects.  Specifying Cycle will cause all defined effects to be cycled through as effects are needed.

Optional; has no default value.

kbMouseControlEnabled true or false

Specifies the gallery default for whether Ken Burns (KB) effects may be controlled by the user.  If enabled, allows the user to use their mouse to pan around photos that have Ken Burns effects applied and, when in their maximum magnification, are larger than the visible area.

Overrides the same setting on the <galleries> node.  May be overridden by setting this same property on <img> nodes.

Optional; defaults to false

 

The <img> nodes

Each slide / image in a gallery is represented by an <img> node which is placed inside the <gallery> holder node.    Each <img> node has the following properties / attributes:

Note: See the Image Property Editing topic for more information and/or illustrations for each property.

Attribute / Property Values Description
title String

This is the title associated with the image.    Along with the description/caption, these are generally the two most commonly used (and important) properties you'll set for each image.    This is the title value which will be displayed in the slideshow's Caption element, or in any dynamic text element for    {image.title}    .    HTML can be used, but must be encoded (see Overview of XML Structure).

Shortcut Text (AKA Replacment Values) can be used in this property; see this topic for more information about replacement values.

Optional, but recommended; if omitted, defaults to an empty string.

caption String

This is the description (or caption) associated with the images.  Along with the title, these are generally the two most commonly used (and important) properties you'll set for each image.    This is the description/caption value which will be displayed in the slideshow's Caption element, or in any dynamic text element for    {image.caption}        .    HTML can be included, but must be encoded (see Overview of XML Structure).

Shortcut Text (AKA Replacment Values) can be used in this property; see this topic for more information about replacement values.

Optional; defaults to empty string.

toolTip String

This is the tooltip text which will be displayed when a user hovers over the image.    HTML can be included, but must be encoded (see Overview of XML Structure).

Shortcut Text (AKA Replacment Values) can be used in this property; see this topic for more information about replacement values.

Optional; no tooltip is displayed if omitted.

id Unique ID String

This optional setting is only for advanced users.  It specifies a unique ID by which can be used to reference the image when creating permalinks or making javascript interface calls.  As described in permalinks topic, specifying an ID makes it simple to link directly to a specific image in a slideshow.

Note: Only letters, numbers and underscores may be used in this value.

Optional; if omitted, the image can still be referenced in permalinks and javascript interface calls using its numeric zero-base index.

src Image URL

This is the URL of the slide's image.  This can be any valid image URL, pointing to a JPEG, GIF, PNG, or even an SWF animation.    Keep in mind that whenever you load from a remote site you may run into Flash Player Cross-domain Loading Restrictions.    The URL must be relative to the HTML page holding the slideshow.

If a fullPathPrefix attribute was specified on the parent <gallery> node (see above), it will be prepended to the URL unless one of the following is true:

  • The URL is absolute (e.g. starts with http://, https://, or file://)
  • The URL has {noprefix} at the start of it.    This tells the slideshow not to apply any prefix to it.

Required.

thumb Thumbnail URL

This can be any valid image URL, pointing to a JPEG, GIF, PNG, or even an SWF animation.    Keep in mind that whenever you load from a remote site you may run into Flash Player Cross-domain Loading Restrictions.    The URL must be relative to the HTML page holding the slideshow.

Optional, but highly recommended.    If you omit this parameter, the full-size image will be loaded, scaled down, and used as the thumbnail.    However, it is highly recommended that you create separate thumbnail images because using the full-size images often results in lengthly loading times, delayed previews, and pixelation due to the high level of scaling.    Using separate thumbnail images ensures an all-around better user experience.    You can generate thumbnails automatically for the entire gallery by using the  Thumbnail Generator in the wizard.  

If a thumbPathPrefix attribute was specified on the parent <gallery> node (see above), it will be prepended to the URL unless one of the following is true:

  • The URL is absolute (e.g. starts with http://, https://, or file://)
  • The URL has {noprefix} at the start of it.    This tells the slideshow not to apply any prefix to it.
hq Image URL

(Advanced parameter for experienced users only)    (Optional; usually unnecessary)    This only applies to certain layouts in the professional version which contain one of the following image display elements: ImagesCoverFlow, ImagesScatter, ImagesScrollList, or ImagesStarfield.    Its applicability is also dependent on the image preloading mode used (especially the 3D preloading mode).

Generally, it is not the best option to use.    However, in some cases, this URL represents the full-size high-quality (HQ) version of the image.    This is the 'upgraded' version of the image which is loaded only when the image becomes the currently selected one.    In these cases, you will set the main Image URL field to a full-size but lower quality (hence smaller file size and quicker loading) version of the image.    Or, you can use a thumbnail version as the full size image but specify explicit dimensions for the HQ image below.    These dimensions will be used to scale the thumb up as if it were the full-size image, displaying it until the HQ image loads.

If a hqPathPrefix attribute was specified on the parent <gallery> node (see above), it will be prepended to the URL unless one of the following is true:

  • The URL is absolute (e.g. starts with http://, https://, or file://)
  • The URL has {noprefix} at the start of it.    This tells the slideshow not to apply any prefix to it.
w Numeric value (Advanced parameter for experienced users only)    If using the HQ Image URL as described above, in some cases you must specify the explicit dimensions of the full-size image so the slideshow knows before the image actually loads  (see HQ Image description for more info).    This specifies the width in pixels.
h Numeric value (Advanced parameter for experienced users only)    If using the HQ Image URL as described above, in some cases you must specify the explicit dimensions of the full-size image so the slideshow knows before the image actually loads  (see HQ Image description for more info).    This specifies the height in pixels.
link Link URL

Specifies the link which is opened when the user clicks on the image.  Specifying a value here will override any gallery-wide defaults (the <gallery> defaultLink property).  The URL can be either a relative path (relative to the slideshow's HTML page), or a full http:// URL.  You can also call javascript by using links in the following format:

javascript:void(myJavascriptFunction('param1', 'param2'));

If you want to have the link open in a true popup window (which gives you control over the size and appearance of the window), you must use a special javascript link.    The Popup Link Builder in the wizard will automatically generate this type of link for you.    See the Using the Popup Link Builder section for more information.

Important note: Whenever using a popup link or a javascript link, you should set the linkTarget property to _self .

Shortcut Text (AKA Replacment Values) can be used in this property; see this topic for more information about replacement values.

linkTarget Link target (e.g. _self, _blank, etc).

Specifies the window in which the image link will be opened.  Specifying a value here will override any gallery-wide defaults (the <gallery> linkTarget property).    The default value of _self will open the link in the current window.  Using _blank will open the link in a new browser window.  Using _parent will open the link in the parent page if using frames.  Specifying any other value will control a specific frame in a frameset.    

For control over the appearance and size of a new window, you must use a true popup window.    See the link property directly above for more information about this.

Important note: Whenever using a popup link or a javascript link, you should set the linkTarget to _self.

Shortcut Text (AKA Replacment Values) can be used in this property; see this topic for more information about replacement values.

Optional; defaults to _self

autoplayDelay Autoplay Delay (see desc.)

When autoplay is enabled, this value specifies the delay between each image/slide.  Because this is a slide-specific value, it configures how long the current image/slide is shown.    You can also specify a value which stops autoplay immediately, or automatically jumps to the image link associated with this image.

These values are specially constructed strings; for details on the format used for this value, see the com.dwuser.ss4.managers.AutoplayManager class in the API Reference.

Optional; has no default value.    Required if Autoplay is being used.

effectType Effect name(s); comma separated if more than 1.

Specifies the default transition effect between all slides if using the ImagesStandard element for image display.    This value overrides the global default on the <galleries> node and the gallery default on the <gallery> node.    If using more than one effect, each of their names must be separated with a comma (no spaces).    For more information about supported transitions, see Setting the Image Transition.    For example: ...effectType="FadeStandard,Cube" ...

Optional; defaults to FadeStandard

audio MP3 file URL

Specifies the URL of the MP3 image-level audio.    This is the audio which plays only while this image is open.    The audio file must be in MP3 format; for necessary formatting guidelines, see Avoiding "Chipmunks" Audio: MP3 Formatting Guidelines.    The URL must be relative to the HTML page which holds the slideshow.

Note: If you are loading audio from a different domain than the one on which the slideshow is displayed, you will be affected by Flash Player crossdomain loading security restrictions.  To learn more, see this topic.    

Note: If you're audio plays back at a distorted speed, like "chipmunks", you need to review the MP3 formatting guidelines referenced above.

The options for gallery-level audio are controlled via the AudioImage selector (see the com.dwuser.ss4.pseudoStyleClasses.AudioImage class in the API Reference).

Optional; has no default value.

audioLabel String label

If an audio attribute has been specified, this attribute specifies the audio label associated with the image-level audio.

Optional; defaults to empty string.

audioAutoplay Omit attribute or true or false

If an audio attribute has been specified, this attribute can be used to override the global image-level audio configuration setting for autoplay.  For example, you might have image-level audio on all slides and have autoplay disabled (the user has to click a play button when interested).  However, on one slide, you want the audio to start playing automatically.  To do this, you would add <img ... audioAutoplay="true" /> for that one slide.

Optional; omitting the parameter prevents any manipuation.  Note: This parameter is a code-only parameter and has no visual representation in the wizard; it must be added manually.

galleryAudioPlay Omit attribute or true or false

This attribute can be used to force the gallery-level audio (if there is any) to play or pause when this image is opened.    Not specifying an attribute (the default) will prevent any manipulation of the gallery-level audio.  Specifying true will force the audio to play; specifying false will force the audio to stop/pause.

Optional; omitting the parameter prevents any manipulation.

galleryAudioPosition Numeric value

This attribute can be used to force the gallery-level audio (if there is any) to jump to a specific location when this image is opened.  This can be used to sync gallery-level audio to a specific location for each slide.    Not specifying an attribute (the default) will prevent any manipulation of the gallery-level audio; otherwise, a numeric value must be passed (representing milliseconds).

Optional; omitting the parameter prevents any manipulation.

introAudioPlay Omit attribute or true or false

This attribute can be used to force the intro-level audio (if there is any) to play or pause when this image is opened.    Not specifying an attribute (the default) will prevent any manipulation of the intro-level audio.  Specifying true will force the audio to play; specifying false will force the audio to stop/pause.

Optional; omitting the parameter prevents any manipulation.

introAudioPosition Numeric value

This attribute can be used to force the intro-level audio (if there is any) to jump to a specific location when this image is opened.  This can be used to sync intro-level audio to a specific location for each slide.    Not specifying an attribute (the default) will prevent any manipulation of the intro-level audio; otherwise, a numeric value must be passed (representing milliseconds).

Optional; omitting the parameter prevents any manipulation.

video Video URL; see desc.

This attribute can be used to add a video file to the slide.    The video URL can point to any of the following types of files:

  • A standard FLV Flash Video File located within your site or hosted at some remote location (see cross-domain loading note below)
  • An H.264 MPEG4 high-definition video file located within your site
  • An RTMP streaming video URL (usually delivered through the Flash Media Server).

Very Important: If using a relative URL, the URL must be relative to the supporting files folder, NOT the HTML page holding the slideshow.  All other relative URLs in the slideshow (for images, audio, etc) are relative to the HTML page, whereas relative video URLs must be relative to the supporting files folder.

If a videoPathPrefix attribute was specified on the parent <gallery> node (see above), it will be prepended to the URL unless one of the following is true:

  • The URL is absolute (e.g. starts with http://, https://, or file://)
  • The URL has {noprefix} at the start of it.    This tells the slideshow not to apply any prefix to it.

Note: If you are loading audio from a different domain than the one on which the slideshow is displayed, you will be affected by Flash Player crossdomain loading security restrictions.  To learn more, see this topic.    

Note for advanced users: To learn about how to customize the appearance of the video player, see the com.dwuser.ss4.video.FlexVideoPlayer class in the API Reference.

Optional; has no default value.

videoAutoStart true or false

If a video URL has been set, specifies whether the video should automatically start when the slide / image opens.    If left at the default value (false), the user must click on the slide to start the video.    In these cases, you may want to specify a toolTip such as "Click to start video...".

Optional; defaults to false

kbEffect KB Effect ID(s); comma separated if more than 1. Also, Random can be used.

Specifies the Ken Burns effect (or effects) for this image.    Ken Burns effects (KB effects) are packages which incorporate both panning and zooming.  You can learn more about KB effects in the <kenburns> section reference.  Setting this attribute will override any default value set on the <gallery> node.  If a gallery-wide default effect exists and you want to override that default on an image with 'no effect' (disabling the KB effect for that image), then use kbEffect="" or kbEffect="None" .  Omitting the attribute on the <img> node causes the gallery-wide default to be inherited.

You can specify multiple KB effect ID values; when doing this, separate each ID with a comma (no spaces).    One of these multiple effects will be randomly chosen each time an effect is to be applied.

If you specify Random as the attribute value, an effect will randomly be chosen from among all defined effects each time the slide / image is displayed.  Specifying Cycle will cause all defined effects to be cycled through as effects are needed.

Optional; has no default value, which causes the gallery-wide default to be inherited.

kbMouseControlEnabled true or false

Specifies the global default for whether Ken Burns (KB) effects may be controlled by the user.  If enabled, allows the user to use their mouse to pan around photos that have Ken Burns effects applied and, when in their maximum magnification, are larger than the visible area.

Overrides the same property on the <galleries> or <gallery> nodes (if these defaults have been specified).

Optional; defaults to false

touchEnabled true (default) or false

Specifies if the slide should be omitted from the alternate touchscreen-optimized presentation.  Set to false to make the slide only appear in the Flash-based presentation.

Optional; if not set to false the slide will be included in the touchscreen-optimized presentation.  Can be set on a gallery-wide basis on the <gallery> node.

flashEnabled true (default) or false

Specifies if the slide should be omitted from the standard Flash-based presentation and only shown in the alternate touchscreen-optimized presentation.  Set to false to make the slide only appear in the touchscreen-optimized presentation.

Optional; if not set to false the slide will be included in the standard Flash-based presentation.  Can be set on a gallery-width basis on the <gallery> node.

 

The <img> Node's Subnodes

There are also two types of nodes which can optionally be placed inside an <img> node.    These nodes, the <note ... /> node and <text ... /> node, define overlay notes and overlay text respectively.    Review each of the linked topics for more information about these two items.

Here is an example of an <img> node with two overlay notes and one overlay text.    The text appears after 3 seconds and disappears 5 seconds later:

<img src="somefile.jpg" ... >
     <note x="50" y="50" width="100" height="60" toolTip="Some information about this spot on the picture" />
     <note x="250" y="350" width="30" height="70" toolTip="Some information about this second spot on the picture" />
     <text x="250" y="50" htmlText="A Special Text Label" delay="3000" visibleTime="5000" />
</img>

The next two sections provide more information about each of these two nodes.

Overlay Note Box (<note ... />) Information

To change how long the note boxes remain visible before automatically hiding, set the noteHideDelay property on the IndividualSlide style selector (see com.dwuser.ss4.ui.IndividualSlide in the API Reference).  If you use a very large value for this setting, the boxes will remain visible after being activated instead of auto-hiding.

To customize the appearance of the boxes and their tooltips, you will use the NoteBox and NoteBoxToolTip style selectors respectively.    For more information, see the com.dwuser.ss4.ui.extras.NoteBox and com.dwuser.ss4.ui.extras.NoteBoxToolTip classes.

To customize the behavior of the tooltips (e.g. the appearance delay and whether they track the mouse), you will use the ToolTipAppearanceManager style selector.    For more information, see the com.dwuser.ss4.managers.ToolTipAppearanceManager class.

All overlay note instances are instances of the com.dwuser.ss4.ui.extras.NoteBox component.    As such, the <note ... /> nodes in the <img> nodes which define the overlay notes are actually NoteBox instances.    They support most of the attributes available for the NoteBox component; see the class reference for available parameters.    The following attributes are especially important and most commonly used:

Attribute / Property Values Description
toolTip String Specifies the tooltip text which is displayed when the user hovers over the overlay note box.
x Numeric value (in pixels) Specifies the horizontal position of the box, in pixels.
y Numeric value (in pixels) Specifies the vertical position of the box, in pixels.
width Numeric value (in pixels) Specifies the width of the box, in pixels.
height Numeric value (in pixels) Specifies the height of the box, in pixels.

 

Overlay Text (<text ... />) Information

All overlay text instances are instances of the mx.controls.Label component.    As such, the <text ... /> nodes in the <img> nodes which define the overlay text-boxes are actually Label instances.    They support most of the attributes available for the Label component; see the class reference in the API Reference for available parameters.

The inherited showEffect and hideEffect attributes can be used if effects are desired if/when the text appears or disappears.    For information about defining effects and the attribute format used to reference them, see the reference for the <effects> section.

The following attributes are especially important and most commonly used (note that the delay and visibleTime properties are special additions; they are NOT inherited from the Label class):

Attribute / Property Values Description
delay Numeric value (in milliseconds) Optionally specifies, in milliseconds, how long after the slide is created before the overlay text box will appear.    If omitted, the text box will be visible as soon as the slide is created.
visibleTime Numeric value (in milliseconds) Specifies, in milliseconds, how long the text will be visible before it automatically hides.    If omitted, the text won't ever automatically hide.
htmlText String Specifies the text displayed in the overlay text box.    HTML can be included, but must be encoded (see Overview of XML Structure).
x Numeric value (in pixels) Specifies the horizontal position of the text box, in pixels.
y Numeric value (in pixels) Specifies the vertical position of the text box, in pixels.
color Hexadecimal color (e.g. #FF0000)

Specifies the color of the text.

Optional; default is #0B333C

fontFamily Font name

Specifies the font used for the text.

Optional; default is Verdana

fontSize Numeric value (in pixels)

Specifies the size of the text, in pixels.

Optional; default is 11