fsplayer.api.IPlayer Interface

iSpring generated Flash presentations contain an embedded player which plays slide animations, transition effects and sounds. This player exposes an ActionScript 2.0 API available to external Flash applications.

The IPlayer interface is provided by Flash presentations generated with iSpring. It exposes the following methods:

Table 1. Methods
Method Description

Returns a Boolean value indicating whether the player was initialized. The following methods return an undefined value until the player gets initialized:

  • getPresentationInfo()
  • getPlaybackController()
  • getSoundController()
  • getSettings()
addListener(listener:IPlayerListener):Void Adds an external listener object implementing the IPlayerListener interface to the player. The passed listener object will receive notifications from the player
removeListener(listener:IPlayerListener):Void Removes the listener object added earlier with addListener() method
getPlaybackController():IPresentationPlaybackController Returns the IPresentationPlaybackController interface providing presentation playback control and navigation facilites
getSoundController():ISoundController Returns the ISoundController interface providing sound volume control facilities
getPresentationInfo():IPresentationInfo Returns the IPresentationInfo interface providing the presentation content information
getSettings():Object Returns an Object storing playback and navigation settings as well as skin related settings (see the remarks section) This method is mainly used for the custom skins development. In most cases you don't need to use it.
getSkin():ISkin Returns the ISkin interface of the player
getKeyboardSettings():IKeyboardSettings Returns the IKeyboardSettings interface providing keyboard navigation options


An object returned by the getSettings() method contains a set of implementation specific properties. Currently, this object has the following structure: