Package selection guidance compiled from public package information, community data, and project usage.
Omni Video Player is a versatile Flutter widget designed to play videos from multiple sources, including YouTube, Vimeo, local assets, and network URLs. It offers full customization options for playback controls, styling, and behavior, making it easy to integrate into any Flutter application. The package supports Android, iOS, and Web platforms, ensuring cross-platform consistency. With a clean API and built-in error handling, it simplifies video integration without sacrificing flexibility.
Use cases
Embedding YouTube videos in apps
Playing Vimeo content within Flutter
Streaming videos from remote URLs
Using local video assets
Creating custom video players
Key features
Supports YouTube, Vimeo, assets, and network videos
Highly customizable UI and controls
Cross-platform compatibility (Android, iOS, Web)
Built-in error handling and loading states
Simple integration with minimal setup
Suitable for
Media-heavy applications
Educational apps with video content
Content delivery platforms
Custom video player implementations
Apps requiring multi-source video support
Considerations
Requires internet access for online video sources
May need additional configuration for advanced customization
Limited to supported video formats on each platform
Depends on external APIs for YouTube/Vimeo playback
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
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.