@capgo/capacitor-youtube-player

概要

プレーヤー API の完全な制御とイベントハンドリングを備えた YouTube 動画の埋め込み

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

プラットフォーム対応

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

コア機能

• initialize - 新しいYouTubeプレイヤーインスタンスを初期化します。
• destroy - プレイヤーインスタンスを破棄し、リソースを解放します。
• stopVideo - 動画の再生を停止し、読み込みをキャンセルします。多用は避けてください。通常は pauseVideo() が推奨されます。
• playVideo - 現在キューに入っている、または読み込み済みの動画を再生します。最終的なプレイヤー状態は PLAYING (1) になります。

公開 API

メソッド	説明
initialize	新しい YouTube プレイヤーインスタンスを初期化します。
destroy	プレイヤーインスタンスを破棄してリソースを解放します。
stopVideo	動画の再生を停止し、読み込みをキャンセルします。頻繁に使用せず、通常は pauseVideo() の使用を推奨します。
playVideo	キューに登録または読み込まれた動画を再生します。最終的なプレイヤー状態は PLAYING (1) になります。
pauseVideo	再生中の動画を一時停止します。既に ENDED (0) になっていない限り、最終的なプレイヤー状態は PAUSED (2) になります。
seekTo	動画内の特定の時間にシークします。プレイヤーが一時停止中ならそのままで、再生中なら再生を続けます。
loadVideoById	YouTube ID を指定して動画をロードして再生します。
cueVideoById	IDを指定して動画をキューイング（再生準備）します。サムネイルを読み込み、プレイヤーを準備しますが、playVideo() が呼び出されるまで動画はリクエストされません。
loadVideoByUrl	完全なURLを指定して動画を読み込み、再生します。
cueVideoByUrl	URLを指定して動画をキューイング（再生準備）します。
cuePlaylist	プレイリストをキューイング（再生準備）します。プレイリストを読み込み、最初の動画を準備します。
loadPlaylist	プレイリストを読み込み、再生します。
nextVideo	プレイリストの次の動画を再生します。
previousVideo	プレイリストの前の動画を再生します。
playVideoAt	インデックスを指定して、プレイリスト内の特定の動画を再生します。
mute	プレイヤーの音声をミュートします。
unMute	プレイヤーのミュートを解除します。
isMuted	プレイヤーが現在ミュートされているか確認します。
setVolume	プレイヤーの音量レベルを設定します。
getVolume	現在のプレイヤーの音量レベルを取得します。ミュート中でも音量を返します。
setSize	プレイヤーのサイズをピクセル単位で設定します。
getPlaybackRate	現在の再生速度を取得します。
setPlaybackRate	再生速度を設定します。
getAvailablePlaybackRates	現在の動画で利用可能な再生速度のリストを取得します。
setLoop	プレイリストのループ再生を有効または無効にします。有効にすると、最後の動画の後にプレイリストの先頭から再生が再開されます。
setShuffle	プレイリストのシャッフルを有効または無効にします。
getVideoLoadedFraction	バッファリングされた動画の割合を取得します。非推奨の getVideoBytesLoaded/getVideoBytesTotal よりも信頼性が高いです。
getPlayerState	プレイヤーの現在の状態を取得します。
getAllPlayersEventsState	すべてのアクティブなプレイヤーのイベント状態を取得します。複数のプレイヤーインスタンスを追跡する場合に便利です。
getCurrentTime	現在の再生位置を秒単位で取得します。
toggleFullScreen	全画面モードをオンまたはオフに切り替えます。
getPlaybackQuality	現在の再生品質を取得します。
setPlaybackQuality	推奨される再生品質を設定します。実際の品質はネットワーク状況によって異なる場合があります。
getAvailableQualityLevels	現在の動画で利用可能な品質レベルのリストを取得します。
getDuration	現在の動画の再生時間を秒単位で取得します。
getVideoUrl	現在の動画の YouTube.com URL を取得します。
getVideoEmbedCode	現在の動画の埋め込み code を取得します。HTML の iframe 埋め込み code を返します。
getPlaylist	現在のプレイリストに含まれる動画 ID の配列を取得します。
getPlaylistIndex	プレイリスト内で現在再生中の動画のインデックスを取得します。
getIframe	プレイヤーの iframe DOM 要素を取得します。Web プラットフォームのみ。
addEventListener	プレイヤーにイベントリスナーを追加します。Web プラットフォームのみ。
removeEventListener	プレイヤーからイベントリスナーを削除します。Web プラットフォームのみ。
getPluginVersion	プラグインのバージョン番号を取得します。プラットフォーム固有のバージョン情報を返します。

Source of Truth

このリファレンスは以下から同期されています： src/definitions.ts における capacitor-youtube-player.

@capgo/capacitor-youtube-playerから続ける

使用している場合 @capgo/capacitor-youtube-player ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-youtube-playerの使い方 「@capgo/capacitor-youtube-playerの使い方」のネイティブ機能については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新における実装詳細については、および Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案におけるプロダクトワークフローについては。