视频播放器 Capacitor 插件

使用 @capgo/capacitor-video-player

使用 Capacitor 插件在原生播放器中播放视频。

安装

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

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { VideoPlayer } from '@capgo/capacitor-video-player';

API 概览

方法	描述
initPlayer	初始化视频播放器。
isPlaying	返回指定 playerId 是否正在播放。
play	播放指定 playerId 的当前视频。
pause	暂停指定 playerId 的当前视频。
getDuration	获取指定 playerId 的当前视频时长。
getCurrentTime	获取指定 playerId 当前视频的播放时间。
setCurrentTime	设置指定 playerId 当前视频的跳转时间。
getVolume	获取指定 playerId 当前视频的音量。
setVolume	设置指定 playerId 当前视频的音量。
getMuted	获取指定 playerId 当前视频是否静音。
setMuted	通过指定的 playerId 设置当前视频的静音状态。
setRate	通过指定的 playerId 设置当前视频的播放速率。
getRate	通过指定的 playerId 获取当前视频的播放速率。
stopAllPlayers	停止所有正在播放的播放器。
showController	显示控制器。
isControllerIsFullyVisible	isControllerIsFullyVisible.
exitPlayer	退出播放器。
hidePlayer	隐藏当前显示的播放器 UI，但不停止播放（原生全屏模式）。
showPlayer	重新显示之前隐藏的播放器 UI（原生全屏模式）。

示例

initPlayer()

初始化视频播放器。

import { VideoPlayer } from '@capgo/capacitor-video-player';

const result = await VideoPlayer.initPlayer({ mode: 'fullscreen' });
console.log(result);

isPlaying()

返回指定 playerId 是否正在播放。

import { VideoPlayer } from '@capgo/capacitor-video-player';

const result = await VideoPlayer.isPlaying({ playerId: 'player-id-123' });
console.log(result);

play()

播放指定 playerId 的当前视频。

import { VideoPlayer } from '@capgo/capacitor-video-player';

const result = await VideoPlayer.play({ playerId: 'player-id-123' });
console.log(result);

pause()

暂停指定 playerId 的当前视频。

import { VideoPlayer } from '@capgo/capacitor-video-player';

const result = await VideoPlayer.pause({ playerId: 'player-id-123' });
console.log(result);

getDuration()

获取指定 playerId 的当前视频时长。

import { VideoPlayer } from '@capgo/capacitor-video-player';

const result = await VideoPlayer.getDuration({ playerId: 'player-id-123' });
console.log(result);

getCurrentTime()

获取指定 playerId 当前视频的播放时间。

import { VideoPlayer } from '@capgo/capacitor-video-player';

const result = await VideoPlayer.getCurrentTime({ playerId: 'player-id-123' });
console.log(result);

上表列出了 19 个核心方法。监听器、版本辅助函数以及每个方法的完整契约，详见 GitHub 仓库.

完整参考文档

• GitHub 仓库
• 文档
• API 参考文档

从“使用 @capgo/capacitor-video-player”继续

如果你正在使用 使用 @capgo/capacitor-video-player 来规划原生媒体和界面行为，并将其与 @capgo/capacitor-video-player 有关 @capgo/capacitor-video-player 的实现细节， 快速入门 有关“入门指南”中的实现细节， 使用 @capgo/capacitor-live-activities 用于使用 @capgo/capacitor-live-activities 时的原生能力， @capgo/capacitor-live-activities 关于 @capgo/capacitor-live-activities 中的实现细节，以及 使用 @capgo/capacitor-native-navigation 用于使用 @capgo/capacitor-native-navigation. 时的原生能力