AudioRecording

The AudioRecording interface represents the result of an audio recording. This result is obtained by calling the stopRecording function. It contains various details about the recording such as the file URI, duration, size, and more.

Interface

export interface AudioRecording {
    fileUri: string
    filename: string
    durationMs: number
    size: number
    mimeType: string
    channels: number
    bitDepth: BitDepth
    sampleRate: SampleRate
    wavPCMData?: ArrayBuffer // Full PCM data for the recording in WAV format (only on web, for native use the fileUri)
    analysisData?: AudioAnalysis // Analysis data for the recording depending on enableProcessing flag
}

Example Usage

import { useAudioRecorder } from '@siteed/expo-audio-stream';

const {
    startRecording,
    stopRecording,
    isRecording,
    durationMs,
    size,
} = useAudioRecorder({ debug: true });

const handleStop = async () => {
    const result: AudioRecording = await stopRecording();
    if (result) {
        console.log('Recording stopped:', result);
        console.log('File URI:', result.fileUri);
        console.log('Duration (ms):', result.durationMs);
        console.log('Size (bytes):', result.size);
        console.log('MIME type:', result.mimeType);
        console.log('Channels:', result.channels);
        console.log('Bit depth:', result.bitDepth);
        console.log('Sample rate:', result.sampleRate);
        if (result.wavPCMData) {
            console.log('WAV PCM Data:', result.wavPCMData);
        }
        if (result.analysisData) {
            console.log('Analysis Data:', result.analysisData);
        }
    } else {
        console.log('No recording result available.');
    }
};