使用する @capgo/capacitor-audio-recorder プラットフォームごとに個別のネイティブモジュールを追加することなく、Capacitor アプリでマイク録音を実現したい場合に最適です。録音の開始・停止、一時停止、波形表示用の入力レベル取得、さらに(適切なネイティブ権限があれば)アプリがフォアグラウンドとバックグラウンドを行き来している間の録音エラーの監視が可能です。
主なユースケース:ボイスメモ、アプリ内音声メッセージ、フィールドノート、簡易的なポッドキャスト録音、モバイルWebViewやモバイルブラウザで動作させる必要がある音声中心の機能など。
プラットフォーム対応
「プラットフォーム対応」という見出しのセクション| プラットフォーム | サポート | 備考 |
|---|---|---|
| iOSと | はい | AVFoundation によるキャプチャ(オプション) resetToPlaybackOnStop 録音後の無音再生を防ぐため |
| Android | はい | MediaRecorder、API 24+ で一時停止または再開 |
| Web | はい | ブラウザ MediaRecorder, stopRecording を返します Blob ファイルURIの代わりに |
コア機能
「コア機能」セクションstartRecording- デバイスのマイクを使用して音声録音を開始します。pauseRecording- 進行中の録音を一時停止します。Android (API 24+)、iOS、Web でのみ利用可能です。resumeRecording- 一時停止していた録音を再開します。stopRecording- 現在の録音を停止し、録音したオーディオを保存します。
公開 API
「Public API」セクション| メソッド | 説明 |
|---|---|
startRecording | デバイスのマイクを使用して録音を開始します。 |
pauseRecording | 進行中の録音を一時停止します。Android(API 24+)、iOS、Web でのみ利用できます。 |
resumeRecording | 一時停止していた録音を再開します。 |
stopRecording | 現在の録音を停止し、録音したオーディオを保存します。 |
cancelRecording | 現在の録音をキャンセルし、キャプチャしたオーディオを破棄します。 |
getRecordingStatus | 現在の録音ステータスを取得します。 |
getCurrentAmplitude | 現在の入力振幅(マイクレベル)を正規化された数値として取得します。 [0, 1] 範囲。 |
checkPermissions | マイクへのアクセス権限の現在の状態を返します。 |
requestPermissions | マイクへのアクセス権限をリクエストします。 |
addListener | 録音エラーをリッスンします。 |
addListener | 録音の一時停止時に発行される pause イベントをリッスンします。 |
addListener | 録音完了イベントをリッスンします。 |
removeAllListeners | 登録されているすべてのリスナーを削除します。 |
getPluginVersion | ネイティブの Capacitor プラグインのバージョンを取得します。 |
Source of Truth
「Source Of Truth」セクションこのリファレンスは以下から同期されています: src/definitions.ts における capacitor-audio-recorder.
@capgo/capacitor-audio-recorderの続き
「@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 を使用する際のネイティブ機能については、 @capgo/capacitor-video-player @capgo/capacitor-video-player. の実装の詳細については