Packageispring.presenter.presentation.slides
Interfacepublic interface ISlides

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 ISlides interface represents a collection of presentation slides.

The ISlides interface can be obtained using the slides property on the IPresentation interface.

Starting from iSpring Pro 6.1 and iSpring Plarform 6.1 the ISlides2 interface with extended functionality has become available.

See also

ispring.presenter.presentation.IPresentation
ispring.presenter.presentation.ITimestamp
ispring.presenter.presentation.slides.ISlide
ispring.presenter.presentation.slides.ISlides2


Public Properties
PropertyDefined By
count : uint
[read-only] Returns the number of slides within the collection including both visible and hidden ones.
ISlides
duration : Number
[read-only] Returns the total duration, in seconds, of the presentation slides.
ISlides
visibleAnimationStepsDuration : Number
[read-only] Returns the total duration, in seconds, of the animation steps on the visible slides only.
ISlides
visibleSlidesCount : uint
[read-only] Returs the number of slides not marked as hidden.
ISlides
visibleSlidesDuration : Number
[read-only] Returns the total duration, in seconds, of the visible slides only.
ISlides
Public Methods
MethodDefined By
 
convertTimestampToTime(timestamp:ITimestamp, considerTransitions:Boolean = true, skipHiddenSlides:Boolean = true):Number
Calculates the time offset from the beginning of the presentation to the specified presentation position.
ISlides
 
convertTimeToTimestamp(time:Number, considerTransitions:Boolean = true, skipHiddenSlides:Boolean = true):ITimestamp
Returns the position within the presentation that corresponds to the specified time offset.
ISlides
 
getSlide(index:uint):ISlide
Returns the ISlide interface of the slide that exists at the specified index.
ISlides
 
Returns the ISlide interface of the visible slide that exists at the specified index.
ISlides
Property Detail
countproperty
count: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 number of slides within the collection including both visible and hidden ones.

The total number of the visible slides can be obtained using the visibleSlidesCount property on the ISlides interface.


Implementation
    public function get count():uint

See also

durationproperty 
duration:Number  [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 total duration, in seconds, of the presentation slides. The slide duration is the sum of the slide animation steps and the transition effects duration.


Implementation
    public function get duration():Number

See also

visibleAnimationStepsDurationproperty 
visibleAnimationStepsDuration:Number  [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 total duration, in seconds, of the animation steps on the visible slides only. It does not include the slide transition effects duration.


Implementation
    public function get visibleAnimationStepsDuration():Number

See also

visibleSlidesCountproperty 
visibleSlidesCount: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

Returs the number of slides not marked as hidden.

The total number of slides including visible and hidden can be obtained using the count property on the ISlides interface.


Implementation
    public function get visibleSlidesCount():uint

See also

visibleSlidesDurationproperty 
visibleSlidesDuration:Number  [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 total duration, in seconds, of the visible slides only.


Implementation
    public function get visibleSlidesDuration():Number

See also

Method Detail
convertTimestampToTime()method
public function convertTimestampToTime(timestamp:ITimestamp, considerTransitions:Boolean = true, skipHiddenSlides:Boolean = true):Number

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

Calculates the time offset from the beginning of the presentation to the specified presentation position.

Parameters

timestamp:ITimestamp — The position, represented by the ITimestamp interface, within the presentation to convert into time offset.
 
considerTransitions:Boolean (default = true) — Indicates whether to include the slide transition duration when calculating the time offset.
 
skipHiddenSlides:Boolean (default = true) — Indicates whether to skip the presentation hidden slides when calculating the time offset.

Returns
Number — The time offset, in seconds, to the specified presentation position from the beginning of the presentation.

Throws
ArgumentError — Throws if the timestamp parameter is null.
 
RangeError — if the timestampis out of the presentation bounds.

See also

convertTimeToTimestamp()method 
public function convertTimeToTimestamp(time:Number, considerTransitions:Boolean = true, skipHiddenSlides:Boolean = true):ITimestamp

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 position within the presentation that corresponds to the specified time offset.

Parameters

time:Number — The time offset, in seconds, from the beginning of the presentation.
 
considerTransitions:Boolean (default = true) — Indicates whether to include the slide transition duration when calculating the timestamp.
 
skipHiddenSlides:Boolean (default = true) — Indicates whether to skip the presentation hidden slides when calculating the timestamp.

Returns
ITimestamp — The ITimestamp interface corresponding to the specified time offset.

Throws
RangeError — Throws if the time parameter is NaN, less than zero, or out of the presentation boundaries.

See also

getSlide()method 
public function getSlide(index:uint):ISlide

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 slide that exists at the specified index.

Parameters

index:uint — The index of the slide within the presentation. The index value must be in the range from 0 to the number of slides minus 1.

Returns
ISlide — The slide at the specified index position.

Throws
RangeError — Throws if the specified slide index is out of range.

See also

getVisibleSlide()method 
public function getVisibleSlide(index:uint):ISlide

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 visible slide that exists at the specified index. A visible slide is a slide that is not marked as hidden.

Parameters

index:uint — The index of the slide within the presentation. The index value must be in the range from 0 to the number of visible slides minus 1.

Returns
ISlide — The visible slide at the specified index position.

Throws
RangeError — Throws if the specified visible slide index is out of range.

See also