Microphone class

Properties

Specifies a microphone on the client machine.

The DeviceManager object dispatches a devicesDetected event. This event object (defined by the DeviceStatusEvent class) includes a microphones property that is an array of Microphone objects. It also includes a selectedMicrophone object, which is a Microphone object.

The DevicePanel object dispatches a devicesSelected event (defined by the DeviceEvent class), which includes a microphone property, which is a Microphone object.

The Publisher object dispatches deviceInactive and invalidDeviceName events (defined by the DeviceEvent class), which each include a microphone property, which is a Microphone object.

For a code example that uses the Microphone object, see DeviceManager Example.

Microphone properties

A Microphone object has the following properties:

name (String) — The name identifying the microphone.

status (String) — The status of the the microphone: either "active", "inactive", "invalid" or "unknown". If the value is "unknown", the user has not granted permission to use the microphone (in the Flash Player Settings dialog box). The value is set to "invalid" for a Microphone object that is the microphone property of the invalidDeviceName event.

Note: Microphone properties should only be used as read-only entities. The results of using JavaScript to directly change the values of Microphone properties will be unpredictable.