Microphone.setGain

Client-Side Communication ActionScript > Microphone.setGain

Microphone.setGain

Availability

Flash Player 6.

Flash Communication Server MX (not required).

Usage

activeMicrophone.setGain(gain)

Parameters

gain An integer that specifies the amount by which the microphone should boost the signal. Valid values are 0 to 100. The default value is 50; however, the user may change this value in the Flash Player Microphone Settings panel.

Returns

Nothing.

Description

Method; sets the microphone gain—that is, the amount by which the microphone should multiply the signal before transmitting it. A value of 0 tells Flash to multiply by 0; that is, the microphone transmits no sound.

You can think of this setting like a volume knob on a stereo: 0 is no volume and 50 is normal volume; numbers below 50 specify lower than normal volume, while numbers above 50 specify higher than normal volume.

Example

The following example ensures that the microphone gain setting is less than or equal to 55.

var myMic = Microphone.get();
if (myMic.gain > 55){
	myMic.setGain(55);
}

	Flash Player 6.
	Flash Communication Server MX (not required).