bravobit / FFmpeg-Android

FFMpeg/FFprobe compiled for Android
https://bravobit.nl/
MIT License
734 stars 172 forks source link

Readme should directly mention that isSupported installs the binary. #99

Open mc-lovin opened 5 years ago

mc-lovin commented 5 years ago
Check if FFmpeg is supported
To check whether FFmpeg is available on your device you can use the following method.

if (FFmpeg.getInstance(this).isSupported()) {
  // ffmpeg is supported
} else {
  // ffmpeg is not supported
}
This is all you have to do to load the FFmpeg library.

The name isSupported is a little confusing, I think the function should be renamed to something like loadBinaryIfSupported

Also we should change the first line of this function doc which is Check if FFmpeg is supported... to tell that doing this is necessary to load the binary.

I realize that it is written in the last line of the function doc but I think it should be moved up to the first line.

Thanks!