Skip to content

Commit 8ad7162

Browse files
authored
Add macOS documentation and other goodies (#131)
1 parent e9291af commit 8ad7162

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
<h1 align="center"><a href="https://github.com/alexmercerind/dart_vlc">dart_vlc</a></h1>
2+
3+
[![pub package](https://img.shields.io/pub/v/dart_vlc.svg)](https://pub.dartlang.org/packages/dart_vlc)
4+
![CI/CD](https://github.com/alexmercerind/dart_vlc/actions/workflows/ci.yml/badge.svg?branch=master)
5+
26
<h4 align="center">Flutter media playback, broadcast, recording & chromecast library for Windows, Linux & macOS.</h4>
37
<h5 align="center">Written in C++ using libVLC & libVLC++.</h5>
48

@@ -21,12 +25,12 @@ dependencies:
2125
```yaml
2226
dependencies:
2327
...
24-
dart_vlc_ffi: ^0.1.2
28+
dart_vlc_ffi: ^0.1.3
2529
```
2630
2731
More on Dart CLI implementation [here](./ffi/README.md).
2832
29-
Feel free to open issue, incase you find something to be not working.
33+
Feel free to open a [new issue](https://github.com/alexmercerind/dart_vlc/issues) or [discussion](https://github.com/alexmercerind/dart_vlc/discussions), if you found a bug or need assistance.
3034
3135
## Support
3236
@@ -67,7 +71,11 @@ Media media0 = Media.file(
6771
File('C:/music.mp3')
6872
);
6973
70-
Media media1 = Media.network(
74+
Media media1 = Media.asset(
75+
'assets/audio/example.mp3'
76+
);
77+
78+
Media media2 = Media.network(
7179
'https://www.example.com/music.aac'
7280
);
7381
```
@@ -78,6 +86,7 @@ Playlist playlist = new Playlist(
7886
medias: [
7987
Media.file(File('C:/music.mp3')),
8088
Media.file(File('C:/audio.mp3')),
89+
Media.asset('assets/audio/example.mp3'),
8190
Media.network('https://www.example.com/music.aac'),
8291
],
8392
);
@@ -332,6 +341,14 @@ record.start();
332341

333342
Everything is already set up.
334343

344+
## macOS
345+
346+
To run on macOS, install CMake through [Homebrew](https://brew.sh):
347+
348+
```bash
349+
brew install cmake
350+
```
351+
335352
### Linux
336353

337354
For using this plugin on Linux, you must have [VLC](https://www.videolan.org) & [libVLC](https://www.videolan.org/vlc/libvlc.html) installed.
@@ -451,7 +468,7 @@ Thanks to following members of libVLC community (irrespective of the order) for
451468

452469
## Contributions
453470

454-
The code in the project is nicely arranged (I guess), I have added comments wherever I felt necessary.
471+
The code in the project is nicely arranged and follows the clean architecture.
455472

456473
Contributions to the project are open, it will be appreciated if you discuss the bug-fix/feature-addition in the issues first.
457474

pubspec.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ documentation: https://github.com/alexmercerind/dart_vlc/blob/master/README.md
77

88
environment:
99
sdk: ">=2.12.0 <3.0.0"
10-
flutter: ">=1.20.0"
10+
flutter: ">=1.22.0"
1111

1212
dependencies:
1313
flutter:
1414
sdk: flutter
15-
dart_vlc_ffi: ^0.1.3
16-
path: ^1.8.0
17-
path_provider: ^2.0.1
18-
audio_video_progress_bar: ^0.4.0
15+
dart_vlc_ffi: ">=0.1.3 <1.0.0"
16+
path: ">=1.8.0 <2.0.0"
17+
path_provider: ">=2.0.2 <3.0.0"
18+
audio_video_progress_bar: ">=0.9.0 <1.0.0"
1919

2020
flutter:
2121
# No platform channel implementation after migration to FFI.

0 commit comments

Comments
 (0)