@ capgo/ 电容- 视频播放器

在您 Capacitor app 的本地全屏播放器中播放视频,并配有字幕,图片和Chromecast支持.

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-video-player 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 添加@capgo/capor-video-player到我的Capacitor应用程序上,并把它接上" 代理设置指南 • 妇女 主机磁共振

主要特点

• 玩家数字 : initPlayer() 为 URL 创建播放器,使用 play(), (中文(简体) ), pause() 财务报告和审定财务报表 stopAllPlayers()。 。 。 .
• 播放控件数字 : setCurrentTime(), (中文(简体) ), setVolume(), (中文(简体) ), setMuted() 财务报告和审定财务报表 setRate()与匹配的获取器.
• 字幕: 一个或多个带有语言选项的字幕音轨.
• 本地额外项目:图片中的图片,背景模式,末端的回路和Chromecast铸造.
• 主计长数字 : showController() 财务报告和审定财务报表 isControllerIsFullyVisible() 对本地控制.
• 平台: iOS,Android和Web. 互联网档案馆的存檔,存档日期2013-12-02. Web还支持嵌入式玩家模式.

文档

这里有最完整的医生: https://capgo.app/docs/plugins/video-player/ 互联网档案馆的存檔,存档日期2014-12-22

兼容性

说明: 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的 Capacitor 安装的版本( 如 Capacitor 8 的插件 v8) 。 只有最新的主要版本得到积极维护.

安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-video-player` plugin in my project.

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

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

iOS Chromecast 设置

iOS Chromecast使用Google Cast SDK默认媒体接收器. 何时 chromecast 启用时,插件会在全屏iOS播放器上添加一个 Cast 按钮,在选定的接收器上加载当前媒体,并保持插件播放/暂停/seek/批量呼叫指向正在运行的 Cast 会话.

对于在iOS上的 Cast 发现, 请在您的应用程序中添加本地网络密钥 Info.plist。 。 。 .

<key>NSBonjourServices</key>
<array>
  <string>_googlecast._tcp</string>
  <string>_CC1AD845._googlecast._tcp</string>
</array>
<key>NSLocalNetworkUsageDescription</key>
<string>$(PRODUCT_NAME) uses the local network to discover Cast-enabled devices on your WiFi network.</string>

await VideoPlayer.initPlayer({
  playerId: 'fullscreen',
  mode: 'fullscreen',
  url: 'https://example.com/video.mp4',
  title: 'Video title',
  smallTitle: 'Video subtitle',
  artwork: 'https://example.com/poster.jpg',
  chromecast: true,
});

支持的特性

Chromecast (Android) (英语)

Chromecast在Android上以全屏模式支持. 启用它与 chromecast 选项。 当一个 Cast 会话开始时,插件会在接收器上加载相同的媒体URL,保持当前回放位置,并通过 Cast会话播放,暂停,寻求,以及时间表控制.

await VideoPlayer.initPlayer({
  mode: 'fullscreen',
  playerId: 'main-player',
  url: 'https://example.com/video.m3u8',
  title: 'Video title',
  smallTitle: 'Optional subtitle',
  artwork: 'https://example.com/artwork.jpg',
  chromecast: true,
  showControls: true,
});

Chromecast 选项

所需资源和说明

• 媒体URL必须能够被Chromecast设备所达到,而不仅仅是Android应用.
• 铸作支持依赖于接收器的应用和装置媒体支持. MP4,HLS,DASH,和平滑结构流被插件映射为Cast相容的MIME类型.
• Widevine DRM元数据被传送到Cast媒体项目. 受 DRM 保护的流可能仍然需要一个支持您的许可证服务器和 DRM 流量的接收器 .
• Android本地玩家使用的请求头无法自动为Chromecast接收器提供. 使用公开的 URL, 签名的 URL, 由您的接收器支持的 cookie, 或安全媒体的自定义接收器 .

图片中的 Android 图片

Android上的图片需要您的应用活动来声明 PiP 支持 android/app/src/main/AndroidManifest.xml数字 :

<activity
  android:name=".MainActivity"
  android:supportsPictureInPicture="true"
  android:launchMode="singleTask"
  android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|smallestScreenSize|screenLayout|uiMode|navigation|density"
  ...>
</activity>

launchMode="singleTask" 编辑 configChanges 旗子防止玩家在进入或离开PiP时的活动被重新创建.

图片和背景音频中的 iOS 图片

在 iOS 上, 本地玩家配置 AVAudioSession 用于 Pip 和背景播放 pipEnabled 或者说 bkmodeEnabled 真实( 都默认为真实) 。 您的应用程序还需要正确的列表和能力条目 :

1. 在 Xcode 中,添加 背景模式 能力与能力 音频、 AirPlay 和图片。 。 。 .
2. 单位 ios/App/App/Info.plist,包括音频背景模式 :

<key>UIBackgroundModes</key>
<array>
  <string>audio</string>
</array>

在物理 iPhone 上测试 PiP(模拟器不支持图片中的图片). 设置 audioCategory: 'ambient' 尊重无声开关, 但是在屏幕锁上保持沉默音频; 让它未设定或使用 playback 用于播放音响背景.

API 密码

• initPlayer(...)
• isPlaying(...)
• play(...)
• pause(...)
• getDuration(...)
• getCurrentTime(...)
• setCurrentTime(...)
• getVolume(...)
• setVolume(...)
• getMuted(...)
• setMuted(...)
• setRate(...)
• getRate(...)
• stopAllPlayers()
• showController()
• isControllerIsFullyVisible()
• exitPlayer()
• hidePlayer()
• showPlayer()
• getPluginVersion()
• 接口

内置 Player (...)

initPlayer(options: capVideoPlayerOptions) => Promise<capVideoPlayerResult>

初始化视频播放器

回返情况: Promise<capVideoPlayerResult>

正在播放(...)

isPlaying(options: capVideoPlayerIdOptions) => Promise<capVideoPlayerResult>

如果给定的播放器正在播放, 返回

回返情况: Promise<capVideoPlayerResult>

播放(...)

play(options: capVideoPlayerIdOptions) => Promise<capVideoPlayerResult>

播放给定播放器的当前视频Id

回返情况: Promise<capVideoPlayerResult>

暂停(...)

pause(options: capVideoPlayerIdOptions) => Promise<capVideoPlayerResult>

暂停给定播放器的当前视频Id

回返情况: Promise<capVideoPlayerResult>

获取期限(...)

getDuration(options: capVideoPlayerIdOptions) => Promise<capVideoPlayerResult>

从给定的播放器ID获取当前视频的持续时间

回返情况: Promise<capVideoPlayerResult>

获取当前时间(...)

getCurrentTime(options: capVideoPlayerIdOptions) => Promise<capVideoPlayerResult>

从给定的播放器ID获取当前视频的时间

回返情况: Promise<capVideoPlayerResult>

设置当前时间(...)

setCurrentTime(options: capVideoTimeOptions) => Promise<capVideoPlayerResult>

设定当前从给定的 playerId 中查找当前视频的时间

回返情况: Promise<capVideoPlayerResult>

获取Volume (...)

getVolume(options: capVideoPlayerIdOptions) => Promise<capVideoPlayerResult>

从给定的播放器ID获取当前视频的音量

回返情况: Promise<capVideoPlayerResult>

设置卷 (...)

setVolume(options: capVideoVolumeOptions) => Promise<capVideoPlayerResult>

将当前视频的音量设定为给定的播放器ID

回返情况: Promise<capVideoPlayerResult>

获取Muted (...)

getMuted(options: capVideoPlayerIdOptions) => Promise<capVideoPlayerResult>

从给定的播放器ID中获取当前视频的哑音

回返情况: Promise<capVideoPlayerResult>

设置已挂载(...)

setMuted(options: capVideoMutedOptions) => Promise<capVideoPlayerResult>

将当前视频的变音设定为给定播放器ID

回返情况: Promise<capVideoPlayerResult>

设置Rate(...)

setRate(options: capVideoRateOptions) => Promise<capVideoPlayerResult>

设定当前视频从给定播放器ID 的速率

回返情况: Promise<capVideoPlayerResult>

获取Rate(...)

getRate(options: capVideoPlayerIdOptions) => Promise<capVideoPlayerResult>

从给定的播放器ID获取当前视频的速率

回返情况: Promise<capVideoPlayerResult>

停止所有 Players ()

stopAllPlayers() => Promise<capVideoPlayerResult>

停止所有玩家的游戏

回返情况: Promise<capVideoPlayerResult>

显示控制器 ()

showController() => Promise<capVideoPlayerResult>

显示控制器

回返情况: Promise<capVideoPlayerResult>

是 CaptainIs Fully Visible () () 翻译

isControllerIsFullyVisible() => Promise<capVideoPlayerResult>

控制器易见

回返情况: Promise<capVideoPlayerResult>

退出 Player ()

exitPlayer() => Promise<capVideoPlayerResult>

退出玩家

回返情况: Promise<capVideoPlayerResult>

隐藏layer ()

hidePlayer() => Promise<capVideoPlayerResult>

隐藏当前呈现的播放器 UI 不停止播放( 本地全屏) .

打电话 showPlayer() 以再次显示.

回返情况: Promise<capVideoPlayerResult>

显示layer ()

showPlayer() => Promise<capVideoPlayerResult>

再次显示先前隐藏的玩家 UI( 本地全屏) .

回返情况: Promise<capVideoPlayerResult>

获取 PluginVersion ()

getPluginVersion() => Promise<{ version: string; }>

获取本地 Capacitor 插件版本 . 在网络上, 执行返回 "web"。 。 。 .

回返情况: Promise<{ version: string; }>

接口

图像显示器

图像显示器选项

视频字幕

视频章节

字幕选项

屏幕字幕的可选风格.

在iOS上,颜色和字体大小通过 AVPlayerItem textStyleRules,只有WebVTT的苹果文档。 IMSC1和其他数据 无法通过此 API 来样式化 . 内置的WebVTT提示样式可以优先于等同类型 subtitleOptions 值; 插件将文本样式规则设置为平台 倒置, 无法保证默认作者的提示样式 .

选项

FairPlayDrm 选项

播放已准备

宽度选项

capVideoPlayer 选项

视频时间选项

图像卷选项

图像混合选项

超视距选项