Packagevegas.media
Classpublic class MicrophoneVO
InheritanceMicrophoneVO Inheritance SimpleValueObject Inheritance Object

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


Public Properties
 PropertyDefined By
 Inheritedid : *
Indicates the id of this ValueObject.
SimpleValueObject
  loopBack : Boolean = true
Routes audio captured by a microphone to the local speakers.
MicrophoneVO
  rate : Number = 11
The rate at which the microphone captures sound, in kHz.
MicrophoneVO
  silenceLevel : Number
The amount of sound required to activate the microphone and dispatch the activity event.
MicrophoneVO
  silenceTimeout : Number
The number of milliseconds between the time the microphone stops detecting sound and the time the activity event is dispatched.
MicrophoneVO
  useEchoSuppression : Boolean
Set to true if echo suppression is enabled; false otherwise.
MicrophoneVO
Public Methods
 MethodDefined By
  
MicrophoneVO(init:Object = null)
Creates a new MicrophoneVO instance.
MicrophoneVO
  
apply(micro:Microphone):void
Apply this value object in the specified Microphone reference.
MicrophoneVO
 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 = MicrophoneVO):void
[static] Preserves the class (type) of an object when the object is encoded in Action Message Format (AMF).
MicrophoneVO
  
toObject():Object
[override] Returns the Object representation of this object.
MicrophoneVO
 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.
MicrophoneVO
Property Detail
loopBackproperty
public var loopBack:Boolean = true

Routes audio captured by a microphone to the local speakers.

rateproperty 
public var rate:Number = 11

The rate at which the microphone captures sound, in kHz.

silenceLevelproperty 
public var silenceLevel:Number

The amount of sound required to activate the microphone and dispatch the activity event.

silenceTimeoutproperty 
public var silenceTimeout:Number

The number of milliseconds between the time the microphone stops detecting sound and the time the activity event is dispatched.

useEchoSuppressionproperty 
public var useEchoSuppression:Boolean

Set to true if echo suppression is enabled; false otherwise.

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

Creates a new MicrophoneVO 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(micro:Microphone):void

Apply this value object in the specified Microphone reference.

Parameters

micro:Microphone

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

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

Parameters

aliasName:String (default = MicrophoneVO)

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.




Mardi Août 16 2011, 02:33 PM +02:00