Skip to content
This repository has been archived by the owner on Oct 14, 2021. It is now read-only.

provide brief overview of each package #159

Closed
bsutton opened this issue Jun 22, 2020 · 4 comments
Closed

provide brief overview of each package #159

bsutton opened this issue Jun 22, 2020 · 4 comments
Labels
enhancement New feature or request fixed

Comments

@bsutton
Copy link

bsutton commented Jun 22, 2020

The doco mentions a no. of optional packages.

It would be useful if the list includes a brief overview of what features each package provided and a link to the API doco for that package.

As someone looking for codec conversion and not being familiar with ffmpeg the doco doesn't give any guidance on where to start.

@ozburo
Copy link

ozburo commented Jun 22, 2020

FFmpeg has all the documentation regarding codecs and packages I would suggest going there for full info.

There wouldn't be must benefit of reproducing that here IMO as this package implies users have at least a working knowledge of FFmpeg.

@bsutton
Copy link
Author

bsutton commented Jun 23, 2020

My experience suggests otherwise.
I found flutter-ffmpeg when looking through pub.dev for a package that does transcoding.
I had no prior knowledge of ffmpeg except that I was vaguely aware that there was a program called ffmpeg.
I doubt that I will be the only potential user to have the same experience.

I'm not suggesting that you duplicate the ffmpeg doco, only that you provides some links to relevant parts so that someone like myself at least gets a running start at using the library.

@tanersener tanersener added the enhancement New feature or request label Jun 24, 2020
@ozburo
Copy link

ozburo commented Jun 25, 2020

@bsutton well, if you've never heard of ffmpeg and just came across it looking for a transcoding solution, I would say you'd be in the minority, but then again I'm probably showing my ignorance assuming everyone has heard of "FFmpeg".

By all means add as much doco as you want. Maybe a link to the ffmpeg.org website and documentation page(s) would suffice, something like firebase_ffmpeg and others do.

@github-actions
Copy link

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request fixed
Projects
None yet
Development

No branches or pull requests

3 participants