iSpring.as2player.IPresentationPlaybackController Interface

The IPresentationPlaybackController interface extends the standard flash.events.IEventDispatcher Interface and provides the following properties, methods and events for presentation playback and navigation control.

Properties

Property

Type

Description

playing

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

animationStepPause

Number

Sets a pause between animation steps. If an undefined value is passed as pause value, animation steps will not be played automatically.

automaticSlideSwitching

Boolean

Enables or disables automatic switching to the next slide.
Note: this property affects automatically switching slides only.
Returns true if automatic slide switching has been enabled, false otherwise.
Note: automatic slide switching is enabled by default

currentVisibleSlideIndex

Number

Current visible slide index (read only)

nextSlideIndex

Number

Next slide index (read only)

previousSlideIndex

Number

Previous slide index (read only)


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

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

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

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

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

gotoVisibleSlide(visibleSlideIndex:Number, [autoStart:Boolean = true]):Void

Switches to the given slide within visible slides 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.

gotoFirstSlide([autoStart:Boolean = true]):Void

Switches to the first presentation slide 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.

gotoLastSlide([autoStart:Boolean = true]):Void

Switches to the last presentation slide 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.


Events

Type

Description

SlidePlaybackEvent.SLIDE_LOADING_COMPLETE

Occurs when a slide of the presentation is loaded.

SlidePlaybackEvent.CURRENT_SLIDE_INDEX_CHANGED

Occurs when current slide is changed by another slide of the presentation.

StepPlaybackEvent.ANIMATION_STEP_CHANGED

Occurs when currently playing animation step index is changed.

PlaybackEvent.START_PLAYBACK

Occurs when presentation playback is started.

PlaybackEvent.PAUSE_PLAYBACK

Occurs when presentation playback is suspended.

PlaybackEvent.PRESENTATION_PLAYBACK_COMPLETE

Occurs when presentation playback is complete.

PlaybackEvent.SEEKING_COMPLETE

Occurs when a seek command execution is completed.

PlaybackPositionEvent.SLIDE_POSITION_CHANGED

Occurs when the playback position of the currently playing slide is changed.

AcquireFocusEvent.KEYBOARD_FOCUS_STATE_CHANGED

Occurs when interactive element of the presentation (e.g. a text field of a Quiz) acquires or loses keyboard focus.

See also

IPlayer Interface
SlidePlaybackEvent Class
PlaybackEvent Class
StepPlaybackEvent Class
PlaybackPositionEvent Class
AcquireFocusEvent Class
ActionScript 3 and Flex support in iSpring