Getting Started

복사할 수 있는 설치 단계와 이 플러그인의 전체 마크다운 가이드를 포함한 설정 프롬프트

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-audio-recorder`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/audio-recorder/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

설치

Capgo의 AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. AI 도구에 Capgo 기능을 추가하려면 다음 명령어를 사용하세요:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

다음 명령어를 사용하세요:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-audio-recorder` plugin in my project.

만약 Manual Setup을 선호한다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래의 플랫폼별 지침을 따르세요:

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

Import

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

API 개요

`startRecording`

__CAPGO_KEEP_1__

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`

녹음이 중단된 경우 다시 시작합니다.

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

await CapacitorAudioRecorder.resumeRecording();

`stopRecording`

현재 녹음 중인 녹음을 중지하고 녹음된 오디오를 저장합니다.

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

await CapacitorAudioRecorder.stopRecording();

`cancelRecording`

현재 녹음 중인 녹음을 취소하고 캡처한 오디오를 폐기합니다.

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

await CapacitorAudioRecorder.cancelRecording();

`getRecordingStatus`

현재 녹음 상태를 조회합니다.

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

await CapacitorAudioRecorder.getRecordingStatus();

`getCurrentAmplitude`

현재 입력 강도 (마이크 수준)를 정규화된 숫자로 반환합니다. [0, 1] 범위.

녹음 중인 경우를 제외하고 항상 반환됩니다. UI-속도 폴링을 위해 설계되었습니다. - 60-100 ms 간격이 좋은 시작점입니다. wave form. tight loop에서 호출하지 마십시오; 각 호출은 JS/자연어橋梁을 건너갑니다. 0 클립보드 복사

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

await CapacitorAudioRecorder.getCurrentAmplitude();

`checkPermissions`

권한 요청

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

await CapacitorAudioRecorder.checkPermissions();

`requestPermissions`

권한

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

await CapacitorAudioRecorder.requestPermissions();

UI-속도 폴링

`StartRecordingOptions`

accept() 메서드에 의해 받은 옵션

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`

stopRecording() 메서드에 의해 반환된 결과

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`

getRecordingStatus() 메서드에 의해 반환된 결과

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

`GetCurrentAmplitudeResult`

getCurrentAmplitude() 메서드에 의해 반환된 결과

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`

권한 정보는 및 에 의해 반환됩니다.

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

`RecordingErrorEvent`

녹음 중 오류가 발생할 때 발생하는 이벤트입니다.

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

`RecordingStoppedEvent`

복사

export type RecordingStoppedEvent = StopRecordingResult;

`AudioSessionCategoryOption`

복사

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`

iOS에서 사용 가능한 오디오 세션 모드입니다.

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

`RecordingStatus`

녹음 상태입니다.

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

`PermissionState`

Capacitor에서 지원하는 플랫폼 권한 상태입니다.

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

실질적인 출처

이 페이지는 플러그인의 src/definitions.ts. 업스트림에서 API이 변경되면 다시 싱크를 실행하세요.

Getting Started에서 계속하기

Getting Started를 사용하여 Getting Started 자연적인 미디어 및 인터페이스 동작을 계획하려면 Getting Started를 Using @capgo/capacitor-audio-recorder Using @capgo/capacitor-audio-recorder Using @capgo/capacitor-live-activities Using @capgo/capacitor-live-activities @capgo/capacitor-live-activities 구현 세부 사항에 대한 @capgo/capacitor-live-activities 사용 @capgo/capacitor-video-player 구현 세부 사항에 대한 @capgo/capacitor-video-player @capgo/capacitor-video-player for the implementation detail in @capgo/capacitor-video-player.