dumtruck/konowebcodecs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Ignore docs/api

Browse Source
This commit is contained in:
Jerome Wu 2022-10-08 09:32:41 +08:00
parent a23669e485
commit 0bd7c4375a
2 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
apps/website/.gitignore vendored
View File

@ -3,6 +3,7 @@
# Production # Production
/build /build
docs/api
# Generated files # Generated files
.docusaurus .docusaurus

46
apps/website/docs/api/classes/FFmpeg.md
View File

@ -28,7 +28,7 @@ const ffmpeg = new FFmpeg();
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:99](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L99) [packages/ffmpeg/src/classes.ts:99](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L99)
## Properties ## Properties
@ -38,7 +38,7 @@ const ffmpeg = new FFmpeg();
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:95](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L95) [packages/ffmpeg/src/classes.ts:95](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L95)
___ ___
@ -51,7 +51,7 @@ be called when we receive message from web worker.
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:94](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L94) [packages/ffmpeg/src/classes.ts:94](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L94)
___ ___
@ -61,7 +61,7 @@ ___
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:88](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L88) [packages/ffmpeg/src/classes.ts:88](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L88)
___ ___
@ -71,7 +71,7 @@ ___
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:97](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L97) [packages/ffmpeg/src/classes.ts:97](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L97)
___ ___
@ -131,7 +131,7 @@ node_modules/@types/node/events.d.ts:290
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:84](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L84) [packages/ffmpeg/src/classes.ts:84](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L84)
___ ___
@ -141,7 +141,7 @@ ___
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:85](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L85) [packages/ffmpeg/src/classes.ts:85](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L85)
___ ___
@ -151,7 +151,7 @@ ___
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:86](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L86) [packages/ffmpeg/src/classes.ts:86](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L86)
## Event Methods ## Event Methods
@ -182,7 +182,7 @@ ffmpeg.on(FFmpeg.DOWNLOAD, ({ url, total, received, delta, done }) => {
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:33](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L33) [packages/ffmpeg/src/classes.ts:33](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L33)
▸ **on**(`event`, `listener`): [`FFmpeg`](FFmpeg.md) ▸ **on**(`event`, `listener`): [`FFmpeg`](FFmpeg.md)
@ -213,7 +213,7 @@ log includes output to stdout and stderr.
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:52](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L52) [packages/ffmpeg/src/classes.ts:52](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L52)
▸ **on**(`event`, `listener`): [`FFmpeg`](FFmpeg.md) ▸ **on**(`event`, `listener`): [`FFmpeg`](FFmpeg.md)
@ -245,7 +245,7 @@ input and output video/audio file are the same.
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:69](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L69) [packages/ffmpeg/src/classes.ts:69](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L69)
___ ___
@ -288,7 +288,7 @@ const data = ffmpeg.readFile("video.mp4");
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:202](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L202) [packages/ffmpeg/src/classes.ts:202](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L202)
___ ___
@ -313,7 +313,7 @@ as it initializes WebAssembly and other essential variables.
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:171](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L171) [packages/ffmpeg/src/classes.ts:171](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L171)
___ ___
@ -330,7 +330,7 @@ Terminate all ongoing API calls and terminate web worker.
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:223](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L223) [packages/ffmpeg/src/classes.ts:223](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L223)
___ ___
@ -354,7 +354,7 @@ Create a directory.
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:321](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L321) [packages/ffmpeg/src/classes.ts:321](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L321)
___ ___
@ -376,7 +376,7 @@ Delete an empty directory.
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:343](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L343) [packages/ffmpeg/src/classes.ts:343](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L343)
___ ___
@ -398,7 +398,7 @@ Delete a file.
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:299](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L299) [packages/ffmpeg/src/classes.ts:299](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L299)
___ ___
@ -420,7 +420,7 @@ List directory contents.
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:332](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L332) [packages/ffmpeg/src/classes.ts:332](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L332)
___ ___
@ -451,7 +451,7 @@ const data = await ffmpeg.readFile("video.mp4");
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:278](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L278) [packages/ffmpeg/src/classes.ts:278](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L278)
___ ___
@ -474,7 +474,7 @@ Rename a file or directory.
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:310](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L310) [packages/ffmpeg/src/classes.ts:310](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L310)
___ ___
@ -506,7 +506,7 @@ await ffmpeg.writeFile("text.txt", "hello world");
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:252](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L252) [packages/ffmpeg/src/classes.ts:252](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L252)
___ ___
@ -524,7 +524,7 @@ register worker message event handlers.
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:106](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L106) [packages/ffmpeg/src/classes.ts:106](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L106)
___ ___
@ -547,7 +547,7 @@ Generic function to send messages to web worker.
#### Defined in #### Defined in
[packages/ffmpeg/src/classes.ts:148](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/4a950d7/packages/ffmpeg/src/classes.ts#L148) [packages/ffmpeg/src/classes.ts:148](https://github.com/ffmpegwasm/ffmpeg.wasm/blob/9cc991b/packages/ffmpeg/src/classes.ts#L148)
___ ___