@angelengineering/videoplayer

NativeScript VideoPlayer

内容

NativeScript Videoplayer
- 安装
- 使用
- 属性
- API
- 事件
- 致谢
- 许可

安装

npm install @angelengineering/videoplayer --save

或者

ns plugin add @angelengineering/videoplayer

使用

了解如何使用此插件的最佳方式是研究本存储库中包含的演示应用程序。您可以通过查看 apps/demo/src/plugin-demos/videoplayer.ts 页面来了解插件在 TypeScript 应用程序中的使用情况。

导入插件。

import { VideoPlayer } from '@angelengineering/videoplayer';

创建一个 videoplayer 实例。

let videoPlayer: VideoPlayer = new VideoPlayer();

播放视频文件/URL。

videoPlayer.src = 'path/to/movie/file';
videoPlayer.play();

属性

属性	描述
src	视频的源文件。设置要播放的视频文件，为了最佳性能，如果可能，请使用本地视频文件。文件必须遵守平台接受的视频格式。参考平台规格以播放视频。
autoplay - (布尔值)	设置视频是否应立即开始播放或等待用户交互。
controls - (布尔值)	设置为显示原生视频播放器的媒体播放控制。
muted - (布尔值)	静音原生视频播放器。
loop - (布尔值)	将原生视频播放器设置为播放结束后循环。
fill - (VideoFill 或布尔值)	iOS：设置渲染视频时使用的 VideoFill 模式。Android：启用或禁用自动填充模式
observeCurrentTime (布尔值)	如果为 true，则 currentTimeUpdated 回调是可能的。
debug - (布尔值)	启用或禁用控制台调试日志。

API

方法	描述
play	开始播放视频。
pause	暂停视频。
seekToTime(time: number)	将视频定位到指定时间（毫秒）。
getCurrentTime	返回视频持续时间中的当前时间（毫秒）。
getDuration	返回视频持续时间中的当前时间（毫秒）。
destroy	销毁视频播放器并释放资源。
mute(boolean)	如果为 true，则静音视频。如果为 false，则取消静音视频。
setVolume(volume: number)	设置音量 - 必须介于 0 和 1 之间。
setPlaybackSpeed(volume: number)	设置播放速度 - 必须介于 0.x 和 Y.Y 之间。
isPlaying	播放器是否正在播放媒体。
getVideoSize	返回视频尺寸 { width: number; height: number }
getPlayer	获取原生播放器实例。
stop	Android：停止播放 - 这将重置播放器并删除视频 src。iOS：暂停播放。

可观察属性

currentTime() - 视频的当前时间。

事件

事件	描述
errorEvent	当源代码中抛出错误时，触发此事件。
playbackReadyEvent	当视频准备就绪时，触发此事件。
playbackStartEvent	当视频开始播放时，触发此事件。
seekToTimeCompleteEvent	当搜索完成时，触发此事件。
currentTimeUpdatedEvent	当播放视频的当前时间更改时，触发此事件。
playbackFinishedEvent	当视频播放完成时，触发此事件。
mutedEvent	此事件在视频静音时触发。
unmutedEvent	此事件在视频解除静音时触发。
pausedEvent	此事件在视频暂停时触发。
volumeSetEvent	此事件在音量设置时触发。
chaptersLoadedEvent	仅限iOS：当章节加载完毕时触发此事件（如果有章节的话）。

致谢

此插件基于 https://github.com/nstudio/nativescript-videoplayer 和 https://github.com/nstudio/nativescript-plugins/blob/main/packages/nativescript-exoplayer/README.md

许可

Apache许可证第2版