Skip to content

Commit bf08516

Browse files
committed
Update api doc
1 parent f16337a commit bf08516

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

docs/api.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
- [ffmpeg.load](#ffmpeg-load)
55
- [ffmpeg.run](#ffmpeg-run)
66
- [ffmpeg.FS](#ffmpeg-fs)
7+
- [ffmpeg.setLogging](#ffmpeg-setlogging)
8+
- [ffmpeg.setLogger](#ffmpeg-setlogger)
9+
- [ffmpeg.setProgress](#ffmpeg-setProgress)
710

811
---
912

@@ -93,3 +96,66 @@ ffmpeg.FS('readFile', 'video.mp4');
9396
/* Delete file in MEMFS */
9497
ffmpeg.FS('unlink', 'video.mp4');
9598
```
99+
100+
<a name="ffmpeg-setlogging"></a>
101+
102+
### ffmpeg.setLogging(logging)
103+
104+
Control whether to output log information to console
105+
106+
**Arguments**
107+
108+
- `logging` a boolean to turn of/off log messages in console
109+
110+
**Examples:**
111+
112+
```javascript
113+
ffmpeg.setLogging(true);
114+
```
115+
116+
<a name="ffmpeg-setlogger"></a>
117+
118+
### ffmpeg.setLogger(logger)
119+
120+
Set customer logger to get ffmpeg.wasm output messages.
121+
122+
**Arguments**
123+
124+
- `logger` a function to handle the messages
125+
126+
**Examples:**
127+
128+
```javascript
129+
ffmpeg.setLogger(({ type, message }) => {
130+
console.log(type, message);
131+
/*
132+
* type can be one of following:
133+
*
134+
* info: internal workflow debug messages
135+
* fferr: ffmpeg native stderr output
136+
* ffout: ffmpeg native stdout output
137+
*/
138+
});
139+
```
140+
141+
<a name="ffmpeg-setprogress"></a>
142+
143+
### ffmpeg.setProgress(progress)
144+
145+
Progress handler to get current progress of ffmpeg command.
146+
147+
**Arguments**
148+
149+
- `progress` a function to handle progress info
150+
151+
**Examples:**
152+
153+
```javascript
154+
155+
ffmpeg.setProgress(({ ratio }) => {
156+
console.log(ratio);
157+
/*
158+
* ratio is a float number between 0 to 1.
159+
*/
160+
});
161+
```

0 commit comments

Comments
 (0)