StartVibrate

Availability

Flash Lite 1.1.

Description

Starts the phone's vibration feature. If a vibration is already occurring, Flash Lite stops that vibration before starting the new one. Vibrations also stop when playback of the Flash application is stopped or paused, and when Flash Lite player quits.

Command	Parameters	Value returned
`"StartVibrate"`	`time_on` Amount of time, in milliseconds (to a maximum of 5 seconds), that the vibration is on. `time_off` Amount of time, in milliseconds (to a maximum of 5 seconds), that the vibration is off. `repeat` Number of times (to a maximum of 3) to repeat this vibration.	-1: Not supported. 0: Vibration was started. 1: An error occurred and vibration could not be started.

Command

Parameters

Value returned

"StartVibrate"

time_on Amount of time, in milliseconds (to a maximum of 5 seconds), that the vibration is on.

time_off Amount of time, in milliseconds (to a maximum of 5 seconds), that the vibration is off.

repeat Number of times (to a maximum of 3) to repeat this vibration.

-1: Not supported.

0: Vibration was started.

1: An error occurred and vibration could not be started.

Example

The following example attempts to start a vibration sequence of 2.5 seconds on, 1 second off, repeated twice. It assigns a value to the status variable that indicates success or failure.

status = fscommand2("StartVibrate", 2500, 1000, 2);

StartVibrate

Availability

Description

Example

See also