User Guide

198 Chapter 2: ActionScript Language Reference
Camera.setQuality()
Availability
Flash Player 6.
Usage
active_cam.setQuality(bandwidth:Number, frameQuality:Number) : Void
Parameters
bandwidth
An integer that specifies the maximum amount of bandwidth that the current
outgoing video feed can use, in bytes per second. To specify that Flash video can use as much
bandwidth as needed to maintain the value of
frameQuality, pass 0 for bandwidth. The default
value is 16384.
frameQuality An integer that specifies the required level of picture quality, as determined by
the amount of compression being applied to each video frame. Acceptable values range from 1
(lowest quality, maximum compression) to 100 (highest quality, no compression). To specify that
picture quality can vary as needed to avoid exceeding bandwidth, pass 0 for
frameQuality. The
default value is 0.
Returns
Nothing.
Description
Method; sets the maximum amount of bandwidth per second or the required picture quality of
the current outgoing video feed. This method is generally applicable only if you are transmitting
video using Flash Communication Server.
Use this method to specify which element of the outgoing video feed is more important to your
application—bandwidth use or picture quality.
• To indicate that bandwidth use takes precedence, pass a value for bandwidth and 0 for
frameQuality. Flash will transmit video at the highest quality possible within the specified
bandwidth. If necessary, Flash will reduce picture quality to avoid exceeding the specified
bandwidth. In general, as motion increases, quality decreases.
• To indicate that quality takes precedence, pass 0 for bandwidth and a numeric value for
frameQuality. Flash will use as much bandwidth as required to maintain the specified quality.
If necessary, Flash will reduce the frame rate to maintain picture quality. In general, as motion
increases, bandwidth use also increases.
• To specify that both bandwidth and quality are equally important, pass numeric values for
both parameters. Flash will transmit video that achieves the specified quality and that doesn’t
exceed the specified bandwidth. If necessary, Flash will reduce the frame rate to maintain
picture quality without exceeding the specified bandwidth.