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

IVS Player Capacitor プラグイン

Amazon Interactive Video Service (IVS) を使用して、超低遅延のライブビデオ配信を実現します

インストール

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

ガイド

Capacitor で IVS Player を使う方法

@capgo/capacitor-ivs-player の使用方法

capacitor アプリ向けの IVS Player

インストール

bun add @capgo/capacitor-ivs-player
bunx cap sync

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

インポート

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

API の概要

メソッド 説明
create 現在の動作については、ソースの定義を参照してください。
start 現在の動作については、ソースの定義を参照してください。
cast 現在の動作については、ソースの定義を参照してください。
getCastStatus 現在の動作については、ソースの定義を参照してください。
pause 現在の動作については、ソースの定義を参照してください。
delete 現在の動作については、ソースの定義を参照してください。
getUrl 現在の動作については、ソースの定義を参照してください。
getState 現在の動作については、ソースの定義を参照してください。
setPlayerPosition 現在の動作については、ソースの定義を参照してください。
getPlayerPosition 現在の動作については、ソースの定義を参照してください。
setAutoQuality 現在の動作については、ソースの定義を参照してください。
getAutoQuality 現在の動作については、ソースの定義を参照してください。
setPip 現在の動作については、ソースの定義を参照してください。
getPip 現在の動作については、ソースの定義を参照してください。
setFrame プレイヤービューのフレームを設定します。すべての数値は正の整数である必要があります。
getFrame 現在の動作については、ソースの定義を参照してください。
setBackgroundState 現在の動作については、ソースの定義を参照してください。
getBackgroundState 現在の動作については、ソースの定義を参照してください。
setMute 現在の動作については、ソースの定義を参照してください。
getMute 現在の動作については、ソースの定義を参照してください。
setQuality 現在の動作については、ソースの定義を参照してください。
getQuality 現在の動作については、ソースの定義を参照してください。
getQualities 現在の動作については、ソースの定義を参照してください。

例

create()

現在のコントラクトについては、API のリファレンスを参照してください。

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.create({ url: 'https://example.com' });

start()

現在のコントラクトについては、API のリファレンスを参照してください。

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.start();

cast()

現在のコントラクトについては、API のリファレンスを参照してください。

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.cast();

getCastStatus()

現在のコントラクトについては、API のリファレンスを参照してください。

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

const result = await CapacitorIvsPlayer.getCastStatus();
console.log(result);

pause()

現在のコントラクトについては、API のリファレンスを参照してください。

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.pause();

delete()

現在のコントラクトについては、API のリファレンスを参照してください。

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.delete();

上記の表には、23個のコアメソッドが記載されています。リスナーとバージョンのヘルパー、および各メソッドの完全なコントラクトは、次にドキュメント化されています。 GitHub リポジトリ.

イベントをリッスンする

addListener ハンドルを返します。画面がアンマウントされるときに handle.remove() 画面がアンマウントされるとき、または CapacitorIvsPlayer.removeAllListeners() すべてのリスナーを解除します。

完全なリファレンス

@capgo/capacitor-ivs-player の使用方法へ進む

使用している場合 @capgo/capacitor-ivs-player の使用方法 ネイティブプラグインの作業を計画するには、次と連携してください: @capgo/capacitor-ivs-player @capgo/capacitor-ivs-player の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。

よくある質問

IVS Player プラグインの FAQ

Capacitor アプリに IVS Player プラグインをインストールするには?

"bun add @capgo/capacitor-ivs-player" (または "npm install @capgo/capacitor-ivs-player") を実行した後、"bunx cap sync" を実行して、iOS および Android プロジェクトにネイティブの code を反映させてください。アプリの code から "@capgo/capacitor-ivs-player" をインポートします。

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

はい。IVS Player は Capacitor パッケージであるため、Ionic、React、Vue、Angular、Svelte、およびプレーンな JavaScript を含む、Capacitor 内で動作するあらゆる Web フレームワークで使用可能です。

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

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

@capgo/capacitor-ivs-player は無料のオープンソースですか?

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

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

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

アプリの審査を待たずに IVS Player の変更をリリース

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

Capgo から始める