Skip to content

Commit c5e9c41

Browse files
alexmercerindalexmercerind
authored
Update README
1 parent 9ce4f4b commit c5e9c41

File tree

1 file changed

+60
-27
lines changed

1 file changed

+60
-27
lines changed

‎README.md‎

Lines changed: 60 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
1-
<h1 align='center'><a href='https://github.com/alexmercerind/flutter_media_metadata'>flutter_media_metadata</a></h1>
2-
<h4 align='center'>A Flutter plugin to read metadata of media files.</h4>
3-
<h5 align='center'>A part of <a href='https://github.com/alexmercerind/harmonoid'>Harmonoid</a> open source project 💜</h5>
4-
<br></br>
5-
<p align='center'><img src='https://github.com/alexmercerind/flutter_media_metadata/blob/assets/linux_active.png?raw=true' height='500'></img></p>
1+
# [flutter_media_metadata](https://github.com/alexmercerind/flutter_media_metadata)
2+
#### A Flutter plugin to read 🔖 metadata of 🎵 media files.
63

74
## Install
85

@@ -11,15 +8,27 @@ Add in your `pubspec.yaml`.
118
```yaml
129
dependencies:
1310
...
14-
flutter_media_metadata: ^0.1.2
11+
flutter_media_metadata: ^1.0.0
1512
```
1613
17-
Issues are maintained [here](https://github.com/alexmercerind/harmonoid).
14+
<img width="649" src="https://user-images.githubusercontent.com/28951144/151707391-a59bd40a-5303-4dd8-af35-ff8918894dbb.png">
1815
19-
## Example
16+
_Example app running on Windows._
17+
18+
## Support
19+
20+
[![Support via PayPal](https://cdn.rawgit.com/twolfson/paypal-github-button/1.0.0/dist/button.svg)](https://www.paypal.me/alexmercerind)
21+
22+
<a href="https://www.buymeacoffee.com/alexmercerind" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
23+
24+
Please consider buying me a coffee if you like the plugin.
25+
26+
## Documentation
27+
28+
#### Windows, Linux, macOS, Android & iOS
2029
2130
```dart
22-
var metadata = await MetadataRetriever.fromFile(File('C:/Users/Alex/Music/SampleMusic.OGG'))
31+
final metadata = await MetadataRetriever.fromFile(File(filePath));
2332

2433
String? trackName = metadata.trackName;
2534
List<String>? trackArtistNames = metadata.trackArtistNames;
@@ -38,26 +47,50 @@ int? bitrate = metadata.bitrate;
3847
Uint8List? albumArt = metadata.albumArt;
3948
```
4049

50+
#### Web
51+
52+
For using the plugin on web, add following line to your `index.html`.
53+
54+
```diff
55+
<link rel="manifest" href="manifest.json">
56+
</head>
57+
<body>
58+
+ <script type="text/javascript" src="https://unpkg.com/mediainfo.js/dist/mediainfo.min.js"></script>
59+
<!-- This script installs service_worker.js to provide PWA functionality to
60+
application. For more information, see:
61+
https://developers.google.com/web/fundamentals/primers/service-workers -->
62+
<script>
63+
var serviceWorkerVersion = null;
64+
var scriptLoaded = false;
65+
```
66+
67+
And use `MetadataRetriever.fromBytes` instead of `MetadataRetriever.fromFile`.
68+
69+
4170
## Platforms
4271

43-
|Platform|Status |Author/Maintainer |
44-
|--------|---------------|--------------------------------------------------------------|
45-
|Windows |Working |[Hitesh Kumar Saini](https://github.com/alexmercerind) |
46-
|Linux |Working |[Hitesh Kumar Saini](https://github.com/alexmercerind) |
47-
|Android |Working |[Hitesh Kumar Saini](https://github.com/alexmercerind) |
48-
|iOS |Working |[@DiscombobulatedDrag](https://github.com/DiscombobulatedDrag)|
49-
|MacOS |Not Working |[N/A](#) |
50-
51-
<table>
52-
<tr>
53-
<td>
54-
<img src='https://github.com/alexmercerind/flutter_media_metadata/blob/assets/android.png?raw=true' height='500'></img>
55-
</td>
56-
<td>
57-
<img src='https://github.com/alexmercerind/flutter_media_metadata/blob/assets/windows_active.png?raw=true' height='500'></img>
58-
</td>
59-
</tr>
60-
</table>
72+
|Platform|Status |Author/Maintainer |
73+
|--------|---------|--------------------------------------------------------------|
74+
|Windows |✔️ |[Hitesh Kumar Saini](https://github.com/alexmercerind) |
75+
|Linux |✔️ |[Hitesh Kumar Saini](https://github.com/alexmercerind) |
76+
|Android |✔️ |[Hitesh Kumar Saini](https://github.com/alexmercerind) |
77+
|Web |✔️ |[Hitesh Kumar Saini](https://github.com/alexmercerind) |
78+
|MacOS |✔️ |[@DiscombobulatedDrag](https://github.com/DiscombobulatedDrag)|
79+
|iOS |✔️ |[@DiscombobulatedDrag](https://github.com/DiscombobulatedDrag)|
80+
81+
82+
<img width="555" src="https://user-images.githubusercontent.com/28951144/151707427-76d75f04-9efe-4b1d-80fb-fdeea73dad26.png">
83+
84+
_Example app running on Web._
85+
86+
<img width="200" src="https://user-images.githubusercontent.com/28951144/151707533-198ba2ca-d646-4bc4-811b-928f65ee03ea.png">
87+
88+
_Example app running on Android._
89+
90+
<img width="555" src="https://user-images.githubusercontent.com/28951144/151707526-319ca3f5-9849-4d57-8ea4-9595ee67e99c.png">
91+
92+
_Example app running on Linux._
93+
6194

6295
## License
6396

0 commit comments

Comments
 (0)