Interface Microphone

A microphone whose audio can be recorded.

interface Microphone {
    id: string;
    name: string;
    model_id: string;
    manufacturer: string;
    availability: "available" | "notConnected" | "lidClosed" | "unknownSuspended";
}

Properties

id: string

An identifier that uniquely identifies the microphone.

name: string

A localized microphone name for display in the user interface.

model_id: string

The model ID of this microphone.

manufacturer: string

The manufacturer of this microphone.

availability: "available" | "notConnected" | "lidClosed" | "unknownSuspended"

The current availability state of this microphone.

  • available: Microphone can be recorded
  • lidClosed: Microphone cannot be recorded because the MacBook lid is closed (recovery: "Open MacBook lid")
  • unknownSuspended: Microphone cannot be recorded because it is suspended for some unknown reason (recovery: "Unsuspend microphone")
  • notConnected: Microphone cannot be recorded because it is currently not connected (recovery: "Connect microphone")

Generated using TypeDoc