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

@capgo/capacitor-youtube-player

YouTube動画を埋め込み、API による完全なプレイヤー制御とイベントハンドリングを実現します

YouTube動画を埋め込み、API による完全なプレイヤー制御とイベントハンドリングを実現します

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

プラットフォームサポート備考
iOSはいネイティブ
Androidはいネイティブ
WebいいえCapacitor.getPlatform() でガードする
  • initialize - 新しいYouTubeプレイヤーインスタンスを初期化します。
  • destroy - プレイヤーインスタンスを破棄し、リソースを解放します。
  • stopVideo - 動画の再生を停止し、読み込みをキャンセルします。使用は控えめにし、通常は pauseVideo() を推奨します。
  • playVideo - 現在キューに入っている、または読み込まれている動画を再生します。最終的なプレイヤー状態は PLAYING (1) になります。
メソッド説明
initialize新しいYouTubeプレイヤーのインスタンスを初期化します。
destroyプレイヤーのインスタンスを破棄し、リソースを解放します。
stopVideo動画の再生を停止し、読み込みをキャンセルします。通常は pauseVideo() を使用してください。
playVideoキューに追加されている、またはロード済みの動画を再生します。最終的なプレイヤーの状態は PLAYING (1) になります。
pauseVideo再生中の動画を一時停止します。すでに ENDED (0) の状態でない限り、最終的なプレイヤーの状態は PAUSED (2) になります。
seekTo動画の特定の時間にシークします。プレイヤーが一時停止中の場合は一時停止を維持し、再生中の場合はそのまま再生を継続します。
loadVideoByIdYouTube IDを指定して動画をロードし、再生します。
cueVideoByIdIDを指定して動画をキューに追加します(再生はしません)。サムネイルをロードしてプレイヤーを準備しますが、playVideo() が呼ばれるまで動画のリクエストは行いません。
loadVideoByUrl動画のフルURLを指定してロードし、再生します。
cueVideoByUrlURLを指定して動画をキューに追加します(再生はしません)。
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プラグインのバージョン番号を取得します。プラットフォーム固有のバージョン情報を返します。

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

以下を使用している場合: @capgo/capacitor-youtube-player ネイティブプラグインの作業を計画するには、それを以下と連携させる @capgo/capacitor-youtube-playerの使用方法 @capgo/capacitor-youtube-playerを使用してネイティブ機能を利用する場合、 Capgo プラグインディレクトリ Capgo プラグインディレクトリでのプロダクトワークフロー向けに、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加・更新 実装の詳細は Adding or Updating Plugins を、 Ionic Enterprise プラグインの代替案 製品ワークフローは Ionic Enterprise Plugin Alternatives を参照してください。