microphone module

Package:

@dragon-speech-sdk/types

APIs for microphones.

Type Aliases

ChangeType	preferredMicConnectedNotRecording - While not recording, the preferred mic is plugged in. The preferred mic is used when recording starts. preferredMicConnectedWhileRecording - While recording, the preferred mic is plugged in. Recording will stop if they choose to switch. preferredMicChangedWhileRecording - While recording, the preferred mic is changed. Recording will stop. The new preferred mic is used when recording starts. currentMicDisconnectedNotRecording - While not recording, the current mic is unplugged. The preferred mic or default mic is used when recording starts. currentMicDisconnectedWhileRecording - While recording, the current mic is unplugged. Recording will stop. The preferred mic or default mic is used when recording starts.
Microphone	Info on an available microphone.
MicrophoneEvents	Microphone events.
MicrophoneListChangedDetail	Info on microphones that are currently connected.
PreferredMicrophone	Info about the user's preferred microphone.

Functions

setPreferredMicrophone(null | PreferredMicrophone)

Sets the preferred microphone for recording. If the preferred microphone isn't available, or the current mic becomes unavailable, the SDK will automatically switch based on the following priority: Preferred microphone > system default microphone > first available microphone.

Variables

events

The listener only EventTarget for microphone events.

Function Details

setPreferredMicrophone(null | PreferredMicrophone)

Sets the preferred microphone for recording. If the preferred microphone isn't available, or the current mic becomes unavailable, the SDK will automatically switch based on the following priority: Preferred microphone > system default microphone > first available microphone.

function setPreferredMicrophone(preferredMicrophone: null | PreferredMicrophone): Promise<void>

Parameters

preferredMicrophone

null | PreferredMicrophone

The preferred microphone to set.

Returns

Promise<void>

Variable Details

events

The listener only EventTarget for microphone events.

events: DragonEventTarget<MicrophoneEvents>

Type

DragonEventTarget<MicrophoneEvents>