TBMicrophone class

Properties

Extends: Object

Package: com.tokbox.model

Specifies a microphone on the client machine.

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

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

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

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

TBMicrophone properties

The TBMicrophone class 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 TBMicrophone object that is the microphone property of the invalidDeviceName event.

These properties are read-only.