Client-Side Communication ActionScript > Camera.fps

Camera.fps

Availability

	Flash Player 6.
	Flash Communication Server MX (not required).

Usage

activeCamera.fps

Description

Read-only property; the maximum rate at which you want the camera to capture data, in frames per second. The maximum rate possible depends on the capabilities of the camera; that is, if the camera doesn't support the value you set here, this frame rate will not be achieved.

	To set a desired value for this property, use Camera.setMode.
	To determine the rate at which the camera is currently capturing data, use Camera.currentFps.

Example

The following example sets the fps rate of the active camera, myCam.fps, to the value provided by the user's text box, this.config.txt_fps.

if (this.config.txt_fps != undefined) {
     myCam.setMode(myCam.width, myCam.height, this.config.txt_fps, false);
}

Note: The setMode function does not guarantee the requested fps setting; it sets the fps you requested or the fastest fps available.

See also

Camera.currentFps, Camera.setMode