Adobe® AIR® API Reference for HTML Developers
Home  |  Show Classes List |  Index  |  Appendixes

Language Reference only       
MicrophoneEnhancedOptions 
window.runtime propertywindow.runtime.flash.media.MicrophoneEnhancedOptions
InheritanceMicrophoneEnhancedOptions Inheritance Object

Runtime Versions:  2.7

The MicrophoneEnhancedOptions class provides configuration options for enhanced audio (acoustic echo cancellation). Acoustic echo cancellation allows multiple parties to communicate in an audio/video chat application without using headsets.

To use acoustic echo cancellation, call Microphone.getEnhancedMicrophone() to get a reference to an enhanced Microphone object. Set the Microphone.enhancedOptions property to an instance of the MicrophoneEnhancedOptions class.

See also



Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  echoPath : int
Specifies the echo path (in milliseconds) used for acoustic echo cancellation.
MicrophoneEnhancedOptions
  isVoiceDetected : int
Indicates whether the Microphone input detected a voice.
MicrophoneEnhancedOptions
  mode : String
Controls enhanced microphone mode.
MicrophoneEnhancedOptions
  nonLinearProcessing : Boolean
Enable non-linear processing.
MicrophoneEnhancedOptions
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined By
  
MicrophoneEnhancedOptions
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail

echoPath

property
echoPath:int

Runtime Versions:  2.7

Specifies the echo path (in milliseconds) used for acoustic echo cancellation. A longer echo path results in better echo cancellation. A longer echo path also causes a longer delay and requires more computational complexity. The default value is 128 (recommended). The other possible value is 256.

isVoiceDetected

property 
isVoiceDetected:int

Runtime Versions:  2.7

Indicates whether the Microphone input detected a voice.

Possible values are: -1, not enabled; 0, a voice is not detected; 1, a voice is detected.

mode

property 
mode:String

Runtime Versions:  2.7

Controls enhanced microphone mode. The default value is FULL_DUPLEX for all microphones that aren't USB. The default value for USB microphones is HALF_DUPLEX. See MicrophoneEnhancedMode for possible values and descriptions.

See also

nonLinearProcessing

property 
nonLinearProcessing:Boolean

Runtime Versions:  2.7

Enable non-linear processing. Non-linear processing suppresses the residual echo when one person is talking. The time-domain non-linear processing technique is used. Turn off non-linear processing for music sources. The default value is true which turns on non-linear processing.

Constructor Detail

MicrophoneEnhancedOptions

()Constructor
public function MicrophoneEnhancedOptions()