Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mindinventory/vimeo_video_player
A Video Player For Vimeo Videos in Flutter. This plugin allows us to play video from Vimeo and it supports Android and iOS platforms.
https://github.com/mindinventory/vimeo_video_player
flutter-vimeo-video-player vimeo-flutter-player vimeo-player
Last synced: 3 days ago
JSON representation
A Video Player For Vimeo Videos in Flutter. This plugin allows us to play video from Vimeo and it supports Android and iOS platforms.
- Host: GitHub
- URL: https://github.com/mindinventory/vimeo_video_player
- Owner: Mindinventory
- License: mit
- Created: 2021-12-24T11:05:06.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-24T08:47:13.000Z (about 1 month ago)
- Last Synced: 2025-01-14T03:08:10.051Z (10 days ago)
- Topics: flutter-vimeo-video-player, vimeo-flutter-player, vimeo-player
- Language: C++
- Homepage: https://www.mindinventory.com/flutter-app-development.php
- Size: 19 MB
- Stars: 36
- Watchers: 4
- Forks: 39
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# vimeo_video_player
A Flutter package to play Vimeo videos using their Video ID. Utilizes InAppWebView for smooth video
playback directly in your Flutter app.
## Key Features
* Easy way to play vimeo video in flutter app.
* Supports customizable controls like `isAutoPlay`, `isLooping`, `isMuted`, `showTitle`,
`showByline`,
`showControls`, `enableDNT`, `backgroundColor`.
* Event callbacks include `onReady`, `onPlay`, `onPause`, `onFinish`, `onSeek`,
`onInAppWebViewCreated`, `onInAppWebViewLoadStart`, `onInAppWebViewLoadStop`, and
`onInAppWebViewReceivedError`.
# Preview
## Basic Usage
Import it to your project file
```dart
import 'package:vimeo_video_player/vimeo_video_player.dart';
```
And add it in its most basic form like it:
```dart
VimeoVideoPlayer(
videoId: '12860646',
);
```
### Required parameters of VimeoVideoPlayer
------------
| Parameter | Description |
|----------------|-----------------------------------------------------------------------------|
| String videoId | Defines the vimeo video ID to be played, it is required and cannot be empty |
### Optional parameters of VimeoVideoPlayer with Default value
------------
| Parameter | Default | Description |
|------------------------|--------------|---------------------------------------------------------------------------------------------------------|
| bool isAutoPlay | false | Used to auto-play the video once initialized |
| bool isLooping | false | Used to play the video in a loop after it ends |
| bool isMuted | false | Used to play the video with the sound muted |
| bool showTitle | false | Used to display the video title |
| bool showByline | false | Used to display the video byline/author |
| bool showControls | true | Used to display the video playback controls |
| bool enableDNT | true | Used to enable Do Not Track (DNT) mode, When enabled, the player will not track any viewing information |
| Color backgroundColor | Colors.black | Defines the background color of the InAppWebView |
### Optional parameters of VimeoVideoPlayer
------------
| Parameter | Description |
|------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
| VoidCallback? onReady | Defines a callback function triggered when the player is ready to play the video |
| VoidCallback? onPlay | Defines a callback function triggered when the video begins playing |
| VoidCallback? onPause | Defines a callback function triggered when the video is paused |
| VoidCallback? onFinish | Defines a callback function triggered when the video playback finishes |
| VoidCallback? onSeek | Defines a callback function triggered when the video playback position is modified |
| Function(InAppWebViewController controller)? onInAppWebViewCreated | Defines a callback function triggered when the WebView is created |
| Function(InAppWebViewController controller, WebUri? url)? onInAppWebViewLoadStart | Defines a callback function triggered when the WebView starts to load an url |
| Function(InAppWebViewController controller, WebUri? url)? onInAppWebViewLoadStop | Defines a callback function triggered when the WebView finishes loading an url |
| Function(InAppWebViewController controller, WebResourceRequest request, WebResourceError error)? onInAppWebViewReceivedError | Defines a callback function triggered when the WebView encounters an error loading a request |
## Dependencies
* [flutter_inappwebview](https://pub.dev/packages/flutter_inappwebview): ^6.1.5
## Guideline for contributors
* Contribution towards our repository is always welcome, we request contributors to create a pull
request for development.
## Guideline to report an issue/feature request
It would be great for us if the reporter can share the below things to understand the root cause of
the issue.
* Library version
* Code snippet
* Logs if applicable
* Device specification like (Manufacturer, OS version, etc)
* Screenshot/video with steps to reproduce the issue
* Library used
## LICENSE!
**vimeo_video_player**
is [MIT-licensed.](https://github.com/Mindinventory/vimeo_video_player/blob/master/LICENSE)
## Let us know!
We’d be really happy if you send us links to your projects where you use our open-source libraries.
Just send an email to [[email protected]](mailto:[email protected]) And do let us know
if you have any questions or suggestion regarding our work.
Visit our website [mindinventory.com](https://www.mindinventory.com)
Let us know if you are interested to building Apps or Designing Products.
