Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README #731

Merged
merged 1 commit into from
Jul 2, 2023
Merged

Improve README #731

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 21 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ The [`video_player`](https://pub.dartlang.org/packages/video_player) plugin prov

## Installation

In your `pubspec.yaml` file within your Flutter Project:
In your `pubspec.yaml` file within your Flutter Project add `chewie` and `video_player` under dependencies:

```yaml
dependencies:
chewie: <latest_version>
video_player: <latest_version>
```

## Use it
## Using it

```dart
import 'package:chewie/chewie.dart';
Expand All @@ -46,7 +46,7 @@ final playerWidget = Chewie(
);
```

Please make sure to dispose both controller widgets after use. For example by overriding the dispose method of the a `StatefulWidget`:
Please make sure to dispose both controller widgets after use. For example, by overriding the dispose method of the a `StatefulWidget`:
```dart
@override
void dispose() {
Expand All @@ -60,9 +60,9 @@ void dispose() {

![](https://github.com/brianegan/chewie/raw/master/assets/Options.png)

Chewie got some options which controls the video you provide. These options appear on default on a `showModalBottomSheet` (like you already know from YT maybe). Chewie is passing on default `Playback speed` and `Subtitles` options as an `OptionItem`.
Chewie has some options which control the video. These options appear by default in a `showModalBottomSheet` (similar to YT). By default, Chewie passes `Playback speed` and `Subtitles` options as an `OptionItem`.

To add additional options just add these lines to your `ChewieController`:
To add additional options, just add these lines to your `ChewieController`:

```dart
additionalOptions: (context) {
Expand All @@ -74,15 +74,17 @@ additionalOptions: (context) {
),
OptionItem(
onTap: () =>
debugPrint('Another option working!'),
debugPrint('Another option that works!'),
iconData: Icons.chat,
title: 'Another localized title',
),
];
},
```

If you don't like to show your options with the default `showModalBottomSheet` just override the View with the `optionsBuilder` method:
### Customizing the modal sheet

If you don't like the default `showModalBottomSheet` for showing your options, you can override the View with the `optionsBuilder` method:

```dart
optionsBuilder: (context, defaultOptions) async {
Expand All @@ -106,7 +108,11 @@ optionsBuilder: (context, defaultOptions) async {

Your `additionalOptions` are already included here (if you provided `additionalOptions`)!

Last but not least: What is an option without proper translation. To add your strings to them just add:
### Translations

What is an option without proper translation?

To add your translation strings add:

```dart
optionsTranslation: OptionsTranslation(
Expand All @@ -118,11 +124,11 @@ optionsTranslation: OptionsTranslation(

## Subtitles

> Since version 1.1.0 chewie supports subtitles. Here you can see how to use them
> Since version 1.1.0 chewie supports subtitles. Here you can see how to use them.

You can provide an `List<Subtitle>` and customize your subtitles with the `subtitleBuilder` function.

Just add subtitles as following code is showing into your `ChewieController`:
Add subtitles to your `ChewieController` like the following example:

```dart
ChewieController(
Expand Down Expand Up @@ -153,9 +159,9 @@ ChewieController(
);
```

The `index` attribute is just for purpases if you want to structure your subtitles in your database and provide your indexes here. `start`, `end` and `text` are here the key attributes.
The `index` attribute is for if you want to structure your subtitles in your database and provide your indexes here. `end` and `text` are the key attributes.

The Duration defines on which part of your video your subtitles should start and end. For example: Your video is 10 minutes long and you want to add a subtitle between: `00:00` and `00:10`'th second you've to provide:
The Duration defines which part of your video your subtitles should start and end. For example, if your video is 10 minutes long and you want to add a subtitle between: `00:00` and `00:10`'th of a second:

```dart
Subtitle(
Expand All @@ -171,7 +177,8 @@ Subtitle(
Please run the app in the [`example/`](https://github.com/brianegan/chewie/tree/master/example) folder to start playing!

## Migrating from Chewie < 0.9.0
Instead of passing the `VideoPlayerController` and your options to the `Chewie` widget you now pass them to the `ChewieController` and pass that latter to the `Chewie` widget.

Instead of passing the `VideoPlayerController` and your options to the `Chewie` widget you now pass them to the `ChewieController` and pass that later to the `Chewie` widget.

```dart
final playerWidget = Chewie(
Expand Down Expand Up @@ -222,6 +229,7 @@ final playerWidget = Chewie(


## iOS warning

The video_player plugin used by chewie will only work in iOS simulators if you are on flutter 1.26.0 or above. You may need to switch to the beta channel `flutter channel beta`
Please refer to this [issue](https://github.com/flutter/flutter/issues/14647).

Expand Down