From bf58a0d6cbbb5f93360395c6ad97805e4c96fa0e Mon Sep 17 00:00:00 2001 From: Ben Hagen Date: Mon, 21 Jan 2019 17:56:01 +0100 Subject: [PATCH] Add documentation --- lib/src/chewie_controller.dart | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/lib/src/chewie_controller.dart b/lib/src/chewie_controller.dart index 042ec3d64..dae372530 100644 --- a/lib/src/chewie_controller.dart +++ b/lib/src/chewie_controller.dart @@ -2,6 +2,16 @@ import 'package:chewie/src/chewie_progress_colors.dart'; import 'package:flutter/material.dart'; import 'package:video_player/video_player.dart'; +/// The ChewieController is used to configure and drive the Chewie Player +/// Widgets. It provides methods to control playback, such as [pause] and +/// [play], as well as methods that control the visual appearance of the player, +/// such as [enterFullScreen] or [exitFullScreen]. +/// +/// In addition, you can listen to the ChewieController for presentational +/// changes, such as entering and exiting full screen mode. To listen for +/// changes to the playback, such as a change to the seek position of the +/// player, please use the standard information provided by the +/// `VideoPlayerController`. class ChewieController extends ChangeNotifier { ChewieController({ this.videoPlayerController,