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

import 'package:vimeo_video_player/vimeo_video_player.dart';

And add it in its most basic form like it:

@override
Widget build(BuildContext context) {
  return 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
bool portrait	false	Used to display the profile avatar
bool badge	false	Used to display the vimeo logo
bool enableFullScreenOnPlay	false	Used to enable fullscreen mode when playing. When enabled, the player go full screen when play is hit
Color backgroundColor	Colors.black	Defines the background color of the InAppWebView

Optional parameters of VimeoVideoPlayer

---

Parameter	Description
String? privacyHash	Used to define the the hash for the unlisted vimeo video
VoidCallback? onReady	Used to define a callback function triggered when the player is ready to play the video
VoidCallback? onPlay	Used to define a callback function triggered when the video begins playing
VoidCallback? onPause	Used to define a callback function triggered when the video is paused
VoidCallback? onFinish	Used to define a callback function triggered when the video playback finishes
VoidCallback? onSeek	Used to define a callback function triggered when the video playback position is modified
Function(InAppWebViewController controller)? onInAppWebViewCreated	Used to define a callback function triggered when the WebView is created
Function(InAppWebViewController controller, WebUri? uri)? onInAppWebViewLoadStart	Used to define a callback function triggered when the WebView starts to load an url
Function(InAppWebViewController controller, WebUri? uri)? onInAppWebViewLoadStop	Used to define a callback function triggered when the WebView finishes loading an url
Function(InAppWebViewController controller, WebResourceRequest request, WebResourceError? error)? onInAppWebViewReceivedError	Used to define a callback function triggered when the WebView encounters an error loading a request
final void Function(InAppWebViewController controller)? onEnterFullscreen	Used to define a callback function triggered when the WebView enters full screen
final void Function(InAppWebViewController controller)? onExitFullscreen	Used to define a callback function triggered when the WebView exits full screen
final ValueChanged? currentPositionInSeconds	Used to define a callback function that notifies current video position
int? initialPositionInSeconds	Used to define the initial video position in seconds

Dependencies

• 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.

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] And do let us know if you have any questions or suggestion regarding our work.

Visit our website mindinventory.com

Let us know if you are interested to building Apps or Designing Products.