@capgo/capacitor-audio-recorder の使い方
音声を録音するための Capacitor プラグイン。
インストール
bun add @capgo/capacitor-audio-recorder
bunx cap sync
bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。
インポート
import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';
API の概要
| メソッド | 説明 |
|---|---|
startRecording |
デバイスのマイクを使用して録音を開始します。 |
pauseRecording |
進行中の録音を一時停止します。Android(API 24+)、iOS、Web でのみ利用できます。 |
resumeRecording |
一時停止していた録音を再開します。 |
stopRecording |
現在の録音を停止し、録音したオーディオを保存します。 |
cancelRecording |
現在の録音をキャンセルし、キャプチャしたオーディオを破棄します。 |
getRecordingStatus |
現在の録音ステータスを取得します。 |
getCurrentAmplitude |
現在の入力振幅(マイクレベル)を正規化された数値として取得します。 [0, 1] 範囲。 |
checkPermissions |
マイクへのアクセス権限の現在の状態を返します。 |
requestPermissions |
マイクへのアクセス権限をリクエストします。 |
例
startRecording()
デバイスのマイクを使用して録音を開始します。
import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';
await CapacitorAudioRecorder.startRecording();
pauseRecording()
進行中の録音を一時停止します。Android(API 24+)、iOS、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';
const result = await CapacitorAudioRecorder.stopRecording();
console.log(result);
cancelRecording()
現在の録音をキャンセルし、キャプチャしたオーディオを破棄します。
import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';
await CapacitorAudioRecorder.cancelRecording();
getRecordingStatus()
現在の録音ステータスを取得します。
import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';
const result = await CapacitorAudioRecorder.getRecordingStatus();
console.log(result);
上記の表には9つのコアメソッドが記載されています。リスナーやバージョンのヘルパー、および各メソッドの詳細な仕様については、 GitHub リポジトリ.
イベントをリッスンする
addListener ハンドルを返します。画面がアンマウントされるときに handle.remove() 画面がアンマウントされるとき、または CapacitorAudioRecorder.removeAllListeners() すべてのリスナーを解除します。
完全なリファレンス
@capgo/capacitor-audio-recorder の使用方法へ進む
使用している場合 @capgo/capacitor-audio-recorder の使い方 ネイティブメディアとインターフェースの挙動を計画するには、次と連携させてください @capgo/capacitor-audio-recorder @capgo/capacitor-audio-recorder の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 @capgo/capacitor-live-activities の使用 @capgo/capacitor-live-activities の使用におけるネイティブ機能については、 @capgo/capacitor-live-activities @capgo/capacitor-live-activities の実装の詳細については、 @capgo/capacitor-video-playerの使用方法 「@capgo/capacitor-video-player. の使い方」のネイティブ機能については