fsplayer.api.IAnimationStep Interface

The IAnimationStep Interface provides the information about animation step timings. It exposes the following methods:

Table 1. Methods
Method Description
getPlayTime():Number Returns animation step play time (see the remarks section)
getPauseTime():Number Returns animation step pause time (see the remarks section)
getStartTime():Number Returns animation step start time (see the remarks section)
getPauseStartTime():Number Returns animation step pause start time (see the remarks section)
getPauseEndTime():Number Returns animation step pause end time (see the remarks section)

Remarks

Each slide consists of one or more animation steps with the following structure.

Figure 1. Animation Step Structure

An Animation step starts playing at the Step start time. Animations are playing for the Play time. Then, at the Pause start time, animations are suspended for the Pause time period till the Pause end time. Pause time depends on slide timings that were set using "Record narration" or "Rehearse timings" menu of PowerPoint.

stepStartTime0 = 0
pauseStartTimei = stepStartTimei + playTimei
pauseEndTimei = pauseStartTimei + pauseTimei
stepStartTimei+1 = pauseEndTimei

If the slide has no timings (i.e. user has to click slide background to advance mouse-driven animations), Pause time and Pause end time are undefined. In this case returned timings are as follows:

pauseStartTimei = stepStartTimei + playTimei
pauseEndTimei = undefined
stepStartTimei+1 = pauseStartTimei