YouTube プレイヤー プラグインのインターフェイスは Capacitor です。アプリ内で YouTube ビデオの再生を制御するためのメソッドを提供します。
基本機能
セクション「基本機能」initialize- YouTube プレイヤー インスタンスを新規に初期化します。destroy- プレイヤーインスタンスを破棄し、リソースを解放します。stopVideo- ビデオ再生を停止し、ロードをキャンセルします。使用する場合はまれに - pauseVideo() が推奨されます。playVideo- 予め準備したビデオを再生します。最終的なプレイヤー状態はPLAYING (1) になります。
Public API
セクション「Public API」| メソッド | 説明 |
|---|---|
initialize | YouTube プレイヤーインスタンスを新規に初期化します。 |
destroy | プレイヤーインスタンスを破棄し、リソースを解放します。 |
stopVideo | ビデオ再生を停止し、ロードをキャンセルします。使用する場合はまれに - pauseVideo() が推奨されます。 |
playVideo | 現在再生中のビデオを一時停止します。最終的なプレイヤー状態は PAUSED (2) になります。既に ENDED (0) である場合は除きます。 |
pauseVideo | 現在再生中のビデオを一時停止します。最終的なプレイヤー状態は PAUSED (2) になります。既に ENDED (0) である場合は除きます。 |
seekTo | 特定の時間に動画を移動します。再生が停止中の場合、停止状態が維持され、再生中の場合、再生が継続されます。 |
loadVideoById | YouTube IDで指定された動画を読み込んで再生します。 |
cueVideoById | IDで指定された動画をクイューします。サムネイルを読み込み、プレーヤーを準備しますが、動画を要求することはありません。playVideo()が呼び出されるまで、動画は読み込まれません。 |
loadVideoByUrl | URLで指定された動画を読み込んで再生します。 |
cueVideoByUrl | URLで指定された動画をクイューします。サムネイルを読み込み、プレーヤーを準備しますが、動画を要求することはありません。playVideo()が呼び出されるまで、動画は読み込まれません。 |
cuePlaylist | URLで指定されたプレイリストをクイューします。プレイリストと最初の動画を読み込み、プレーヤーを準備します。 |
loadPlaylist | URLで指定されたプレイリストを読み込んで再生します。 |
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 | プラグインのバージョン番号を取得します。プラットフォーム固有のバージョン情報を返します。 |
ソース・オブ・トラース
「ソース・オブ・トラース」というセクション__CAPGO_KEEP_0__-youtube-player src/definitions.ts このリファレンスは capacitor-youtube-player.