IPresentationClock

PropertiesEvents
Packageispring.presenter.player.clock
Interfacepublic interface IPresentationClock extends flash.events.IEventDispatcher

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 IPresentationClock interface provides information about the current playback position and the state of the presentation playback controller. The IPresentationClock interface can be obtained using the clock property on the IPresentationPlaybackController interface.

This interface has been superseded by the IPresentationClock2 interface since iSpring Pro 6.1 and iSpring Platform 6.1.

See also

ispring.presenter.player.IPresentationPlaybackController
ispring.presenter.presentation.ITimestamp
ispring.presenter.player.clock.PresentationClockEvent
ispring.presenter.player.clock.IPresentationClock2

Public Properties
PropertyDefined By
isRunning : Boolean
[read-only] Indicates whether the clock is running.
IPresentationClock
started : Boolean
[read-only] Indicates whether the clock is started.
IPresentationClock
state : String
[read-only] Returns the state of the clock.
IPresentationClock
timestamp : ITimestamp
[read-only] The current playback position within the presentation.
IPresentationClock
Events
Event Summary Defined By
 
start
Dispatched when the clock is started.IPresentationClock
 
stateChanged
Dispatched when the state of the clock is changed.IPresentationClock
 
stop
Dispatched when the clock is stopped.IPresentationClock
 
tick
Dispatched when the clock is updated.IPresentationClock
Property Detail
isRunningproperty
isRunning:Boolean  [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

Indicates whether the clock is running.

The clock is running when it is started (see the started property) AND the presentation is not being buffered or waiting for the user's action.

The suspended and buffering properties of the IPresentationClock2 interface provide more precise information about the presentation clock state.


Implementation
    public function get isRunning():Boolean

See also

started
ispring.presenter.player.clock.IPresentationClock2.suspended
ispring.presenter.player.clock.IPresentationClock2.buffering
startedproperty 
started:Boolean  [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

Indicates whether the clock is started.

The started presentation clock does not run (see the isRunning property) if the presentation is being buffered or waiting for the user's action.


Implementation
    public function get started():Boolean

See also

isRunning
stateproperty 
state: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

Returns the state of the clock. See the ispring.presenter.player.clock.PresentationClockState constants for more details.

The state2 of the IPresentationClock2 interface provides more precise information about the clock state.


Implementation
    public function get state():String

See also

ispring.presenter.player.clock.PresentationClockState
ispring.presenter.player.clock.IPresentationClock2.state2
timestampproperty 
timestamp:ITimestamp  [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 current playback position within the presentation.


Implementation
    public function get timestamp():ITimestamp

See also

ispring.presenter.presentation.ITimestamp
Event Detail
start Event
Event Object Type: ispring.presenter.player.clock.PresentationClockEvent
PresentationClockEvent.type property = ispring.presenter.player.clock.PresentationClockEvent.START

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 clock is started.

The PresentationClockEvent.START constant defines the value of the type property of the event object for a start event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe 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.
targetThe 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.
stateChanged Event  
Event Object Type: ispring.presenter.player.clock.PresentationClockEvent
PresentationClockEvent.type property = ispring.presenter.player.clock.PresentationClockEvent.STATE_CHANGED

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 state of the clock is changed.

The PresentationClockEvent.STATE_CHANGED constant defines the value of the type property of the event object for a stateChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe 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.
targetThe 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.
stop Event  
Event Object Type: ispring.presenter.player.clock.PresentationClockEvent
PresentationClockEvent.type property = ispring.presenter.player.clock.PresentationClockEvent.STOP

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 clock is stopped.

The PresentationClockEvent.STOP constant defines the value of the type property of the event object for a stop event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe 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.
targetThe 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.
tick Event  
Event Object Type: ispring.presenter.player.clock.PresentationClockEvent
PresentationClockEvent.type property = ispring.presenter.player.clock.PresentationClockEvent.TICK

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 clock is updated.

The PresentationClockEvent.TICK constant defines the value of the type property of the event object for a tick event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe 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.
targetThe 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.




Tue Dec 4 2012, 06:27 PM +04:00