搜尋套件、儲存庫與 APP 分類

套件詳情v1.6.4

youtube_player_embed

一個用於嵌入 YouTube 影片的 Flutter 套件,支援可自訂選項。

AndroidiOSmacOSWindows
近 30 天下載
1000
喜歡數
33
Pub 分數
155

安裝套件

flutter pub add youtube_player_embed

套件介紹

根據套件公開資料產生的選型評估,僅供參考。

一個 Flutter 套件,可實現 YouTube 影片在應用程式中的無縫嵌入,並提供可自訂的播放選項。它支援多個平台,包括 Android、iOS、macOS 和 Windows,為開發者提供靈活整合影片內容的方式。該套件提供簡單的 API 來載入和控制影片,包含自動播放、循環播放和自訂控制等功能。非常適合需要豐富媒體體驗的應用程式,例如教育平台、影片教學或娛樂應用。

適用情境

  • 在行動和桌面應用程式中嵌入 YouTube 影片
  • 創建影片教學介面
  • 建構媒體豐富的教育內容
  • 將影片串流整合至社交應用
  • 開發串流或娛樂平台

主要特色

  • 跨平台支援(Android、iOS、macOS、Windows)
  • 可自定義的播放器控制項
  • 自動播放和循環選項
  • 響應式影片尺寸
  • 與 Flutter UI 的輕鬆整合

適合對象

  • 教育類應用程式開發者
  • 媒體和娛樂應用
  • 內容創作者
  • 需要影片整合的應用程式建構者
  • Flutter 初學者探索媒體功能

使用建議

  • 需要互聯網連接以加載影片
  • 可能需要為自定義主題添加額外的樣式
  • 僅限YouTube影片網址
  • 多個播放器可能帶來的效能影響
  • 依賴於 YouTube 嵌入 API 的穩定性

原始 README

以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。

youtube_player_embed

Pub Version BSD-3 License Top Language GitHub issues GitHub Stars

youtube_player_embed is a lightweight and customizable Flutter package that allows developers to embed YouTube videos, including YouTube Shorts, directly into their Flutter applications using an InAppWebView. With this package, you can seamlessly integrate videos with advanced event handling, autoplay, mute, and aspect ratio customization.


Features

  • 🎥 Embed YouTube Videos and Shorts easily with minimal configuration.
  • 🔄 Autoplay Support for instant video playback.
  • 🔇 Mute Option for silent playback.
  • 📱 Responsive Design supporting both horizontal (16:9) and vertical (9:16) videos.
  • 💡 Customizable options to remove YouTube branding buttons for a cleaner UI.
  • 🔗 Direct Shorts Integration for embedding vertical YouTube Shorts seamlessly.
  • ⏰ Advanced Event Listeners for video state updates, time tracking, seek events, and mute/unmute detection.
  • 🔑 Enhanced Control to programmatically remove share and branding buttons dynamically.
  • ⏯ Full-Screen Support with seamless entry and exit.
  • ⏹️ Playback Controls: Play, Pause, Seek, Mute, and Unmute programmatically.
  • 🔍 Custom Video Titles: Dynamically set or hide video titles.
  • 🚀 Performance Optimized: Lightweight and efficient for a smoother user experience.

image


Installation

Add the following dependency to your pubspec.yaml:

dependencies:
  youtube_player_embed: ^1.6.4

Run the following command to install the package:

flutter pub get

Usage

Import the package:

import 'package:youtube_player_embed/youtube_player_embed.dart';

Embed a YouTube video in your app:

import 'package:flutter/material.dart';
import 'package:youtube_player_embed/youtube_player_embed.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {

    VideoController? videoController;

    return MaterialApp(
      title: 'YouTube Player Embed Demo',
      home: Scaffold(
        appBar: AppBar(
          title: const Text('YouTube Player Example'),
        ),
        body: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ////
            YoutubePlayerEmbed(
              key: ValueKey(currentPlayingVideo), // Unique key for the video (optional)
              callBackVideoController: (controller) {
                videoController = controller;
              },
              videoId:
                  currentPlayingVideo, // 'shorts_video_id' Replace with a YouTube Shorts or normal video ID
              customVideoTitle: "بسم الله الرحمن الرحيم",
              autoPlay: false,
              hidenVideoControls: false,
              mute: false,
              enabledShareButton: false,
              hidenChannelImage: true,
              aspectRatio: 16 / 9,
              onVideoEnd: () {
                print("video ended");
              },
              onVideoSeek: (currentTime) =>
                  print("Seeked to $currentTime seconds"),
              onVideoTimeUpdate: (currentTime) =>
                  print("Current time: $currentTime seconds"),
              onVideoStateChange: (state) {
                switch (state) {
                  case VideoState.playing:
                    print("Video is playing");
                    break;
                  case VideoState.paused:
                    print("Video is paused");
                    break;
                  case VideoState.muted:
                    print("Video is muted");
                    break;
                  case VideoState.unmuted:
                    print("Video is unmuted");
                    break;
                  case VideoState.fullscreen:
                    print("Video is in fullscreen");
                    break;
                  case VideoState.normalView:
                    print("Video is in normal view");
                    break;
                }
              },
            ),
            ////
            const SizedBox(height: 100),
            ////
            Row(
              mainAxisAlignment: MainAxisAlignment.spaceEvenly,
              children: [
                ////
                ElevatedButton(
                  onPressed: () async {
                    await videoController?.playVideo();
                  },
                  child: const Text("Play"),
                ),
                ////
                ElevatedButton(
                  onPressed: () async {
                    await videoController?.pauseVideo();
                  },
                  child: const Text("pause"),
                ),
                ////
                ElevatedButton(
                  onPressed: () async {
                    await videoController?.muteOrUnmuteVideo();
                  },
                  child: const Text("mute / unmute"),
                ),
                ////
              ],
            ),
            ////
            const SizedBox(height: 50),
            ////
            ElevatedButton(
              onPressed: () async {
                await videoController?.seekTo(
                  time: 4,
                );
              },
              child: const Text("seek to 4 seconed (for test)"),
            ),
            ////
          ],
        ),
      ),
    );
  }
}

Example Project

A complete example project is available in the example directory.

To run the example:

cd example
flutter run

API Reference

YoutubePlayerView
Property Type Default Description
videoId String Required The YouTube video ID to embed.
aspectRatio double null Aspect ratio of the video.
enabledShareButton bool false Enable or disable the share button.
autoPlay bool true Whether the video should autoplay upon loading.
mute bool false Whether the video should be muted by default.
onVideoEnd VoidCallback? null Callback triggered when the video ends.
onVideoSeek Function(double)? null Callback triggered when the video seek occurs.
onVideoTimeUpdate Function(double)? null Callback triggered on video time updates.
onVideoStateChange Function(VideoState)? null Callback triggered on video state changes (play/pause/etc).
customVideoTitle String? null Custom title for the video displayed on top.
hidenVideoControls bool false Whether to hide the video controls.
hidenChannelImage bool true Whether to hide the channel image.

Supported Platforms

  • ✅ Android
  • ✅ iOS
  • ✅ Web (with limitations)
  • ✅ Desktop

Setup

Android Setup

Ensure you have added the following permissions in your AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
iOS Setup

To ensure proper functionality on iOS, follow these steps:

  1. Update the Info.plist
    Add the following permissions in your Info.plist file:

     <key>NSAppTransportSecurity</key>
     <dict>
       <key>NSAllowsArbitraryLoads</key>
       <true/>
     </dict>
     <key>io.flutter.embedded_views_preview</key>
     <true/>
    

If you still have this problem, try to edit iOS Podfile like this

  1. Edit the Podfile
    Add the following to your iOS Podfile if you encounter issues:

    target 'Runner' do
      use_frameworks!  # required by flutter_inappwebview
      ...
    end
    
    post_install do |installer|
      installer.pods_project.targets.each do |target|
        target.build_configurations.each do |config|
          config.build_settings['SWIFT_VERSION'] = '5.0'  # required by flutter_inappwebview
          config.build_settings['ENABLE_BITCODE'] = 'NO'
        end
      end
    end
    

Changelog

v1.6.4
  • Added programmatic playback controls: Play, Pause, Seek, Mute, Unmute.
  • Added support for custom video titles.
  • Enhanced dynamic hiding of video controls and channel images.
  • Improved error handling for invalid video IDs.
  • Added advanced event listeners for video state, time updates, and seek events.
  • Added mute/unmute detection.
  • Improved support for dynamic UI updates to remove share and branding buttons.
  • Enhanced full-screen entry and exit handling.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests on the GitHub repository.


License

This project is licensed under the MIT License. See the LICENSE file for details.


Author

Developed by Mohamed Elsafty.
Feel free to reach out for support or feedback!


Feedback & Support

If you encounter any issues or have suggestions for improvement, please open an issue on GitHub or contact me at nesr107@gmail.com.

所屬分類

依賴

依賴清單 1 項

原始碼儲存庫

使用此套件的專案

暫無相關資料。