Skip to content

Microphone ​

Microphone audio streaming Access via scene.microphone

Example:

javascript
scene.microphone.configure({ sampleRate: 24000, silenceThreshold: 0.01 });
scene.microphone.onData = function(base64) {
    // Send to speech API
};
scene.microphone.start();

Properties ​

isStreaming ​

  • Type: boolean
  • Whether the microphone is currently streaming

onData ​

  • Type: any
  • Callback for audio data chunks (base64-encoded PCM16)

onError ​

  • Type: any
  • Callback for errors (permission denied, etc.)

Methods ​

configure() ​

javascript
configure(options: Array<any>): void

Configure microphone settings

  • sampleRate: Output sample rate (default: 24000) - silenceThreshold: RMS threshold to skip quiet audio, 0 to disable (default: 0) - highpassFrequency: Highpass filter cutoff in Hz, 0 to disable (default: 0)

Parameters:

  • options (Array<any>) - Configuration object

Returns: void

start() ​

javascript
start(): void

Start capturing audio

Returns: void

stop() ​

javascript
stop(): void

Stop capturing audio

Returns: void