| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
The IPresentationPlaybackController interface provides presentation
playback and navigation control facilities.
To obtain the IPresentationPlaybackController interface use the
playbackController and the restrictedPlaybackController
properties on the IPresentationView interface.
This interface has been superseded by the IPresentationPlaybackController2 interface
since iSpring Pro 6.1 and iSpring Platform 6.1
clock:IPresentationClock [read-only]
| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Returns the presentation clock that provides information about current playback state and position.
Implementation public function get clock():IPresentationClockSee also
currentSlide:ISlide [read-only]
| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Returns the ISlide interface of the current slide.
Implementation public function get currentSlide():ISlide Throws | flash.errors:IllegalOperationError — Throws if the current slide index is undefined (the value of the currentSlideIndex property equals to uint.MAX_VALUE).
|
See also
currentSlideIndex:uint [read-only]
| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Returns the current slide index. If the current slide is undefined, for example, when user input is required
to define the starting slide of the presentation, the uint.MAX_VALUE is returned.
Implementation public function get currentSlideIndex():uintSee also
currentSlideView:ISlideView [read-only]
| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Returns the ISlideView interface providing information about the current slide view.
Implementation public function get currentSlideView():ISlideViewSee also
lastSlideViewedIndex:uint [read-only]
| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
The index of the last slide viewed.
The value of this property is equal to uint.MAX_VALUE if the last slide viewed has not been defined yet,
e.g. the user has viewed only one slide.
Implementation public function get lastSlideViewedIndex():uintnextSlideIndex:uint [read-only]
| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Returns the next slide index taking hidden slides and custom slide shows
into account.
The uint.MAX_VALUE is returned if the next slide is not available, for example,
if the current slide is the last slide of the presentation, or if the current slide is undefined
(the value of the currentSlideIndex property equals to uint.MAX_VALUE).
Implementation public function get nextSlideIndex():uintSee also
playbackState:String [read-only]
| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
The presentation playback state.
See the ispring.presenter.player.PresentationPlaybackState constants for more details.
Implementation public function get playbackState():StringSee also
previousSlideIndex:uint [read-only]
| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Returns the previous slide index taking hidden slides and custom slide shows
into account.
The uint.MAX_VALUE is returned if the previous slide is not available, for example,
if the current slide is the first slide of the presentation, or if the current slide is undefined
(the value of the currentSlideIndex property equals to uint.MAX_VALUE).
Implementation public function get previousSlideIndex():uintSee also
requestedSlideIndex:uint [read-only]
| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
The index of the requested slide.
The requested slide is a slide which the player is about to switch to after the slide data is loaded.
The presentation playback controller dispatches the slideChangeRequest event
to notify its listeners about the requested slide change. The requestedSlideIndex property
stores the index of the requested slide.
The value of this property is equal to uint.MAX_VALUE in the following cases:
- No slide is requested at the moment, for example, if the current slide has just been changed.
- The default behavior of the
slideChangeRequest event has been prevented in an event listener.
The default value is uint.MAX_VALUE.
Implementation public function get requestedSlideIndex():uintSee also
slideTransitionController:ISlideTransitionController [read-only]
| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Returns the slide transition controller which provides information about the slide transition state.
Implementation public function get slideTransitionController():ISlideTransitionControllerSee also
public function endSlideShow():void| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Ends the currently playing slide show.
See also
public function gotoFirstSlide(autoStart:Boolean, considerHiddenSlides:*):void| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Moves to the beginning of the first slide of the presentation.
Parameters
| autoStart:Boolean — Indicates whether to start the first slide playback automatically.
|
| |
| considerHiddenSlides:* (default = NaN)undefined value indicates that hidden slides should be handled the way they are handled in PowerPoint.
|
See also
public function gotoLastSlide(autoStart:Boolean, considerHiddenSlides:*):void| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Moves to the beginning of the last slide of the presentation.
Parameters
| autoStart:Boolean — Indicates whether to start the last slide playback automatically.
|
| |
| considerHiddenSlides:* (default = NaN)undefined value indicates that hidden slides should be handled the way they are handled in PowerPoint.
|
See also
public function gotoLastSlideViewed(autoStart:Boolean = true):void| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Switches to the last slide viewed.
Parameters
| autoStart:Boolean (default = true) |
See also
public function gotoNextSlide(autoStart:Boolean = true):void| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Switches to the next slide taking hidden slides and
custom slide shows into account.
Parameters
| autoStart:Boolean (default = true) |
Throws | flash.errors:IllegalOperationError — Throws if current slide is undefined (the value of the currentSlideIndex property equals to uint.MAX_VALUE).
|
See also
public function gotoNextStep():void| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Starts playback from the next animation step of the presentation.
See also
public function gotoPreviousSlide(autoStart:Boolean = true):void| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Switches to the previous slide taking hidden slides and
custom slide shows into account.
Parameters
| autoStart:Boolean (default = true) |
Throws | flash.errors:IllegalOperationError — Throws if current slide is undefined (the value of the currentSlideIndex property equals to uint.MAX_VALUE).
|
See also
public function gotoPreviousStep():void| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Moves one animation step back and pauses.
See also
public function gotoSlide(slideIndex:uint, autoStart:Boolean = true):void| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Switches to the specified slide of the presentation.
Parameters
| slideIndex:uint — A slide index to switch to.
|
| |
| autoStart:Boolean (default = true) |
See also
public function gotoTimestamp(slideIndex:uint, stepIndex:int, timeOffset:Number, autoStart:Boolean = false):void| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Moves to the specified position within the presentation.
Parameters
| slideIndex:uint — The index of the target slide within the presentation.
|
| |
| stepIndex:int — The index of the target animation step within the target slide.
|
| |
| timeOffset:Number — Time offset from the beginning of the target animation step, in seconds.
|
| |
| autoStart:Boolean (default = false) |
public function pause():void| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Suspends the playback of the presentation, sounds, and videos.
See also
public function play():void| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Resumes the playback of the presentation, sounds, and videos.
See also
public function slideIsViewed(slideIndex:uint):Boolean| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Determines whether a slide with the specified index has been viewed.
Parameters
| slideIndex:uint — The index of the slide.
|
Returns | Boolean — true if the slide has been viewed; false otherwise.
|
public function startSlideShow(slideShowName:String, showAndReturn:Boolean):void| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Starts a slide show with the specified name.
Parameters
| slideShowName:String — The name of the slide show.
|
| |
| showAndReturn:Boolean — Indicates whether to return to the current slide show as soon as the started slide show ends.
|
See also
Event Object Type: ispring.presenter.player.events.PresentationPlaybackEventPresentationPlaybackEvent.type property = ispring.presenter.player.events.PresentationPlaybackEvent.CLOSE_REQUEST| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Dispatched when the slide show is over and the presentation is about to close.
The
PresentationPlaybackEvent.CLOSE_REQUEST constant defines the value of the
type
property of the event object for a
closeRequest event.
The properties of the event object have the following values:
| Property | Value |
|---|
bubbles | false |
cancelable | true; This event is cancelable. Use the preventDefault() method to prevent closing of the Flash player window. |
currentTarget | The Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget. |
target | The Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event. |
Event Object Type: ispring.presenter.player.events.PresentationPlaybackEventPresentationPlaybackEvent.type property = ispring.presenter.player.events.PresentationPlaybackEvent.PLAYBACK_COMPLETE| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Dispatched when the presentation playback is complete.
The
PresentationPlaybackEvent.PLAYBACK_COMPLETE constant defines the value of the
type
property of the event object for a
playbackComplete event.
The properties of the event object have the following values:
| Property | Value |
|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget. |
target | The Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event. |
Event Object Type: ispring.presenter.player.events.PresentationPlaybackEventPresentationPlaybackEvent.type property = ispring.presenter.player.events.PresentationPlaybackEvent.PLAYBACK_STATE_CHANGE| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Dispatched when the current playback state changes.
Event Object Type: ispring.presenter.player.events.PresentationStartupEventPresentationStartupEvent.type property = ispring.presenter.player.events.PresentationStartupEvent.PRESENTATION_STARTUP| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Dispatched when the presentation is about to start allowing the default presentation startup behavior overriding.
The
PresentationStartupEvent.PRESENTATION_STARTUP constant defines the value of the
type
property of the event object for a
presentationStartup event.
The properties of the event object have the following values:
| Property | Value |
|---|
bubbles | false |
cancelable | true; This event is cancelable. Use the preventDefault() method to prevent the presentation startup. The prevented presentation startup can be resumed using any of the playback control methods on the IPresentationPlaybackController interface. |
currentTarget | The Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget. |
startup | The IPresentationStartup interface providing information about the presentation startup behavior. Use this interface properties to override the default presentation startup behavior. |
target | The Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event. |
Please note that the player skin may also listen to the presentationStartup event and
attempt to override the default startup behavior in its own way. To prevent the skin from overriding the
startup behavior add a presentationStartup listener to the IPresentationPlaybackController interface
with the higher priority level to handle this event before the skin (the standard iSpring skins handle this event with the priority level 0).
Then call the stopImmediatePropagation() method on the PresentationStartupEvent object after handling the event in the event handler.
Event Object Type: ispring.presenter.player.events.PresentationPlaybackEventPresentationPlaybackEvent.type property = ispring.presenter.player.events.PresentationPlaybackEvent.SLIDE_CHANGE| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Dispatched when the current slide changes.
The
PresentationPlaybackEvent.SLIDE_CHANGE constant defines the value of the
type
property of the event object for a
slideChange event.
The properties of the event object have the following values:
| Property | Value |
|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget. |
target | The Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event. |
Event Object Type: ispring.presenter.player.events.RestrictedPresentationPlaybackEvent2RestrictedPresentationPlaybackEvent2.type property = ispring.presenter.player.events.RestrictedPresentationPlaybackEvent2.SLIDE_CHANGE_NOT_ALLOWED| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.1, iSpring Platform 6.1 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Dispatched by the resticted version of the presentation playback controller
when slide switching is not allowed.
The
RestrictedPresentationPlaybackEvent2.SLIDE_CHANGE_NOT_ALLOWED constant defines the value of the
type
property of the event object for a
slideChangeNotAllowed event.
The properties of the event object have the following values:
| Property | Value |
|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget. |
restriction | The ISlideChangeRestriction interface providing information about the slide change restriction reason. |
target | The Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event. |
See also
Event Object Type: ispring.presenter.player.events.RestrictedPresentationPlaybackEvent3RestrictedPresentationPlaybackEvent3.type property = ispring.presenter.player.events.RestrictedPresentationPlaybackEvent3.SLIDE_CHANGE_NOT_ALLOWED_3| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.2.1, iSpring Platform 6.2.1 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Dispatched by the resticted version of the presentation playback controller
when slide switching is not allowed.
This event provides more detailed information about slide change restriction.
The
RestrictedPresentationPlaybackEvent3.SLIDE_CHANGE_NOT_ALLOWED_3 constant defines the value of the
type
property of the event object for a
slideChangeNotAllowed_3 event.
The properties of the event object have the following values:
| Property | Value |
|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget. |
restriction | The ISlideChangeRestriction2 interface providing information about the slide change restriction reason. |
target | The Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event. |
See also
Event Object Type: ispring.presenter.player.events.PresentationPlaybackEventPresentationPlaybackEvent.type property = ispring.presenter.player.events.PresentationPlaybackEvent.SLIDE_CHANGE_REQUEST| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Dispatched when the presentation playback controller is requesting the change of the current slide.
The requestedSlideIndex property stores the index of the requested slide.
The
PresentationPlaybackEvent.SLIDE_CHANGE_REQUEST constant defines the value of the
type
property of the event object for a
slideChangeRequest event.
The properties of the event object have the following values:
| Property | Value |
|---|
bubbles | false |
cancelable | true; This event is cancelable. Use the preventDefault() method to prevent slide changing. |
currentTarget | The Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget. |
target | The Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event. |
See also
Event Object Type: ispring.presenter.player.events.SlideViewedEventSlideViewedEvent.type property = ispring.presenter.player.events.SlideViewedEvent.SLIDE_VIEWED| Language Version : | ActionScript 3.0 |
| Product Versions : | iSpring Pro 6.0.3, iSpring Platform 6.0 |
| Runtime Versions : | AIR 1.0, Flash Player 10.1 |
Dispatched when a slide is being viewed for the first time.
The
SlideViewedEvent.SLIDE_VIEWED constant defines the value of the
type
property of the event object for a
slideViewed event.
The properties of the event object have the following values:
| Property | Value |
|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget. |
target | The Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event. |
slideIndex | The index of the viewed slide. |
Tue Dec 4 2012, 06:27 PM +04:00