メインコンテンツへスキップ

@capgo/capacitor-asset-cache

CDN の画像や動画をアプリの永続ストレージにキャッシュし、ローカルメディアソースとしてバインドします

ローカルのみの表示ソース

src, resolveや bind ローカルファイルが存在してから初めてソースを返します。img や video タグはローカルの webview URL を受け取ります。

永続的なネイティブストレージ

キャッシュされたアセットは、システムが容量不足時に削除する可能性のあるプラットフォームのキャッシュフォルダではなく、アプリ専用の永続ストレージに保存されます。

保護された CDN のサポート

Web 要素は引き続きローカルファイルのみを読み込みますが、署名付きまたは認証済みアセット用のヘッダーをネイティブ fetch に渡せます。

フレームワークフレンドリーなバインディング

ネイティブキャッシュの解決を、プレーンな HTML、React refs、Vue refs、img や video の src を設定できる任意のフレームワークにバインドできます。

CDN の画像や動画をアプリの永続ストレージにキャッシュし、ローカルメディアソースとしてバインドします

まずは cancel() および以下に示すその他のコアメソッド。

プラットフォームサポート備考
iOSとはいネイティブ
Androidでははいネイティブ
WebいいえCapacitor.getPlatform() でガード

アプリが、通常のストレージ不足でも保持したい重いリモートメディアを表示する場合は、Asset Cache を使用してください:

  • CDNから配信されるオンボーディングやマーケティング用の動画
  • セッションをまたいで再利用されるヒーロー画像、ギャラリー、または画像シーケンス
  • リクエストヘッダーを必要とする保護されたメディア
  • 以前に取得したローカルアセットで足りる、オフライン耐性のある画面
  • Capacitor アプリで <img> と <video> 保護されたURLを直接フェッチしないでください
  • configure(options) デフォルトのCDNと再検証の挙動を設定します。
  • bind(element, path, options?) ローカルファイルの準備ができたら、画像やビデオ要素を更新します。
  • src(path, options?) フレームワークの状態管理用に、ローカルのソース文字列を返します。
  • resolve(path, options?) ローカルのソースとキャッシュのメタデータを返します。
  • get(options) リモートURLを、永続的なネイティブファイルのメタデータに解決します。
  • remove(options) キーまたはURLを指定して、キャッシュされたアセットを1つ削除します。
  • clear() プラグインが管理するすべてのキャッシュ済みアセットを削除します。
  • list() ディスク上にまだ存在するキャッシュ済みアセットを返します。
  • getCacheSize() キャッシュされた総バイト数を返します。
  • getPluginVersion() ネイティブ実装のバージョンマーカーを返します。

キャッシュは、アセットごとに異なる方法で、またはデフォルト設定によってチェックできます:

戦略動作
neverローカルファイルが存在する場合、それを使用します。
ttl以降再ダウンロード maxAgeSeconds.
alwaysすべての呼び出しで再検証し、既知のバリデータを送信します。
etag既知の HTTP ETag バリデータが存在する場合、それを使用します。
last-modified存在する場合は、既知の HTTP Last-Modified バリデーターを使用します。

iOS では、ファイルは Application Support に保存され、キャッシュのルートは iCloud バックアップから除外されます。Android では、ファイルはアプリの内部ファイルディレクトリに保存されます。

キャッシュはアプリのサンドボックス内に隠蔽されており、公開ユーザーメディアとして表示されません。アプリのアンインストール、ユーザーによるアプリデータのクリア、またはアプリが呼び出す場合 clear() または remove().

@capgo/capacitor-asset-cache から続ける

セクション「@capgo/capacitor-asset-cache から続ける」

使用している場合 @capgo/capacitor-asset-cache 永続的なメディア読み込みを計画するには、これを接続します スタートガイド 実装の詳細については、 @capgo/capacitor-downloader 明示的なバックグラウンドダウンロードには、 @capgo/capacitor-file 一般的なローカルファイルアクセスには、 @capgo/capacitor-asset-cache の使い方 チュートリアルには。