Microphone class

Availability

Flash Player 6.

Description

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

The Microphone class is primarily for use with Flash Communication Server but can be used in a limited fashion without the server--for example, to transmit sound from your microphone through the speakers on your local system.

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

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

Method summary for the Microphone class

Method Description
Microphone.get()

Returns a default or specified Microphone object, or null if the microphone is not available.

Microphone.setGain()

Specifies the amount by which the microphone should boost the signal.

Microphone.setRate()

Specifies the rate at which the microphone should capture sound, in kHz.

Microphone.setSilenceLevel()

Specifies the amount of sound required to activate the microphone.

Microphone.setUseEchoSuppression()

Specifies whether to use the echo suppression feature of the audio codec.

Property summary for the Microphone class

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

The index of the current microphone.

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 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 Microphone.onActivity(false) is called.

Microphone.useEchoSuppression

A Boolean value that specifies whether echo suppression is being used.

Event handler summary for the Microphone class

Event handler 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.

Constructor for the Microphone class

See Microphone.get().


 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flash/mx2004/main_7_2/00001456.html