Omni Video Player 是一个功能强大的 Flutter 小部件,旨在从多个来源播放视频,包括 YouTube、Vimeo、本地资源和网络 URL。它提供了完整的播放控制、样式和行为自定义选项,使集成到任何 Flutter 应用程序变得简单。该包支持 Android、iOS 和 Web 平台,确保跨平台一致性。凭借简洁的 API 和内置错误处理,它简化了视频集成,同时不牺牲灵活性。
适合场景
在应用中嵌入YouTube视频
在 Flutter 中播放 Vimeo 内容
从远程URL流式传输视频
使用本地视频资源
创建自定义视频播放器
主要特点
支持 YouTube、Vimeo、资源和网络视频
高度可定制的用户界面和控件
跨平台兼容性(Android、iOS、Web)
内置的错误处理和加载状态
简单集成,设置最少
适合对象
媒体密集型应用
带有视频内容的教育类应用程序
内容分发平台
自定义视频播放器实现
需要多源视频支持的应用程序
使用建议
需要互联网连接以访问在线视频源
可能需要额外配置以进行高级自定义
受限于各平台支持的视频格式
依赖外部API进行YouTube/Vimeo播放
原始 README
以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。
The ultimate All-in-One Flutter video solution. Stream YouTube, Vimeo, HLS, and local files with a single, unified controller.
🚀 Why Omni Video Player?
Stop juggling multiple packages for different video sources. omni_video_player wraps the complexity of specialized extractors and webviews into a single, powerful widget.
Smart YouTube Handling: Direct extraction via youtube_explode_dart with an automatic WebView fallback. The player seamlessly switches to WebView if the primary method fails, ensuring uninterrupted playback and no black screens for your users.
Vimeo Ready: Stable playback using optimized WebViews.
Adaptive Streaming: Native support for HLS (.m3u8) with built-in quality selection UI.
Unified Controller: One controller to rule them all. Manage state, volume, and seeking regardless of the source.
📊 Compatibility Matrix
Source / Format
Android
iOS
WebView (Android & iOS - alt/fallback)
Web
Notes
YouTube
✅
✅
✅
✅
Auto-fallback to WebView on primary method fails.
Vimeo
-
-
✅
✅
High stability via WebView.
HLS (.m3u8)
✅
✅
-
✅
Multi-quality switching supported.
Network (.mp4/etc)
✅
✅
-
✅
Standard streaming.
Assets/Files
✅
✅
-
✅
Local storage & bundle support.
AVI
✅
❌
-
✅
Not supported on iOS (OS limitation).
WebM
✅
❌
✅
✅
Requires WebView on iOS (no native support); seeking is disabled on iOS (WebKit can't seek WebM without freezing).
✨ Key Features
📦 Universal Sources: YouTube (Live/VOD), Vimeo, Network, Assets, and Local Files.
⚙️ Quality Selector: Built-in UI to switch resolutions for YouTube and HLS streams.
🎨 Fully Skinnable: Customize the UI, overlays, and controls to match your brand.
⏩ Advanced UX: Double-tap to seek, playback speed control (0.5x to 2.0x), and swipe gestures.
🔊 Global Sync: Synchronize volume and mute states across multiple player instances.
⛶ Native Fullscreen: Smooth transition to fullscreen mode on mobile.
🧪 Preview
YouTube
YouTube Live
M3U8 Network Link
Vimeo
🛠️ Quick Start
1. Installation
Add this to your pubspec.yaml:
dependencies:omni_video_player:^latest_version
2. Platform Setup (Optional)
Configure these only if your use case requires it:
Android (AndroidManifest.xml)
INTERNET: Required for any online stream (YouTube, Vimeo, Web).
Want to see the player in action with all its features? We have provided a comprehensive example project.
Download/Clone this repository.
Navigate to the example/ folder.
Run lib/main.dart on your device or emulator.
This demo showcases everything the library supports: quality switching, source transitions, custom controls, and more. It is the best way to understand the full potential of omni_video_player.
Reactive UI with Controller
Control the player from anywhere in your widget tree:
Play an ordered queue of videos with on-video previous/next buttons. Set autoAdvance to move to the next video automatically when one finishes, and loop to wrap around the ends:
Only one audible player plays at a time: starting an audible player pauses the audible one before it. Muted players sit outside that rule — any number of them play together, and unmuting one makes it join the rule, pausing whoever was audible at that moment. Muting a playing video releases it from the rule without stopping it.
A player holds the wakelock while it is audible or fullscreen, so a list of decorative muted loops does not keep the device awake, while a video you muted and kept watching full screen still does.
For a row or list of muted looping videos, set autoPlay: true and autoMuteOnStart: true, and leave pauseWhenOutOfView at its default: playback starts when the player is fully visible and stops when it scrolls away. onFinished fires once at the real end of every playback and re-arms afterwards, so it can drive a "play N times" counter.
A player given an explicit initialVolume keeps it. The shared volume no longer overwrites it when the player is created, and later changes to the shared volume still reach it unless synchronizeMuteAcrossPlayers is false. When both are set, autoMuteOnStart wins and initialVolume becomes the level the player returns to once unmuted.
🔮 Roadmap
Feature
Description
Status
Picture-in-Picture
Play in floating overlay (OS level).
🏗️ Researching
Playlist Support
Queue system for multiple videos.
✅ (4.0.0)
Download Mode
Cache management for offline viewing.
🔜 Planned
Cast Support
Google Cast & AirPlay integration.
🔜 Planned
❓ FAQ
Known Issue: "Made for Kids" YouTube Videos
Youtube videos marked as "Made for Kids" in YouTube Studio cannot be played using the default extraction method on mobile platforms (iOS/Android) due to API restrictions.
Solution 1: If you own the video, uncheck the "Made for Kids" option in YouTube Studio.
Solution 2: Initialize the player with forceYoutubeWebViewOnly: true. This bypasses the default extraction and plays the video via WebView.
Why is there no quality selection for YouTube on iOS?
On Android, we can handle separate Audio and Video streams provided by the API, allowing for multiple quality options.
The iOS Limitation: The native iOS player struggles to synchronize separate Audio/Video tracks without pre-loading the entire file (causing huge delays).
The Result: On iOS, we must use a "muxed" stream (combined audio/video). The YouTube API currently provides only one muxed stream at 360p. Therefore, quality selection is disabled on iOS as there are no other combined streams available to switch to.
Why can't I seek WebM videos on iOS?
WebM has no native iOS support, so it plays through a WebView. WebKit, however, cannot seek a WebM stream without freezing the decoder (the frame stalls and can't recover). To avoid a broken state, seeking is disabled for WebM on iOS: the seek bar and skip gestures are turned off, while play/pause and duration work normally. WebM seeking works on Android (native playback).
📄 License
Released under the BSD 3-Clause License. See LICENSE for details.