Browse Source

add packages detail in readme

Taner Sener 7 năm trước cách đây
mục cha
commit
de4423ecbe
2 tập tin đã thay đổi với 74 bổ sung0 xóa
  1. 9 0
      README.md
  2. 65 0
      example/README.md

+ 9 - 0
README.md

@@ -69,10 +69,19 @@ Add `flutter_ffmpeg` as a [dependency in your pubspec.yaml file](https://flutter
 Default installation of `FlutterFFmpeg` enables the default package, which is based on `https` package. It is possible
 to enable other installed packages using the following steps.
 
+1. Use the following dependency block in your `pubspec.yaml` file.
     ```
+    dependencies:
+      flutter_ffmpeg:
+        git:
+          url: git://github.com/tanersener/flutter-ffmpeg.git
+          ref: master
+          path: packages/flutter_ffmpeg_https
 
     ```
 
+2. Set package name in `path: packages/flutter_ffmpeg_<package name>` section.  
+
 ### 3. Using
 
 1. Execute commands.

+ 65 - 0
example/README.md

@@ -3,3 +3,68 @@
 Demonstrates how to use the flutter_ffmpeg plugin.
 
 ## Getting Started
+
+1. Execute commands.
+    ```
+    import 'package:flutter_ffmpeg/flutter_ffmpeg.dart';
+
+    final FlutterFFmpeg _flutterFFmpeg = new FlutterFFmpeg();
+
+    _flutterFFmpeg.execute("-i file1.mp4 -c:v mpeg4 file2.mp4").then((rc) => print("FFmpeg process exited with rc $rc"));
+    ```
+
+2. Check execution output.
+    ```
+    _flutterFFmpeg.getLastReturnCode().then((rc) => print("Last rc: $rc"));
+    _flutterFFmpeg.getLastCommandOutput().then((output) => print("Last command output: $output"));
+    ```
+
+3. Stop an ongoing operation.
+    ```
+    _flutterFFmpeg.cancel();
+    ```
+
+4. Get media information for a file.
+    ```
+    _flutterFFmpeg.getMediaInformation('<file path or uri>').then((info) => print(info));
+    ```
+
+5. List enabled external libraries.
+    ```
+    _flutterFFmpeg.getExternalLibraries().then((packageList) {
+         packageList.forEach((value) => print("External library: $value"));
+    });
+    ```
+
+6. Enable log callback.
+    ```
+    void logCallback(int level, String message) {
+        print(message);
+    }
+    ...
+    _flutterFFmpeg.enableLogCallback(this.logCallback);
+    ```
+
+7. Enable statistics callback.
+    ```
+    void statisticsCallback(int time, int size, double bitrate, double speed, int videoFrameNumber, double videoQuality, double videoFps) {
+        print("Statistics: time: $time, size: $size, bitrate: $bitrate, speed: $speed, videoFrameNumber: $videoFrameNumber, videoQuality: $videoQuality, videoFps: $videoFps");
+    }
+    ...
+    _flutterFFmpeg.enableStatisticsCallback(this.statisticsCallback);
+    ```
+
+8. Get last received statistics.
+    ```
+    _flutterFFmpeg.getLastReceivedStatistics().then((stats) => print(stats));
+    ```
+
+9. Set log level.
+    ```
+    _flutterFFmpeg.setLogLevel(LogLevel.AV_LOG_WARNING);
+    ```
+
+10. Register custom fonts directory.
+    ```
+    _flutterFFmpeg.setFontDirectory("<folder with fonts>");
+    ```