MicrophoneEnhancedOptions

Package	flash.media
Class	public final class MicrophoneEnhancedOptions
Inheritance	MicrophoneEnhancedOptions Object

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10.3, AIR 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.

Related API Elements

flash.media.Microphone.enhancedOptions
flash.media.Microphone.getEnhancedMicrophone()

Public Properties

	Property		Defined By
		constructor : 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

Public Methods

	Method		Defined By
		MicrophoneEnhancedOptions()	MicrophoneEnhancedOptions
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

echoPath

property

echoPath:int

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10.3, AIR 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.

Implementation
public function get echoPath():int
public function set echoPath(value:int):void

isVoiceDetected

property

isVoiceDetected:int

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10.3, AIR 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.

Implementation
public function get isVoiceDetected():int
public function set isVoiceDetected(value:int):void

mode

property

mode:String

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10.3, AIR 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.

Note: This feature is not available on iOS.

Implementation
public function get mode():String
public function set mode(value:String):void

Related API Elements

flash.media.MicrophoneEnhancedMode

nonLinearProcessing

property

nonLinearProcessing:Boolean

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10.3, AIR 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.

Implementation
public function get nonLinearProcessing():Boolean
public function set nonLinearProcessing(value:Boolean):void

Constructor Detail