@corti/dictation-web
Version:
Web component for Corti Dictation
27 lines (26 loc) • 1.06 kB
TypeScript
/**
* Requests access to the microphone.
*
* This function checks if the microphone permission is in "prompt" state, then requests
* access and stops any active tracks immediately.
*
* @returns A promise that resolves when the permission request is complete.
* @throws Error if microphone access is denied or unavailable.
*/
export declare function requestMicAccess(): Promise<void>;
/**
* Retrieves available audio input devices.
*
* This function uses the mediaDevices API to enumerate devices and filters out those
* which are audio inputs. In some browsers, you may need to request user media before
* device labels are populated.
*
* @returns A promise that resolves with an object containing:
* - `devices`: an array of MediaDeviceInfo objects for audio inputs.
* - `defaultDevice`: the first audio input device, if available.
* @throws Error if mediaDevices API is unavailable or device enumeration fails.
*/
export declare function getAudioDevices(): Promise<{
devices: MediaDeviceInfo[];
defaultDevice?: MediaDeviceInfo;
}>;