使用する @capgo/capacitor-native-audio 複数のネイティブオーディオAPIを使い分けることなく、Capacitor アプリでUIサウンド、短いクリップ、または音楽再生のようなレスポンシブな再生を実現したい場合に最適です。アセットのプリロード、トラックのループ、フェード、リモートURLやHLSのストリーミング、さらにオプションでロック画面の再生コントロール表示も可能です。
主な用途:ゲームのSE、通知音、ガイド付きメディテーション、ポッドキャストプレイヤー、およびデバイスのオーディオセッション内で他のアプリと共存する必要があるあらゆるフロー。
プラットフォーム対応
「プラットフォーム対応」という見出しのセクション| プラットフォーム | サポート | 備考 |
|---|---|---|
| iOSと | はい | AVFoundation、オプションのNow Playingおよびオーディオセッションカテゴリ |
| Android | はい | メディア再生、通知、バックグラウンド用のフォアグラウンドサービス(任意) |
| Web | 一部 | コア再生機能。一部のリスナーイベントはWebでは発行されません |
コア機能
「コア機能」セクションconfigure- オーディオプレイヤーの設定preload- オーディオファイルのロードplayOnce- オーディオファイルを一度だけ再生(自動クリーンアップ付き)isPreloaded- オーディオファイルがプリロード済みか確認
公開 API
「Public API」セクション| メソッド | 説明 |
|---|---|
configure | オーディオプレーヤーの設定 |
preload | オーディオファイルのロード |
playOnce | 自動クリーンアップ付きの単発再生 |
isPreloaded | プリロード済みかどうかの確認 |
play | オーディオファイルの再生 |
pause | オーディオファイルのポーズ |
resume | オーディオファイルの再開 |
loop | オーディオファイルの停止 |
stop | オーディオファイルの停止 |
unload | オーディオファイルのアンロード |
setVolume | オーディオファイルの音量を設定します。 |
setRate | オーディオファイルの再生速度を設定します。 |
setCurrentTime | オーディオファイルの再生位置を設定します。 |
getCurrentTime | オーディオファイルの現在の再生位置を取得します。 |
getDuration | オーディオファイルの再生時間を秒単位で取得します。 |
isPlaying | オーディオファイルが再生中かどうかを確認します。 |
addListener | 再生完了イベントをリスンします。 |
addListener | 再生位置の更新をリスンします。再生中は100msごとに発行されます。 |
addListener | 再生状態の変化をリスンします(通知やロック画面のコントロールを含む)。AndroidとiOSで利用可能です。現在のWeb実装ではこのイベントは発行されません。 |
clearCache | リモートオーディオファイルのキャッシュをクリアします。 |
setDebugMode | デバッグモードのログ設定を行います。 |
getPluginVersion | ネイティブの Capacitor プラグインのバージョンを取得します。 |
deinitPlugin | プラグインを終了し、元のオーディオセッション設定を復元します。このメソッドは再生中のすべてのオーディオを停止し、プラグインによって行われたオーディオセッションの変更を元に戻します。他のオーディオプラグインとの互換性を確保する必要がある場合に使用してください。 |
Source of Truth
「Source Of Truth」セクションこのリファレンスは以下から同期されています: src/definitions.ts における capacitor-native-audio.
@capgo/capacitor-native-audio から先に進む
「@capgo/capacitor-native-audio から先に進む」セクション使用している場合 @capgo/capacitor-native-audio ネイティブメディアとインターフェースの挙動を計画するには、次と連携させてください @capgo/capacitor-native-audio の使用方法 @capgo/capacitor-native-audio を使用してネイティブ機能を利用する場合、 @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. の実装の詳細については