跳过内容
Capgo - 实时更新 Capacitor 应用程序 Capgo

开始使用

安装

标题为“安装”的部分
终端窗口
bun add @capgo/capacitor-youtube-player
bunx cap sync

导入

标题为“导入”的部分
import { YoutubePlayer } from '@capgo/capacitor-youtube-player';

API 介绍

Section titled “API Overview”

initialize

Section titled “初始化”

初始化一个新的 YouTube 播放器实例。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.initialize({
  playerId: 'my-player',
  videoId: 'dQw4w9WgXcQ',
  playerSize: { width: 640, height: 360 },
  privacyEnhanced: true
});

destroy

Section titled “销毁”

销毁一个播放器实例并释放资源。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.destroy({} as PlayerIdOptions);

stopVideo

Section titled “停止视频”

停止视频播放并取消加载。 通常情况下，pauseVideo() 是更好的选择。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.stopVideo({} as PlayerIdOptions);

playVideo

Section titled “播放视频”

播放当前缓冲或已加载的视频。 最终播放器状态将为 PLAYING (1)。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.playVideo({} as PlayerIdOptions);

pauseVideo

标题：暂停视频

暂停当前播放的视频。 视频最终状态将为暂停（2），除非已经结束（0）。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.pauseVideo({} as PlayerIdOptions);

seekTo

标题：跳转到

跳转到视频的特定时间。 如果视频暂停，暂停状态保持不变。如果正在播放，继续播放。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.seekTo({} as SeekToOptions);

loadVideoById

标题：通过 YouTube ID 加载视频

通过 YouTube ID 加载并播放视频。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.loadVideoById({} as VideoByIdMethodOptions);

cueVideoById

标题：通过 ID 引导视频

通过 ID 引导视频，不播放。 加载缩略图并准备播放器，但不请求视频，直到调用 playVideo() 方法。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.cueVideoById({} as VideoByIdMethodOptions);

loadVideoByUrl

标题：loadVideoByUrl

通过视频的完整 URL 加载并播放视频。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.loadVideoByUrl({} as VideoByUrlMethodOptions);

cueVideoByUrl

标题：cueVideoByUrl

通过 URL 引用视频而不播放它。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.cueVideoByUrl({} as VideoByUrlMethodOptions);

cuePlaylist

标题：cuePlaylist

通过 URL 引用播放列表而不播放它。 加载播放列表并准备播放第一段视频。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.cuePlaylist({} as PlaylistMethodOptions);

loadPlaylist

标题：loadPlaylist

加载并播放播放列表。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.loadPlaylist({} as PlaylistMethodOptions);

nextVideo

标题：下一个视频

在播放列表中播放下一个视频。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.nextVideo({} as PlayerIdOptions);

previousVideo

标题：上一个视频

在播放列表中播放上一个视频。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.previousVideo({} as PlayerIdOptions);

playVideoAt

标题：播放指定视频

通过索引在播放列表中播放指定视频。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.playVideoAt({} as PlayVideoAtOptions);

mute

标题：静音

静音播放器音频。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.mute({} as PlayerIdOptions);

unMute

标题：“取消静音”

取消播放器音频静音。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.unMute({} as PlayerIdOptions);

isMuted

标题：“是否静音”

检查播放器是否当前静音。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.isMuted({} as PlayerIdOptions);

setVolume

标题：“设置音量”

设置播放器音量级别。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.setVolume({} as SetVolumeOptions);

getVolume

标题：“获取音量”

获取当前播放器音量级别。 返回音量，即使播放器静音。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getVolume({} as PlayerIdOptions);

setSize

标题：设置大小

设置播放器尺寸（像素）

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.setSize({} as SetSizeOptions);

getPlaybackRate

标题：获取播放速度

获取当前播放速度

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getPlaybackRate({} as PlayerIdOptions);

setPlaybackRate

标题：设置播放速度

设置播放速度

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.setPlaybackRate({} as SetPlaybackRateOptions);

getAvailablePlaybackRates

标题：获取可用播放速度

获取当前视频的可用播放速度列表

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getAvailablePlaybackRates({} as PlayerIdOptions);

setLoop

标题：setLoop

开启或关闭播放列表循环。 开启后，播放列表将在最后一个视频后重新开始。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.setLoop({} as SetLoopOptions);

setShuffle

标题：setShuffle

开启或关闭播放列表随机播放。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.setShuffle({} as SetShuffleOptions);

getVideoLoadedFraction

标题：getVideoLoadedFraction

获取视频缓冲的分数。 比过时的getVideoBytesLoaded/getVideoBytesTotal更可靠。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getVideoLoadedFraction({} as PlayerIdOptions);

getPlayerState

标题：getPlayerState

获取播放器当前状态。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getPlayerState({} as PlayerIdOptions);

getAllPlayersEventsState

标题：获取所有活跃玩家的事件状态

获取所有活跃玩家的事件状态。 用于跟踪多个玩家实例。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getAllPlayersEventsState();

getCurrentTime

标题：获取当前时间

获取当前播放位置（以秒为单位）。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getCurrentTime({} as PlayerIdOptions);

toggleFullScreen

标题：切换全屏模式

切换全屏模式开关。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.toggleFullScreen({} as ToggleFullScreenOptions);

getPlaybackQuality

标题：获取播放质量

获取当前播放质量。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getPlaybackQuality({} as PlayerIdOptions);

setPlaybackQuality

标题：设置播放质量

设置建议的播放质量。 实际质量可能根据网络条件而有所不同。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.setPlaybackQuality({} as SetPlaybackQualityOptions);

getAvailableQualityLevels

标题：获取可用质量级别

获取当前视频的可用质量级别列表。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getAvailableQualityLevels({} as PlayerIdOptions);

getDuration

标题：获取视频时长

获取当前视频的时长（以秒为单位）。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getDuration({} as PlayerIdOptions);

getVideoUrl

标题：获取视频URL

获取当前视频的YouTube.com URL。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getVideoUrl({} as PlayerIdOptions);

getVideoEmbedCode

标题：获取视频嵌入代码

获取当前视频的嵌入 code。 返回 HTML iframe 嵌入 code。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getVideoEmbedCode({} as PlayerIdOptions);

getPlaylist

标题：获取播放列表

获取当前播放列表中的视频 ID 数组。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getPlaylist({} as PlayerIdOptions);

getPlaylistIndex

标题：获取播放列表索引

获取当前播放列表中正在播放的视频的索引。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getPlaylistIndex({} as PlayerIdOptions);

getIframe

标题：获取 iframe

获取播放器的 iframe DOM 元素。 仅限 Web 平台。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.getIframe({} as PlayerIdOptions);

addEventListener

标题：addEventListener

为播放器添加事件监听器。 仅限Web平台。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


YoutubePlayer.addEventListener({
  playerId: 'my-player',
  eventName: 'onStateChange',
  listener: (event) => {
  console.log('Player state:', event.data);
  },
});

removeEventListener

标题：removeEventListener

从播放器中移除事件监听器。 仅限Web平台。

import { YoutubePlayer } from '@capgo/capacitor-youtube-player';


await YoutubePlayer.removeEventListener({} as PlayerEventListenerOptions<TEvent>);

类型参考

标题：类型参考

PlayerIdOptions

标题：PlayerIdOptions
export interface PlayerIdOptions {
  playerId: string;
}

SeekToOptions

标题：SeekToOptions
export interface SeekToOptions extends PlayerIdOptions {
  playerId: string;
  seconds: number;
  allowSeekAhead: boolean;
}

VideoByIdMethodOptions

视频ById方法选项
export interface VideoByIdMethodOptions extends PlayerIdOptions {
  playerId: string;
  options: IVideoOptionsById;
}

VideoByUrlMethodOptions

视频ByUrl方法选项
export interface VideoByUrlMethodOptions extends PlayerIdOptions {
  playerId: string;
  options: IVideoOptionsByUrl;
}

PlaylistMethodOptions

播放列表方法选项
export interface PlaylistMethodOptions extends PlayerIdOptions {
  playerId: string;
  playlistOptions: IPlaylistOptions;
}

PlayVideoAtOptions

播放视频方法选项
export interface PlayVideoAtOptions extends PlayerIdOptions {
  playerId: string;
  index: number;
}

SetVolumeOptions

设置音量方法选项
export interface SetVolumeOptions extends PlayerIdOptions {
  playerId: string;
  volume: number;
}

SetSizeOptions

设置大小方法选项
export interface SetSizeOptions extends PlayerIdOptions {
  playerId: string;
  width: number;
  height: number;
}

SetPlaybackRateOptions

标题：设置播放速率选项
export interface SetPlaybackRateOptions extends PlayerIdOptions {
  playerId: string;
  suggestedRate: number;
}

SetLoopOptions

标题：设置循环选项
export interface SetLoopOptions extends PlayerIdOptions {
  playerId: string;
  loopPlaylists: boolean;
}

SetShuffleOptions

标题：设置混洗选项
export interface SetShuffleOptions extends PlayerIdOptions {
  playerId: string;
  shufflePlaylist: boolean;
}

ToggleFullScreenOptions

标题：切换全屏选项
export interface ToggleFullScreenOptions extends PlayerIdOptions {
  playerId: string;
  isFullScreen: boolean | null | undefined;
}

标题：源数据

本页面由插件生成

本页面是由插件生成的 src/definitions.ts. 当 upstream 的公共 API 变更时，请重新运行同步。