メインコンテンツへスキップ
@capgo/capacitor-media-session メディア オープンソース

メディアセッション Capacitor プラグイン

ロック画面や通知センターからメディア再生をコントロールします

インストール

bun add @capgo/capacitor-media-session bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-media-session
  • pnpm add @capgo/capacitor-media-session
  • yarn add @capgo/capacitor-media-session

ガイド

Capacitor で Media Session を使う方法

実機でテストする

Capgo アプリをダウンロードして、QR code をスキャンしてください。

Media Session プラグインのプレビュー用 QR code

@capgo/capacitor-media-session の使い方

デバイスのメディアセッションコントロールを公開する Capacitor プラグイン。

インストール

bun add @capgo/capacitor-media-session
bunx cap sync

bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。

インポート

import { MediaSession } from '@capgo/capacitor-media-session';

API の概要

メソッド 説明
setMetadata 再生中のメディアのメタデータを設定します。
setPlaybackState メディアセッションの再生状態を更新します。
setActionHandler メディアセッションのアクション用ハンドラーを登録します。
setPositionState アクティブなメディアセッションの位置状態を更新します。

例

setMetadata()

再生中のメディアのメタデータを設定します。

import { MediaSession } from '@capgo/capacitor-media-session';

await MediaSession.setMetadata({ album: 'album' });

setPlaybackState()

メディアセッションの再生状態を更新します。

import { MediaSession } from '@capgo/capacitor-media-session';

await MediaSession.setPlaybackState({ playbackState: 'none' });

setActionHandler()

メディアセッションのアクション用ハンドラーを登録します。

import { MediaSession } from '@capgo/capacitor-media-session';

await MediaSession.setActionHandler({ action: 'play' }, (details) => {
  console.log(details);
});

setPositionState()

アクティブなメディアセッションの位置状態を更新します。

import { MediaSession } from '@capgo/capacitor-media-session';

await MediaSession.setPositionState({
  duration: 1000,
  playbackRate: 1,
  position: 10,
});

完全なリファレンス

「@capgo/capacitor-media-session の使い方」から続ける

使用している場合 @capgo/capacitor-media-session の使い方 ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-media-session @capgo/capacitor-media-session の実装の詳細については、 スタートガイド スタートガイドの実装詳細については、 API の概要 「API の概要」の実装の詳細については、 はじめに はじめにの実装詳細、および API キー API Keys の実装詳細については、

よくある質問

Media Session プラグイン FAQ

Capacitor アプリに Media Session プラグインをインストールするにはどうすればよいですか?

「bun add @capgo/capacitor-media-session」(または「npm install @capgo/capacitor-media-session」)を実行し、続けて「bunx cap sync」を実行すると、iOS と Android のプロジェクトにネイティブの code が反映されます。アプリの code で「@capgo/capacitor-media-session」からインポートしてください。

@capgo/capacitor-media-session は React、Vue、Angular で動作しますか?

はい。Media Session は Capacitor パッケージなので、Ionic、React、Vue、Angular、Svelte、素の JavaScript など、Capacitor 上で動くあらゆる Web フレームワークで使えます。

@capgo/capacitor-media-session はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-media-session は無料でオープンソースですか?

はい。code のソースコードは GitHub の https://github.com/Cap-go/capacitor-media-session/ で公開されており、パッケージは npm から無料でインストールできます。バグ報告やプルリクエストも歓迎です。

App Store の審査なしで、Media Session を使っている code をアップデートできますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリ審査を待たずに Media Session の変更をリリース

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める