Class Microphone

Live microphone input. Wraps getUserMedia + a MediaStreamAudioSourceNode and exposes an output node plus a built-in analyser for level metering / visualization. The raw input is not routed to the speakers by default (to avoid feedback); call connect to route it somewhere — a bus input, an effect, or another analyser.

const mic = await audio.requestMicrophone();
mic.connect(audio.bus('voice').input);   // monitor through the voice bus
const level = mic.getLevel();             // 0..1 RMS

Index

Properties

`Readonly`stream

stream: MediaStream

The live media stream.

`Readonly`output

output: AudioNode

Graph node carrying the mic signal; connect this onward.

`Readonly`analyser

analyser: AudioAnalyser

Built-in analyser tapping the mic (already connected).

Accessors

muted

get muted(): boolean
Mutes the capture by disabling the stream's audio tracks.

Returns boolean
- Defined in src/audio/microphone.ts:85
set muted(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/audio/microphone.ts:88

Methods

`Static`request

request(ctx: AudioContext, opts?: MicrophoneOptions): Promise<Microphone>
Request microphone access and build a Microphone. Rejects if the user denies permission or no input device is available.
Parameters
- ctx: AudioContext
- opts: MicrophoneOptions = {}
Returns Promise<Microphone>
- Defined in src/audio/microphone.ts:50

connect

connect(node: AudioNode): void
Route the mic signal into another node (bus input, effect, analyser).
Parameters
- node: AudioNode
Returns void
- Defined in src/audio/microphone.ts:65

disconnect

disconnect(node?: AudioNode): void
Disconnect the mic from a previously-connected node (or all).
Parameters
- Optionalnode: AudioNode
Returns void
- Defined in src/audio/microphone.ts:70

getLevel

getLevel(): number
Current input level in [0, 1] (RMS), via the built-in analyser.

Returns number
- Defined in src/audio/microphone.ts:80

stop

stop(): void
Stop capture, release the device, and tear down nodes.

Returns void
- Defined in src/audio/microphone.ts:96

Class Microphone

Index

Properties

Accessors

Methods

Properties

`Readonly`stream

`Readonly`output

`Readonly`analyser

Accessors

muted

Returns boolean

Parameters

Returns void

Methods

`Static`request

Parameters

Returns Promise<Microphone>

connect

Parameters

Returns void

disconnect

Parameters

Returns void

getLevel

Returns number

stop

Returns void

Settings

On This Page

Class Microphone

Index

Properties

Accessors

Methods

Properties

Readonlystream

Readonlyoutput

Readonlyanalyser

Accessors

muted

Returns boolean

Parameters

Returns void

Methods

Staticrequest

Parameters

Returns Promise<Microphone>

connect

Parameters

Returns void

disconnect

Parameters

Returns void

getLevel

Returns number

stop

Returns void

Settings

On This Page

`Readonly`stream

`Readonly`output

`Readonly`analyser

`Static`request