Einstieg

Installieren

bun add @capgo/capacitor-audio-recorder
bunx cap sync

Importieren

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

API Übersicht

startRecording

Mit dem Gerätemikrofon Ton aufnehmen.

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.startRecording();

pauseRecording

Pause the ongoing recording. Only available on Android (API 24+), iOS, and Web.

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.pauseRecording();

resumeRecording

Wiederaufnahme einer vorherigen Pause.

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.resumeRecording();

stopRecording

Beenden Sie die aktuelle Aufnahme und speichern Sie die aufgenommene Audio.

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.stopRecording();

cancelRecording

Stornieren Sie die aktuelle Aufnahme und werfen Sie alle aufgenommenen Audio weg.

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.cancelRecording();

getRecordingStatus

Abrufen Sie den aktuellen Aufnahmestatus.

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.getRecordingStatus();

getCurrentAmplitude

Abrufen Sie die aktuelle Eingabeamplitude (Mikrofonlevel) als normalisiertes Zahl im Bereich. [0, 1] Integriert für das Ansteuern von Echtzeitvisualisierungen wie VU-Meter oder Wellenformen während der Aufzeichnung. Gibt zurück, wenn keine Aufzeichnung aktiv ist. Entworfen für UI-schrittmäßige Abfragen — ein 60–100 ms Intervall ist ein guter Ausgangspunkt für eine Wellenform. Vermeiden Sie es, es in einem engen Schleifen aufzurufen; jeder Aufruf überschreitet den JS/nativen Bridge.

Zwischenablage kopieren 0 Abschnitt mit dem Titel “checkPermissions”

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.getCurrentAmplitude();

checkPermissions

Abschnitt mit dem Titel “requestPermissions”

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.checkPermissions();

requestPermissions

Typenreferenz

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.requestPermissions();

__CAPGO_KEEP_0__

StartRecordingOptions

Optionen, die von . angenommen werden

export interface StartRecordingOptions {
  /**
   * The audio session category options for recording. Only available on iOS.
   *
   * @since 1.0.0
   */
  audioSessionCategoryOptions?: AudioSessionCategoryOption[];

  /**
   * The audio session mode for recording. Only available on iOS.
   *
   * @since 1.0.0
   */
  audioSessionMode?: AudioSessionMode;

  /**
   * The audio bit rate in bytes per second.
   * Only available on Android and iOS.
   *
   * @since 1.0.0
   */
  bitRate?: number;

  /**
   * The audio sample rate in Hz.
   * Only available on Android and iOS.
   *
   * @since 1.0.0
   */
  sampleRate?: number;
}

StopRecordingResult

Resultat, das von . zurückgegeben wird

export interface StopRecordingResult {
  /**
   * The recorded audio as a Blob. Only available on Web.
   *
   * @since 1.0.0
   */
  blob?: Blob;

  /**
   * The duration of the recording in milliseconds.
   *
   * @since 1.0.0
   */
  duration?: number;

  /**
   * The URI pointing to the recorded file. Only available on Android and iOS.
   *
   * @since 1.0.0
   */
  uri?: string;
}

GetRecordingStatusResult

Resultat, das von . zurückgegeben wird

export interface GetRecordingStatusResult {
  /**
   * The current recording status.
   *
   * @since 1.0.0
   */
  status: RecordingStatus;
}

GetCurrentAmplitudeResult

Resultat, das von . zurückgegeben wird

export interface GetCurrentAmplitudeResult {
  /**
   * The current input amplitude normalized to the `[0, 1]` range, where `0`
   * represents silence and `1` represents the maximum level the platform can
   * report. The value is `0` when no recording is active.
   *
   * Note: the source signal differs between platforms — Android reports the
   * peak sample amplitude since the last call, iOS reports the average power
   * in dB converted to linear, and Web reports the RMS of the latest frame.
   * Consumers that need cross-platform parity may want to apply a
   * per-platform scaling curve.
   *
   * @since 8.1.0
   */
  value: number;
}

PermissionStatus

Zurückgegebene Berechtigungsinformationen durch und .

export interface PermissionStatus {
  /**
   * The permission state for audio recording.
   *
   * @since 1.0.0
   */
  recordAudio: PermissionState;
}

RecordingErrorEvent

Ereignis, das ausgelöst wird, wenn während der Aufzeichnung ein Fehler auftritt.

export interface RecordingErrorEvent {
  /**
   * The error message.
   *
   * @since 1.0.0
   */
  message: string;
}

RecordingStoppedEvent

Ereignis, das ausgelöst wird, wenn eine Aufzeichnung abgeschlossen ist.

export type RecordingStoppedEvent = StopRecordingResult;

AudioSessionCategoryOption

Verfügbare Audio-Sitzungskategorioptionen auf iOS.

export enum AudioSessionCategoryOption {
  AllowAirPlay = 'ALLOW_AIR_PLAY',
  AllowBluetooth = 'ALLOW_BLUETOOTH',
  AllowBluetoothA2DP = 'ALLOW_BLUETOOTH_A2DP',
  DefaultToSpeaker = 'DEFAULT_TO_SPEAKER',
  DuckOthers = 'DUCK_OTHERS',
  InterruptSpokenAudioAndMixWithOthers = 'INTERRUPT_SPOKEN_AUDIO_AND_MIX_WITH_OTHERS',
  MixWithOthers = 'MIX_WITH_OTHERS',
  OverrideMutedMicrophoneInterruption = 'OVERRIDE_MUTED_MICROPHONE_INTERRUPTION',
}

AudioSessionMode

Audio-Modi, die auf iOS verfügbar sind.

export enum AudioSessionMode {
  Default = 'DEFAULT',
  GameChat = 'GAME_CHAT',
  Measurement = 'MEASUREMENT',
  SpokenAudio = 'SPOKEN_AUDIO',
  VideoChat = 'VIDEO_CHAT',
  VideoRecording = 'VIDEO_RECORDING',
  VoiceChat = 'VOICE_CHAT',
}

RecordingStatus

Der Aufnahmestatus.

export enum RecordingStatus {
  Inactive = 'INACTIVE',
  Recording = 'RECORDING',
  Paused = 'PAUSED',
}

PermissionState

Plattformzustände der Berechtigung, die von Capacitor unterstützt werden.

export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';

Abschnitt mit dem Titel “Source Of Truth”

Diese Seite wurde aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API sich upstream ändert.