Skip to main content

API Introduction

This section provides detailed information about the various types, interfaces, and functions provided by the @siteed/expo-audio-studio library.

Overview​

The API is divided into the following main categories:

Recording and Playback​

  • RecordingConfig: Configuration options for recording audio.
  • useAudioRecorder: Hook for recording audio with configurable quality settings.
  • AudioRecorderProvider: Context provider for sharing recording state across components.
  • useSharedAudioRecorder: Hook to access shared recording state from any component.

Events​

Recording Results​

Audio Analysis​

  • Audio Analysis Overview: Overview of audio analysis capabilities.
  • AudioAnalysis: Detailed analysis of recorded audio.
  • extractAudioAnalysis: Extract comprehensive audio features for detailed analysis.
  • extractPreview: Generate lightweight waveform data for visualization.
  • extractAudioData: Extract raw PCM data for custom processing.
  • extractRawWavAnalysis: Analyze WAV files without decoding, preserving original PCM values.

Specialized Audio Processing​

  • extractMelSpectrogram: Generate mel spectrogram for audio visualization or ML models.
  • trimAudio: Trim audio files with precision, supporting multiple segments and formats.

Utility Functions​

  • convertPCMToFloat32: Convert PCM data to Float32Array for processing.
  • getWavFileInfo: Extract metadata from WAV files.
  • writeWavHeader: Create WAV headers for raw PCM data.

Click on the links above to navigate to detailed documentation for each component and type. For practical examples, see the Audio Analysis Example.

UI Components​

For ready-to-use UI components, check out the @siteed/expo-audio-ui package, which provides waveform visualizers, recording controls, and more.