Packagevegas.media
Classpublic class CameraVO
InheritanceCameraVO Inheritance SimpleValueObject Inheritance Object

This value object contains all values to set a Camera object.



Public Properties
 PropertyDefined By
  bandwidth : int
An integer that specifies the maximum amount of bandwidth the current outgoing video feed can use, in bytes.
CameraVO
  favorarea : Boolean = true
Specifies whether to manipulate the width, height, and frame rate if the camera does not have a native mode that meets the specified requirements.
CameraVO
  fps : Number
The maximum rate at which you want the camera to capture data, in frames per second.
CameraVO
  height : int
The current capture height, in pixels.
CameraVO
 Inheritedid : *
Indicates the id of this ValueObject.
SimpleValueObject
  motionLevel : int
A numeric value that specifies the amount of motion required to invoke the activity event.
CameraVO
  motionTimeout : int
The number of milliseconds between the time the camera stops detecting motion and the time the activity event is invoked.
CameraVO
  quality : int
An integer specifying the required level of picture quality, as determined by the amount of compression being applied to each video frame.
CameraVO
  width : int
The current capture width, in pixels.
CameraVO
Public Methods
 MethodDefined By
  
CameraVO(init:Object = null)
Creates a new CameraVO instance.
CameraVO
  
apply(camera:Camera):void
Apply this value object in the specified Camera reference.
CameraVO
 Inherited
equals(o:*):Boolean
Compares the specified object with this object for equality.
SimpleValueObject
 Inherited
formatToString(className:String = null, ... args):String
A utility function for implementing the toString() method.
SimpleValueObject
  
register(aliasName:String = CameraVO):void
[static] Preserves the class (type) of an object when the object is encoded in Action Message Format (AMF).
CameraVO
  
toObject():Object
[override] Returns the Object representation of this object.
CameraVO
 Inherited
toSource(indent:int = 0):String
Returns the source code string representation of the object.
SimpleValueObject
  
toString():String
[override] Returns the String representation of this object.
CameraVO
Property Detail
bandwidthproperty
public var bandwidth:int

An integer that specifies the maximum amount of bandwidth the current outgoing video feed can use, in bytes.

favorareaproperty 
public var favorarea:Boolean = true

Specifies whether 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 favorArea parameter.

fpsproperty 
public var fps:Number

The maximum rate at which you want the camera to capture data, in frames per second.

heightproperty 
public var height:int

The current capture height, in pixels.

motionLevelproperty 
public var motionLevel:int

A numeric value that specifies the amount of motion required to invoke the activity event.

motionTimeoutproperty 
public var motionTimeout:int

The number of milliseconds between the time the camera stops detecting motion and the time the activity event is invoked.

qualityproperty 
public var quality:int

An integer specifying the required level of picture quality, as determined by the amount of compression being applied to each video frame.

widthproperty 
public var width:int

The current capture width, in pixels.

Constructor Detail
CameraVO()Constructor
public function CameraVO(init:Object = null)

Creates a new CameraVO instance.

Parameters
init:Object (default = null) — A generic object containing properties with which to populate the newly instance. If this argument is null, it is ignored.
Method Detail
apply()method
public function apply(camera:Camera):void

Apply this value object in the specified Camera reference.

Parameters

camera:Camera

register()method 
public static function register(aliasName:String = CameraVO):void

Preserves the class (type) of an object when the object is encoded in Action Message Format (AMF).

Parameters

aliasName:String (default = CameraVO)

toObject()method 
override public function toObject():Object

Returns the Object representation of this object.

Returns
Object — the Object representation of this object.
toString()method 
override public function toString():String

Returns the String representation of this object.

Returns
String — the String representation of this object.