iSpring.as3bridge.PlaybackController Class

The PlaybackController class extends the standard flash.events.EventDispatcher Class and provides the following properties, methods and events for presentation playback and navigation control.

Properties

Property	Type	Description
isPlaying	Boolean	Indicates whether the presentation is playing or not (read only)
currentSlideDuration	Number	A duration of the currently playing slide (read only)
currentSlideIndex	Number	Current slide index (read only)
currentSlidePlaybackPosition	Number	Returns playback position within current slide. Note: playback position is a number between 0 and 1
currentStepIndex	Number	Returns current animation step index

Methods

Method	Description
play():Void	Resumes presentation playback
pause():Void	Suspends presentation playback
gotoNextSlide([autoStart:Boolean = true]):Void	Switches to the next presentation slide and starts its playback. Note: if the autoStart parameter was set to false, slide playback would not be started after switching
gotoPreviousSlide([autoStart:Boolean = true]):Void	Switches to the previous presentation slide and starts its playback. Note: if the autoStart parameter was set to false, slide playback would not be started after switching
gotoLastViewedSlide([autoStart:Boolean = true]):Void	Switches to the previously viewed slide and starts its playback. Note: if the autoStart parameter was set to false, slide playback would not be started after switching
getCurrentSlideIndex():Number	Returns a zero-based index of currently playing slide
gotoSlide(slideIndex:Number, [autoStart:Boolean = true]):Void	Switches to the given slide of the presentation and starts its playback Notes: Slide index is zero-based. If the autoStart parameter was set to false, slide playback would not be started after switching
getCurrentSlidePlaybackPosition():Number	Returns playback position within current slide. Note: playback position is a number between 0 and 1
pauseCurrentSlideAt(position:Number):Void	Suspends currently playing slide at the given position Note: position is a number in between 0 and 1
playCurrentSlideFrom(position:Number):Void	Restarts current slide from the given position. Note: position is a number between 0 and 1
seek(position:Number):Void	Seeks the current slide to the given position. After this operation slide playback gets suspended until the endSeek() method or other playback control method is called Note: position is a number between 0 and 1
endSeek([resumePlayback:Boolean = undefined]):Void	Exits from seeking mode and restores playback. Note: the resumePlayback parameter allows to start or pause slide after seeking explicitly
getCurrentStepIndex():Number	Returns current animation step index
gotoNextStep():Void	Plays current slide from the beginning of the next animation step. Note: being called at the end of the slide this method plays presentation from the beginning of the next slide
gotoPreviousStep():Void	Moves slide playback one step back. This method suspends slide playback at the end of the previous animation step. Note: being called on the start slide step this method causes playback switching to the end of the previous slide
setAnimationStepPause(pause:Number):Void	This method allows setting a pause between animation steps. If an undefined value is passed as pause value, animation steps will not be played automatically
playFromStep(stepIndex:Number):Void	Plays current slide from the beginning of the specified animation step
pauseAtStepStart(stepIndex:Number):Void	Suspends current slide at the beginning of the specified animation step
pauseAtStepEnd(stepIndex:Number):Void	Suspends current slide at the end of specified animations step
enableAutomaticSlideSwitching(enableSwitching:Boolean):Void	Enables or disables automatic switching to the next slide. Note: this method affects automatically switching slides only.
getAutomaticSlideSwitching():Boolean	Returns true if automatic slide switching has been enabled, false otherwise. Note: automatic slide switching is enabled by default

Events

Type	Description
BridgeEvent.PAUSE	Occurs when presentation playback is suspended
BridgeEvent.PLAY	Occurs when presentation playback is suspended
BridgeEvent.STEP_CHANGE	Occurs when currently playing animation step index is changed
BridgeEvent.POSITION_CHANGE	Occurs when the playback position of the currently playing slide is changed
BridgeEvent.SLIDE_CHANGE	Occurs when current slide is changed by another slide of the presentation
BridgeEvent.SLIDE_LOAD_COMPLETE	Occurs when a slide of the presentation is loaded
BridgeEvent.PLAYBACK_COMPLETE	Occurs when the presentation playback is completed
BridgeEvent.SEEKING_COMPLETE	Occurs when a seek command execution is completed