SeiON: Actionscript 3 Sound Engine | All Packages | All Classes | Index | Frames No Frames |
CountDown

Package | com.SeiON.Core
Class | public final class CountDown
Inheritance | CountDown flash.utils.Timer

A countdown timer that will trigger TimerEvent when it is done. Used by SeiON to prematurely end sounds (aka truncate).

Public Properties

| Property | Defined By
--- | --- | ---
|  | delay : Number [override] The countdown this Timer was set with, in Milliseconds. | CountDown
|  | paused : Boolean [read-only] Whether the Timer is paused or not. | CountDown
|  | repeatCount : int [override] Disabled. | CountDown
|  | timeRemaining : int [read-only] The amount of time remaining in the countdown, in milliseconds. | CountDown

Public Methods

| Method | Defined By
--- | --- | ---
|  | CountDown(time:int) Creates a countdown timer. | CountDown
|  | pause():void Pauses the countdown. | CountDown
|  | reset():void [override] Stops the countdown. | CountDown
|  | resume():void Resumes counting down if Timer had been paused. | CountDown
|  | start():void [override] Starts counting down. | CountDown
|  | stop():void [override] Stops the countdown. | CountDown

Property Detail

delay | property

`delay:Number`[override]

The countdown this Timer was set with, in Milliseconds. Setting a negative value will default to 0. If delay = 0, CountDown will refuse to start. If you set a new delay time while Timer is running or paused, the Timer will either reset or restart itself respectively.

Implementation
`public function get delay():Number`
`public function set delay(value:Number):void`

paused | property |

`paused:Boolean` [read-only]

Whether the Timer is paused or not.

Implementation
`public function get paused():Boolean`

repeatCount | property |

`repeatCount:int`[override]

Disabled.

Implementation
`public function get repeatCount():int`
`public function set repeatCount(value:int):void`

timeRemaining | property |

`timeRemaining:int` [read-only]

The amount of time remaining in the countdown, in milliseconds.

Implementation
`public function get timeRemaining():int`
Constructor Detail

CountDown | () | Constructor

`public function CountDown(time:int)`

Creates a countdown timer.

Parameters

| `time:int` — The countdown timing. (Milliseconds) If 0, CountDown refuses to start.

Method Detail

pause | () | method

`public function pause():void`

Pauses the countdown.

reset | () | method |

`override public function reset():void`

Stops the countdown. stop() and reset() are identical.

resume | () | method |

`public function resume():void`

Resumes counting down if Timer had been paused. Does nothing otherwise.

start | () | method |

`override public function start():void`

Starts counting down. If there was any playback originally, this will force CountDown to restart from the beginning.

stop | () | method |

`override public function stop():void`

Stops the countdown. stop() and reset() are identical.

Tue Jun 21 2011, 10:05 PM +08:00