Microphone class

The Microphone class lets you capture audio from a microphone attached to the computer that is running Flash Player.

When used with Flash Media Server, you can transmit, play, and on Flash Media Interactive Server and Flash Media Development Server, optionally record the audio being captured. With these capabilities, you can develop media applications such as instant messaging with audio or applications to record presentations so that others can replay them later, and so on. Flash Player provides similar video capabilities; for more information, see the Camera class entry.

You can also use a Microphone object without a server--for example, to transmit sound from your microphone through the speakers on your local system.

To create or reference a Microphone object, use the Microphone.get() method.

Note: Flash Player displays a Privacy dialog box in which the user can choose whether to allow or deny access to the microphone. Make sure that your Stage size is at least 215 by 138 pixels; this is the minimum size that Flash Player requires to display the dialog box.

Availability

Flash Media Server (not required); Flash Player 6.

Method summary

Method	Description
`Microphone.get()`	Returns a reference to a microphone for capturing audio.
`Microphone.setGain()`	Specifies the amount by which the microphone should boost the signal before transmitting it.
`Microphone.setRate()`	Specifies the rate at which the microphone should capture sound, in kHz.
`Microphone.setSilenceLevel()`	Sets the minimum input level that should be considered sound and (optionally) the amount of silent time signifying that silence has actually begun.
`Microphone.setUseEchoSuppression()`	Specifies whether to use the echo suppression feature of the audio codec.

Property summary

Property (read-only)	Description
`Microphone.activityLevel`	The amount of sound the microphone is detecting.
`Microphone.gain`	The amount by which the microphone boosts the signal before transmitting it.
`Microphone.index`	A zero-based integer that specifies the index of the microphone, as reflected in the array returned by `Microphone.names`.
`Microphone.muted`	A Boolean value that specifies whether the user has allowed or denied access to the microphone.
`Microphone.name`	The name of the current sound capture device, as returned by the sound capture hardware.
`Microphone.names`	Class property: an array of strings reflecting the names of all available sound capture devices, including sound capture cards and microphones.
`Microphone.rate`	The sound capture rate, in kHz.
`Microphone.silenceLevel`	The amount of sound required to activate the microphone.
`Microphone.silenceTimeout`	The number of milliseconds between the time the microphone stops detecting sound and the time `Microphone.onActivity()(false)` is called.
`Microphone.useEchoSuppression`	A Boolean value that specifies whether echo suppression is being used.

Event handler summary

Event	Description
`Microphone.onActivity()`	Invoked when the microphone starts or stops detecting sound.
`Microphone.onStatus()`	Invoked when the user allows or denies access to the microphone.

Flash Media Server Developer Documentation

Microphone class