MACROMEDIA FLASH MX 2004-ACTIONSCRIPT LANGUAGE, Reference

Page: 194 / 1104

194 Chapter 2: ActionScript Language Reference
Camera.setMode()
Availability
Flash Player 6.
Usage
active_cam .setMode( width:Number , height:Number , fps:Number
[,f avorSize:Boolean ]) : Void
Parameters
width
The requested capture width, in pixels. The default value is 160.
height
The requested capture height, in pixels. The default value is 120.
fps
The requested rate at which the camera should capture data, in frames per second. The
default value is 15.
favorSize
A Boolean value that specifies how to manipulate the width, height, and frame rate
if the camera does not have a native mode that meets the specified requirements. The default
value is
true
, which means that maintaining capture size is favored; using this parameter selects
the mode that most closely matches
width
and
height
values, even if doing so adversely affects
performance by reducing the frame rate. To maximize frame rate at the expense of camera height
and width, pass
false
for the
favorSize
parameter. This parameter is optional.
Returns
Nothing.
Description
Method; sets the camera capture mode to the native mode that best meets the specified
requirements. If the camera does not have a native mode that matches all the parameters you pass,
Flash selects a capture mode that most closely synthesizes the requested mode. This manipulation
may involve cropping the image and dropping frames.
By default, Flash drops frames as needed to maintain image size. To minimize the number of
dropped frames, even if this means reducing the size of the image, pass
false
for the
favorSize
parameter.
When choosing a native mode, Flash tries to maintain the requested aspect ratio whenever
possible. For example, if you issue the command
active_cam . setMode ( 400, 400, 30 )
, and the
maximum width and height values available on the camera are 320 and 288, Flash sets both the
width and height at 288; by setting these properties to the same value, Flash maintains the 1:1
aspect ratio you requested.
To determine the values assigned to these properties after Flash selects the mode that most closely
matches your requested values, use
Camera.width
,
Camera.height
, and
Camera.fps
.