Update api doc

This commit is contained in:
Jerome Wu 2020-11-03 21:53:14 +08:00
parent f8c1350139
commit 4522d36007

View File

@ -4,6 +4,9 @@
- [ffmpeg.load](#ffmpeg-load) - [ffmpeg.load](#ffmpeg-load)
- [ffmpeg.run](#ffmpeg-run) - [ffmpeg.run](#ffmpeg-run)
- [ffmpeg.FS](#ffmpeg-fs) - [ffmpeg.FS](#ffmpeg-fs)
- [ffmpeg.setLogging](#ffmpeg-setlogging)
- [ffmpeg.setLogger](#ffmpeg-setlogger)
- [ffmpeg.setProgress](#ffmpeg-setProgress)
--- ---
@ -93,3 +96,66 @@ ffmpeg.FS('readFile', 'video.mp4');
/* Delete file in MEMFS */ /* Delete file in MEMFS */
ffmpeg.FS('unlink', 'video.mp4'); ffmpeg.FS('unlink', 'video.mp4');
``` ```
<a name="ffmpeg-setlogging"></a>
### ffmpeg.setLogging(logging)
Control whether to output log information to console
**Arguments**
- `logging` a boolean to turn of/off log messages in console
**Examples:**
```javascript
ffmpeg.setLogging(true);
```
<a name="ffmpeg-setlogger"></a>
### ffmpeg.setLogger(logger)
Set customer logger to get ffmpeg.wasm output messages.
**Arguments**
- `logger` a function to handle the messages
**Examples:**
```javascript
ffmpeg.setLogger(({ type, message }) => {
console.log(type, message);
/*
* type can be one of following:
*
* info: internal workflow debug messages
* fferr: ffmpeg native stderr output
* ffout: ffmpeg native stdout output
*/
});
```
<a name="ffmpeg-setprogress"></a>
### ffmpeg.setProgress(progress)
Progress handler to get current progress of ffmpeg command.
**Arguments**
- `progress` a function to handle progress info
**Examples:**
```javascript
ffmpeg.setProgress(({ ratio }) => {
console.log(ratio);
/*
* ratio is a float number between 0 to 1.
*/
});
```