SlideShowPro Player

Events

Events are broadcasted by the SlideShowPro player to communicate noteworthy occurrences like data and content loading, drawing, and behavior. Some events include event object data that can be retrieved and used outside of the SWF.

albumData

Dispatched immediately after an album is requested. Contains data about the album being loaded.

Properties

The data object contains the following properties:

description

(String) The description of the current album

id

(String) The ID of the current album

lgpath

(String) The lgpath attribute of the current album

num

(Number) The numerical position of the album (in relation to the total gallery)

title

(String) The title of the current album

tn

(String) The thumbnail file path for the current album

tnpath

(String) The tnpath attribute of the current album

totalImages

(Number) The total number of images in the current album

Example (ActionScript 3)

The following traces how many images are in the current album:

import net.slideshowpro.slideshowpro.*;
function onSlideShowData(event:SSPDataEvent) {
	if (event.type=="albumData") {
		trace("total images: " + event.data.totalImages);	
	}
}
my_ssp.addEventListener(SSPDataEvent.ALBUM_DATA, onSlideShowData);

albumEnd

Dispatched when a slideshow attempts to load another piece of slideshow content from an album and none exists. This event only fires when a slideshow is in auto-playback mode and additional content is requested from an album that doesn't contain more.

Example (ActionScript 3)

The following example redirects the web browser to a new URL when reaching the end of an album:

import net.slideshowpro.slideshowpro.*;

function onAlbumEnd(event:SSPAlbumEvent) {
    var request:URLRequest = new URLRequest("http://slideshowpro.net/");
    navigateToURL(request,"_self");
}

my_ssp.addEventListener(SSPAlbumEvent.ALBUM_END, onAlbumEnd);

albumStart

Dispatched when an album is loaded.

Properties

Example (ActionScript 3)

The following traces the ID of the album that has started to the Output panel.

import net.slideshowpro.slideshowpro.*;
function onAlbumStart(event:SSPAlbumEvent) {
   trace(event.id);
} 
my_ssp.addEventListener(SSPAlbumEvent.ALBUM_START, onAlbumStart);

displayMode

Dispatched when display mode is toggled from auto playback to manual (and vice versa).

Properties

Example (ActionScript 3)

The following traces the current playback state whenever it changes:

import net.slideshowpro.slideshowpro.*;
function onModePlaybackEvent(event:SSPModePlaybackEvent) {
   trace(event.mode);
} 
my_ssp.addEventListener(SSPModePlaybackEvent.DISPLAY_MODE, onModePlaybackEvent);

galleryClosed

Dispatched when the gallery has reached its final position after a close request has been made.

Properties

Example (ActionScript 3)

The following traces to the Output panel the current visual state of the gallery.

import net.slideshowpro.slideshowpro.*;
function onGalleryStateEvent(event:SSPGalleryStateEvent) {
   trace(event.type);	
}
my_ssp.addEventListener(SSPGalleryStateEvent.GALLERY_CLOSED, onGalleryStateEvent);

galleryClosing

Dispatched when the gallery begins to close.

Properties

Example (ActionScript 3)

The following traces to the Output panel the current visual state of the gallery.

import net.slideshowpro.slideshowpro.*;
function onGalleryStateEvent(event:SSPGalleryStateEvent) {
   trace(event.type);	
}
my_ssp.addEventListener(SSPGalleryStateEvent.GALLERY_CLOSING, onGalleryStateEvent);

galleryData

Dispatched once at the beginning of a slideshow after XML data has been successfully loaded and parsed into a readable array.

Properties

The data object contains a multidimensional array with the following inside:

[[albumObject,[imageObjectArray]]]

Each albumObject contains the same properties delivered by ALBUM_DATA, while the imageObjectArray is an array of image objects containing the same properties delivered by IMAGE_DATA.

Example (ActionScript 3)

The following example traces the title of the third album to the Output panel:

import net.slideshowpro.slideshowpro.*;
function onSlideShowData(event:SSPDataEvent) {
	if (event.type=="galleryData") {
		trace(event.data[2][0].title);
	}
}
my_ssp.addEventListener(SSPDataEvent.GALLERY_DATA, onSlideShowData);

The following example traces the number of images in the third album to the Output panel:

import net.slideshowpro.slideshowpro.*;
function onSlideShowData(event:SSPDataEvent) {
	if (event.type=="galleryData") {
		trace(event.data[2][1].length);
	}
}   
my_ssp.addEventListener(SSPDataEvent.GALLERY_DATA, onSlideShowData);

The following example traces the caption of the fifth image in the third album to the Output panel:

import net.slideshowpro.slideshowpro.*;
function onSlideShowData(event:SSPDataEvent) {
	if (event.type=="galleryData") {
		trace(event.data[2][1][4].caption);
	}
}
my_ssp.addEventListener(SSPDataEvent.GALLERY_DATA, onSlideShowData);

galleryHidden

Dispatched when the gallery is hidden out of view.

Properties

Example (ActionScript 3)

The following traces to the Output panel the current visual state of the gallery.

import net.slideshowpro.slideshowpro.*;
function onGalleryStateEvent(event:SSPGalleryStateEvent) {
   trace(event.type);	
}
my_ssp.addEventListener(SSPGalleryStateEvent.GALLERY_HIDDEN, onGalleryStateEvent);

Events are broadcasted by the SlideShowPro player to communicate noteworthy occurrences like data and content loading, drawing, and behavior. Some events include event object data that can be retrieved and used outside of the SWF.

galleryInfo

Dispatched immediately after gallery data is parsed.

Properties

The data object contains two properties:

title

(String) The title of the gallery.

description

(String) The description of the gallery.

Example (ActionScript 3)

The following example sends the title of the gallery to the Output panel:

import net.slideshowpro.slideshowpro.*;
function onGalleryInfo(event:SSPDataEvent) {
	trace(event.data.title);
}
my_ssp.addEventListener(SSPDataEvent.GALLERY_INFO, onGalleryInfo);

galleryOpen

Dispatched when the gallery has reached its final position after an open request has been made.

Properties

Example (ActionScript 3)

The following traces to the Output panel the current visual state of the gallery.

import net.slideshowpro.slideshowpro.*;
function onGalleryStateEvent(event:SSPGalleryStateEvent) {
   trace(event.type);	
}
my_ssp.addEventListener(SSPGalleryStateEvent.GALLERY_OPEN, onGalleryStateEvent);

galleryOpening

Dispatched when the gallery begins to open, but hasn't finished animating.

Properties

Example (ActionScript 3)

The following traces to the Output panel the current visual state of the gallery.

import net.slideshowpro.slideshowpro.*;
function onGalleryStateEvent(event:SSPGalleryStateEvent) {
   trace(event.type);	
}
my_ssp.addEventListener(SSPGalleryStateEvent.GALLERY_OPENING, onGalleryStateEvent);

galleryToggled

Dispatched when a request to toggle the open/close state of the gallery is made.

Properties

Example (ActionScript 3)

The following traces to the Output panel the current visual state of the gallery.

import net.slideshowpro.slideshowpro.*;
function onGalleryStateEvent(event:SSPGalleryStateEvent) {
   trace(event.type);	
}
my_ssp.addEventListener(SSPGalleryStateEvent.GALLERY_TOGGLED, onGalleryStateEvent);

Events are broadcasted by the SlideShowPro player to communicate noteworthy occurrences like data and content loading, drawing, and behavior. Some events include event object data that can be retrieved and used outside of the SWF.

imageAlign

Dispatched when slideshow content is aligned.

Properties

Example (ActionScript 3)

The following traces the x and y position of the aligned content.

import net.slideshowpro.slideshowpro.*;
function onImageAlignEvent(event:SSPImageFormatEvent) {
   trace(event.x + " " + event.y);
} 
my_ssp.addEventListener(SSPImageFormatEvent.IMAGE_ALIGN, onImageAlignEvent);

imageClick

Dispatched when slideshow content is clicked by the viewer's mouse.

Properties

"previous" is dispatched when the mouse clicks on the left side of the content area, and "next" when the mouse clicks on the right. Both of these are only broadcasted when contentAreaInteractivity is set to "Action Area and Navigation". "action" is dispatched when the mouse clicks the center area, and is broadcasted in both "Action Area and Navigation" and "Action Area Only" settings for contentAreaInteractivity.

Example (ActionScript 3)

The following example traces which area was clicked.

import net.slideshowpro.slideshowpro.*;
function onSlideShowClick(event:SSPImageEvent) {
	if (event.type=="imageClick") {
		trace(event.zone + " was clicked");
	}
}
my_ssp.addEventListener(SSPImageEvent.IMAGE_CLICK, onSlideShowClick);

imageData

Dispatched immediately after slideshow content (video or image) is requested. Contains data about the content being loaded.

Properties

The data object contains all img attributes (and their values) from the XML data loaded by the SlideShowPro player. Because the object is created automatically, you can include additional (non-supported) attributes if you have additional data you wish to use outside of the player. "Supported" attributes (ones used by the component) include:

caption

(String) The caption of the current image/video.

title

(String) The title of the current image/video.

file

(String) The file name of the original image (included with SlideShowPro Director data).

id

(String) The ID of the current image/video.

link

(String) The hyperlink of the current image/video.

number

(Number) The image/video numerical position.

pause

(Number) Overrides the transitionPause property for the current image/video.

src

(String) The file name of the current image/video.

tags

(String) The tags assigned to the current image/video (included with SlideShowPro Director data).

target

(String) The hyperlink target of the current image/video.

tn

(String) The image/video thumbnail URL.

vidpreview

(String) The video preview URL.

isFirst

(Boolean) If the asset is first in the album, this returns true. Otherwise false.

isLast: (Boolean) If the asset is last in the album, this returns true. Otherwise false.

Example (ActionScript 3)

The following example sends the caption of the loaded image to the Output panel:

import net.slideshowpro.slideshowpro.*;
function onSlideShowData(event:SSPDataEvent) {
	if (event.type=="imageData") {
		trace(event.data.caption);
	}
}
my_ssp.addEventListener(SSPDataEvent.IMAGE_DATA, onSlideShowData);

imageFormat

Dispatched when slideshow content is resized.

Properties

Examples

The following traces the formatted width/height of the slideshow content.

import net.slideshowpro.slideshowpro.*;
function onImageFormatEvent(event:SSPImageFormatEvent) {
	if (event.type=="imageFormat") {
	   trace(event.w + " " + event.h);
	}
} 
my_ssp.addEventListener(SSPImageFormatEvent.IMAGE_FORMAT, onImageFormatEvent);

imageLoad

Dispatched when slideshow content successfully loads.

Properties

Example (ActionScript 3)

The following traces the numerical position of the image/video that has loaded:

import net.slideshowpro.slideshowpro.*;
function onImageLoad(event:SSPImageEvent) {
	trace(event.num);
} 
my_ssp.addEventListener(SSPImageEvent.IMAGE_LOAD, onImageLoad);

imageRollOut

Dispatched when slideshow content is rolled-out by the viewer's mouse.

Properties

Example (ActionScript 3)

The following traces to the Output panel "over" or "out" when a user's mouse rolls into and out of slideshow content.

import net.slideshowpro.slideshowpro.*;
function onImageEvent(event:SSPImageEvent) {
	if (event.type=="imageRollOver") {
	   trace("over");
	}
	if (event.type=="imageRollOut") {
	   trace("out");
	}
}
my_ssp.addEventListener(SSPImageEvent.IMAGE_ROLLOUT, onImageEvent);
my_ssp.addEventListener(SSPImageEvent.IMAGE_ROLLOVER, onImageEvent);

imageRollOver

Dispatched when slideshow content is rolled-over by the viewer's mouse.

Properties

Example (ActionScript 3)

The following traces to the Output panel "over" or "out" when a user's mouse rolls into and out of slideshow content.

import net.slideshowpro.slideshowpro.*;
function onImageEvent(event:SSPImageEvent) {
	if (event.type=="imageRollOver") {
	   trace("over");
	}
	if (event.type=="imageRollOut") {
	   trace("out");
	}
}
my_ssp.addEventListener(SSPImageEvent.IMAGE_ROLLOUT, onImageEvent);
my_ssp.addEventListener(SSPImageEvent.IMAGE_ROLLOVER, onImageEvent);

imageZone

Dispatched when slideshow content is rolled-over by the viewer's mouse.

Properties

"previous" is dispatched when the mouse hovers over the left side of the content area, and "next" when the mouse hovers over the right. Both of these are only broadcasted when contentAreaInteractivity is set to "Action Area and Navigation". "action" is dispatched when the mouse hovers over the center area, and is broadcasted in both "Action Area and Navigation" and "Action Area Only" settings for contentAreaInteractivity.

Example (ActionScript 3)

The following example traces which area the mouse is hovering over.

import net.slideshowpro.slideshowpro.*;
function onZoneChange(event:SSPImageEvent) {
	if (event.type=="imageZone") {
		trace(event.zone + " is hovered");
	}
}
my_ssp.addEventListener(SSPImageEvent.IMAGE_ZONE, onZoneChange);

nextImage

Dispatched when the next image button in the navigation is disabled, enabled, and/or clicked.

Properties

Examples

The following traces when a button is enabled and/or disabled.

import net.slideshowpro.slideshowpro.*;
function onNavButtonEvent(event:SSPNavButtonEvent) {
   if (event.mode=="disabled") {
      trace(event.type + " button was disabled");
   }
   if (event.mode=="enabled") {
      trace(event.type + " button was enabled");
   }
} 
my_ssp.addEventListener(SSPNavButtonEvent.NEXT_IMAGE, onNavButtonEvent);
my_ssp.addEventListener(SSPNavButtonEvent.PREV_IMAGE, onNavButtonEvent);
my_ssp.addEventListener(SSPNavButtonEvent.NEXT_IMAGE_GROUP, onNavButtonEvent);
my_ssp.addEventListener(SSPNavButtonEvent.PREV_IMAGE_GROUP, onNavButtonEvent);

nextImageGroup

Dispatched when the next image group button in the navigation is disabled, enabled, and/or clicked.

Properties

Example (ActionScript 3)

The following traces when a button is enabled and/or disabled.

import net.slideshowpro.slideshowpro.*;
function onNavButtonEvent(event:SSPNavButtonEvent) {
   if (event.mode=="disabled") {
      trace(event.type + " button was disabled");
   }
   if (event.mode=="enabled") {
      trace(event.type + " button was enabled");
   }
} 
my_ssp.addEventListener(SSPNavButtonEvent.NEXT_IMAGE, onNavButtonEvent);
my_ssp.addEventListener(SSPNavButtonEvent.PREV_IMAGE, onNavButtonEvent);
my_ssp.addEventListener(SSPNavButtonEvent.NEXT_IMAGE_GROUP, onNavButtonEvent);
my_ssp.addEventListener(SSPNavButtonEvent.PREV_IMAGE_GROUP, onNavButtonEvent);

nextScreen

Dispatched immediately after a gallery screen greater than the one currently being viewed is requested.

Properties

Example (ActionScript 3)

The following traces to the Output panel which screen has been requested:

import net.slideshowpro.slideshowpro.*;
function onGalleryScreenEvent(event:SSPGalleryScreenEvent) {
		trace(event.type);	
	}
}
my_ssp.addEventListener(SSPGalleryScreenEvent.NEXT_SCREEN, onGalleryScreenEvent);
my_ssp.addEventListener(SSPGalleryScreenEvent.PREV_SCREEN, onGalleryScreenEvent);

netStreamStatus

Dispatched when NetStream status updates occur when using video. The status string that is passed as part of the event data is the same data broadcasted as part of the info property of the NetStatusEvent.

Properties

Example (ActionScript 3)

The following example traces any status updates from NetStream when a video is used.

import net.slideshowpro.slideshowpro.*;    
function onNetStreamStatus(event:SSPNetStreamEvent) {    
   trace(event.status);
}     
my_ssp.addEventListener(SSPNetStreamEvent.NET_STREAM_STATUS, onNetStreamStatus);

permalink

Dispatched when a gallery loads and returns a true/false value. True if the slideshow is being accessed with a permalink URL, false if accessed normally.

Properties

Example (ActionScript 3)

The following example traces the permalink state:

import net.slideshowpro.slideshowpro.*;
function onSlideShowData(event:SSPDataEvent) {
	if (event.type=="permalink") {
		trace(event.data);
	}
}
my_ssp.addEventListener(SSPDataEvent.PERMALINK, onSlideShowData);

preloadEnd

Dispatched when preloading has ended.

Properties

preloadInit

Dispatched when a load request has been made.

Properties

preloadProgress

Dispatched whenever the amount of preloaded bytes changes.

Properties

Example (ActionScript 3)

The following traces the percentage amount of data loaded whenever slideshow content is requested:

import net.slideshowpro.slideshowpro.*;
function onPreloadProgress(event:SSPPreloadEvent) {
   trace("percentage loaded: " + event.data);
} 
my_ssp.addEventListener(SSPPreloadEvent.PRELOAD_PROGRESS, onPreloadProgress);

prevImage

Dispatched when the previous image button in the navigation is disabled, enabled, and/or clicked.

Properties

Example (ActionScript 3)

The following traces when a button is enabled and/or disabled.

import net.slideshowpro.slideshowpro.*;
function onNavButtonEvent(event:SSPNavButtonEvent) {
   if (event.mode=="disabled") {
      trace(event.type + " button was disabled");
   }
   if (event.mode=="enabled") {
      trace(event.type + " button was enabled");
   }
} 
my_ssp.addEventListener(SSPNavButtonEvent.NEXT_IMAGE, onNavButtonEvent);
my_ssp.addEventListener(SSPNavButtonEvent.PREV_IMAGE, onNavButtonEvent);
my_ssp.addEventListener(SSPNavButtonEvent.NEXT_IMAGE_GROUP, onNavButtonEvent);
my_ssp.addEventListener(SSPNavButtonEvent.PREV_IMAGE_GROUP, onNavButtonEvent);

prevImageGroup

Dispatched when the previous image group button in the navigation is disabled, enabled, and/or clicked.

Properties

Example (ActionScript 3)

The following traces when a button is enabled and/or disabled.

import net.slideshowpro.slideshowpro.*;
function onNavButtonEvent(event:SSPNavButtonEvent) {
   if (event.mode=="disabled") {
      trace(event.type + " button was disabled");
   }
   if (event.mode=="enabled") {
      trace(event.type + " button was enabled");
   }
} 
my_ssp.addEventListener(SSPNavButtonEvent.NEXT_IMAGE, onNavButtonEvent);
my_ssp.addEventListener(SSPNavButtonEvent.PREV_IMAGE, onNavButtonEvent);
my_ssp.addEventListener(SSPNavButtonEvent.NEXT_IMAGE_GROUP, onNavButtonEvent);
my_ssp.addEventListener(SSPNavButtonEvent.PREV_IMAGE_GROUP, onNavButtonEvent);

prevScreen

Dispatched immediately after a gallery screen before than the one currently being viewed is requested.

Properties

Example (ActionScript 3)

The following traces to the Output panel which screen has been requested:

import net.slideshowpro.slideshowpro.*;
function onGalleryScreenEvent(event:SSPGalleryScreenEvent) {
		trace(event.type);	
	}
}
my_ssp.addEventListener(SSPGalleryScreenEvent.NEXT_SCREEN, onGalleryScreenEvent);
my_ssp.addEventListener(SSPGalleryScreenEvent.PREV_SCREEN, onGalleryScreenEvent);

transEffectEnd

Dispatched when a transition style effect finishes manipulating slideshow content.

Properties

transEffectStart

Dispatched when a transition style effect has begun manipulating slideshow content.

Properties

transPauseEnd

Dispatched when a transition pause has ended.

Properties

transPauseStart

Dispatched when a transition pause has begun.

Properties

videoCuePoint

Dispatched when an embedded cue point is reached while playing a video file.

Properties

The data event object has the following properties:

Example (ActionScript 3)

The following example traces the cue point event object data:

import net.slideshowpro.slideshowpro.*;    
function onVideoCuePoint(event:SSPVideoEvent) {    
   for (var prop in event.data) {
      trace (prop + " = " + event.data[prop]);
   }    
}     
my_ssp.addEventListener(SSPVideoEvent.VIDEO_CUE_POINT, onVideoCuePoint);

videoEnd

Dispatched when a video ends playback.

Properties

Example (ActionScript 3)

The following traces a confirmation message to the Output panel when the video completes:

import net.slideshowpro.slideshowpro.*;  
function onVideoEvent(event:SSPVideoEvent) {  
   if (event.type=="videoEnd") {  
      trace("video has ended");  
   }  
}   
my_ssp.addEventListener(SSPVideoEvent.VIDEO_END, onVideoEvent); 

videoMetadata

Dispatched when and if video metadata is available.

Properties

Example (ActionScript 3)

The following example displays all the metadata that's embedded in a video:

import net.slideshowpro.slideshowpro.*;    
function onVideoEvent(event:SSPVideoEvent) {    
   if (event.type=="videoMetadata") {    
      for (var prop in event.data) {
		  trace (prop + " = " + event.data[prop]);
	  }
   }    
}     
my_ssp.addEventListener(SSPVideoEvent.VIDEO_METADATA, onVideoEvent);

videoPause

Dispatched when a video has paused playback.

Properties

videoPlayRelease

Dispatched when a video playback request is made.

Properties

videoPreviewLoad

Dispatched when a video preview image request is made.

Properties

videoPreviewRemove

Dispatched when a video preview image is removed.

Properties

videoResume

Dispatched when video playback resumes after being paused.

Properties

videoStart

Dispatched when video playback begins.

Properties

Example (ActionScript 3)

The following traces confirmation of video playback beginning:

import net.slideshowpro.slideshowpro.*;
function onVideoEvent(event:SSPVideoEvent) {
   if (event.type=="videoStart") {
      trace("video has started");
   }
} 
my_ssp.addEventListener(SSPVideoEvent.VIDEO_START, onVideoEvent);

videoXMPData

Dispatched when XMP metadata embedded in a video is found.

Properties

Example (ActionScript 3)

The following example displays all the XMP metadata found:

import net.slideshowpro.slideshowpro.*;    
function onXMPEvent(event:SSPVideoEvent) {    
   for (var prop in event.data) {
      trace (prop + " = " + event.data[prop]);
   }
}     
my_ssp.addEventListener(SSPVideoEvent.VIDEO_XMP_DATA, onXMPEvent);

xmlData

Dispatched immediately after data is loaded.

Properties

Example (ActionScript 3)

The following traces to the Output panel the XML data that was loaded:

import net.slideshowpro.slideshowpro.*;
function onSlideShowData(event:SSPDataEvent) {
	trace(event.data);
}
my_ssp.addEventListener(SSPDataEvent.XML_DATA, onSlideShowData);