Skip to content

Commit 8f50bd3

Browse files
jeromewujeromewu
committed
Fix api docs
1 parent 86619e2 commit 8f50bd3

File tree

6 files changed

+103
-82
lines changed

6 files changed

+103
-82
lines changed

‎apps/website/docs/migration.md

Lines changed: 38 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import MuiThemeProvider from "@site/src/components/common/MuiThemeProvider";
12
import Table from '@mui/material/Table';
23
import TableBody from '@mui/material/TableBody';
34
import TableCell from '@mui/material/TableCell';
@@ -11,38 +12,40 @@ import Paper from '@mui/material/Paper';
1112
As 0.12+ is not backward compatible with 0.11.x, below is a quick mapping
1213
table to transform 0.11.x to 0.12+
1314

14-
<TableContainer>
15-
<Table sx={{ minWidth: 650 }} aria-label="simple table">
16-
<TableHead>
17-
<TableRow>
18-
<TableCell align="center">0.11.x</TableCell>
19-
<TableCell align="center">0.12+</TableCell>
20-
<TableCell align="center">Note</TableCell>
21-
</TableRow>
22-
</TableHead>
23-
<TableBody>
24-
{[
25-
{"0.11.x": "import { createFFmpeg } from '@ffmpeg/ffmpeg'", "0.12+": "import { FFmpeg } from '@ffmpeg/ffmpeg'", note: ""},
26-
{"0.11.x": "createFFmpeg()", "0.12+": "new FFmpeg()", note: "argumens of createFFmpeg() is moved to ffmpeg.load()"},
27-
{"0.11.x": "await ffmpeg.load()", "0.12+": "await ffmpeg.load()", note: ""},
28-
{"0.11.x": "await ffmpeg.run(...args)", "0.12+": "await ffmpeg.exec([...args])", note: ""},
29-
{"0.11.x": "ffmpeg.FS.writeFile()", "0.12+": "await ffmpeg.writeFile()", note: ""},
30-
{"0.11.x": "ffmpeg.FS.readFile()", "0.12+": "await ffmpeg.readFile()", note: ""},
31-
{"0.11.x": "ffmpeg.exit()", "0.12+": "await ffmpeg.terminate()", note: ""},
32-
{"0.11.x": "ffmpeg.setLogger()", "0.12+": "ffmpeg.on(\"log\", () => {})", note: ""},
33-
{"0.11.x": "ffmpeg.setProgress()", "0.12+": "ffmpeg.on(\"progress\", () => {})", note: ""},
34-
{"0.11.x": "import { fetchFile } from '@ffmpeg/ffmpeg'", "0.12+": "import { fetchFile } from '@ffmpeg/util'", note: ""},
35-
].map((row) => (
36-
<TableRow
37-
key={row['0.11.x']}
38-
>
39-
<TableCell component="th" scope="row">
40-
{row['0.11.x']}
41-
</TableCell>
42-
<TableCell align="left">{row['0.12+']}</TableCell>
43-
<TableCell align="left">{row.note}</TableCell>
44-
</TableRow>
45-
))}
46-
</TableBody>
47-
</Table>
48-
</TableContainer>
15+
<MuiThemeProvider>
16+
<TableContainer>
17+
<Table sx={{ minWidth: 650 }} aria-label="simple table">
18+
<TableHead>
19+
<TableRow>
20+
<TableCell align="center">0.11.x</TableCell>
21+
<TableCell align="center">0.12+</TableCell>
22+
<TableCell align="center">Note</TableCell>
23+
</TableRow>
24+
</TableHead>
25+
<TableBody>
26+
{[
27+
{"0.11.x": "import { createFFmpeg } from '@ffmpeg/ffmpeg'", "0.12+": "import { FFmpeg } from '@ffmpeg/ffmpeg'", note: ""},
28+
{"0.11.x": "createFFmpeg()", "0.12+": "new FFmpeg()", note: "argumens of createFFmpeg() is moved to ffmpeg.load()"},
29+
{"0.11.x": "await ffmpeg.load()", "0.12+": "await ffmpeg.load()", note: ""},
30+
{"0.11.x": "await ffmpeg.run(...args)", "0.12+": "await ffmpeg.exec([...args])", note: ""},
31+
{"0.11.x": "ffmpeg.FS.writeFile()", "0.12+": "await ffmpeg.writeFile()", note: ""},
32+
{"0.11.x": "ffmpeg.FS.readFile()", "0.12+": "await ffmpeg.readFile()", note: ""},
33+
{"0.11.x": "ffmpeg.exit()", "0.12+": "await ffmpeg.terminate()", note: ""},
34+
{"0.11.x": "ffmpeg.setLogger()", "0.12+": "ffmpeg.on(\"log\", () => {})", note: ""},
35+
{"0.11.x": "ffmpeg.setProgress()", "0.12+": "ffmpeg.on(\"progress\", () => {})", note: ""},
36+
{"0.11.x": "import { fetchFile } from '@ffmpeg/ffmpeg'", "0.12+": "import { fetchFile } from '@ffmpeg/util'", note: ""},
37+
].map((row) => (
38+
<TableRow
39+
key={row['0.11.x']}
40+
>
41+
<TableCell component="th" scope="row">
42+
{row['0.11.x']}
43+
</TableCell>
44+
<TableCell align="left">{row['0.12+']}</TableCell>
45+
<TableCell align="left">{row.note}</TableCell>
46+
</TableRow>
47+
))}
48+
</TableBody>
49+
</Table>
50+
</TableContainer>
51+
</MuiThemeProvider>

‎apps/website/docs/overview.md

Lines changed: 44 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import MuiThemeProvider from "@site/src/components/common/MuiThemeProvider";
12
import Table from '@mui/material/Table';
23
import TableBody from '@mui/material/TableBody';
34
import TableCell from '@mui/material/TableCell';
@@ -49,44 +50,46 @@ be spawned by `ffmpeg-core` inside `ffmpeg.worker`
4950

5051
ffmpeg.wasm is built with toolchains / libraries:
5152

52-
<TableContainer>
53-
<Table sx={{ minWidth: 650 }} aria-label="simple table">
54-
<TableHead>
55-
<TableRow>
56-
<TableCell align="center">Name</TableCell>
57-
<TableCell align="center">Version</TableCell>
58-
<TableCell align="center">Note</TableCell>
59-
</TableRow>
60-
</TableHead>
61-
<TableBody>
62-
{[
63-
{name: "Emscripten", version: "3.1.40", note: ""},
64-
{name: "FFmpeg", version: "n5.1.3", note: ""},
65-
{name: "x264", version: "0.164.x", note: ""},
66-
{name: "x265", version: "3.4", note: ""},
67-
{name: "libvpx", version: "v1.9.0", note: ""},
68-
{name: "lame", version: "3.100", note: ""},
69-
{name: "ogg", version: "v1.3.4", note: ""},
70-
{name: "theora", version: "v1.1.1", note: ""},
71-
{name: "opus", version: "v1.3.1", note: ""},
72-
{name: "vorbis", version: "v1.3.3", note: ""},
73-
{name: "zlib", version: "v1.2.11", note: ""},
74-
{name: "libwebp", version: "v1.1.0", note: ""},
75-
{name: "freetype2", version: "v2.10.4", note: ""},
76-
{name: "fribidi", version: "v1.0.9", note: ""},
77-
{name: "harfbuzz", version: "5.2.0", note: ""},
78-
{name: "libass", version: "0.15.0", note: ""},
79-
].map((row) => (
80-
<TableRow
81-
key={row.name}
82-
>
83-
<TableCell component="th" scope="row">
84-
{row.name}
85-
</TableCell>
86-
<TableCell align="center">{row.version}</TableCell>
87-
<TableCell align="center">{row.note}</TableCell>
88-
</TableRow>
89-
))}
90-
</TableBody>
91-
</Table>
92-
</TableContainer>
53+
<MuiThemeProvider>
54+
<TableContainer>
55+
<Table sx={{ minWidth: 650 }} aria-label="simple table">
56+
<TableHead>
57+
<TableRow>
58+
<TableCell align="center">Name</TableCell>
59+
<TableCell align="center">Version</TableCell>
60+
<TableCell align="center">Note</TableCell>
61+
</TableRow>
62+
</TableHead>
63+
<TableBody>
64+
{[
65+
{name: "Emscripten", version: "3.1.40", note: ""},
66+
{name: "FFmpeg", version: "n5.1.3", note: ""},
67+
{name: "x264", version: "0.164.x", note: ""},
68+
{name: "x265", version: "3.4", note: ""},
69+
{name: "libvpx", version: "v1.9.0", note: ""},
70+
{name: "lame", version: "3.100", note: ""},
71+
{name: "ogg", version: "v1.3.4", note: ""},
72+
{name: "theora", version: "v1.1.1", note: ""},
73+
{name: "opus", version: "v1.3.1", note: ""},
74+
{name: "vorbis", version: "v1.3.3", note: ""},
75+
{name: "zlib", version: "v1.2.11", note: ""},
76+
{name: "libwebp", version: "v1.1.0", note: ""},
77+
{name: "freetype2", version: "v2.10.4", note: ""},
78+
{name: "fribidi", version: "v1.0.9", note: ""},
79+
{name: "harfbuzz", version: "5.2.0", note: ""},
80+
{name: "libass", version: "0.15.0", note: ""},
81+
].map((row) => (
82+
<TableRow
83+
key={row.name}
84+
>
85+
<TableCell component="th" scope="row">
86+
{row.name}
87+
</TableCell>
88+
<TableCell align="left">{row.version}</TableCell>
89+
<TableCell align="left">{row.note}</TableCell>
90+
</TableRow>
91+
))}
92+
</TableBody>
93+
</Table>
94+
</TableContainer>
95+
</MuiThemeProvider>

‎apps/website/docusaurus.config.js

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,27 @@ const config = {
135135
[
136136
"docusaurus-plugin-typedoc",
137137
{
138+
id: "ffmpeg",
138139
entryPoints: ["../../packages/ffmpeg/src/index.ts"],
139140
tsconfig: "../../packages/ffmpeg/tsconfig.json",
140141
readme: "none",
142+
out: "api/ffmpeg",
141143
sidebar: {
144+
indexLabel: "@ffmpeg/ffmpeg",
145+
fullNames: true,
146+
},
147+
},
148+
],
149+
[
150+
"docusaurus-plugin-typedoc",
151+
{
152+
id: "util",
153+
entryPoints: ["../../packages/util/src/index.ts"],
154+
tsconfig: "../../packages/util/tsconfig.json",
155+
readme: "none",
156+
out: "api/util",
157+
sidebar: {
158+
indexLabel: "@ffmpeg/util",
142159
fullNames: true,
143160
},
144161
},

‎apps/website/sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ const sidebars = {
2929
{
3030
type: "category",
3131
label: "API",
32-
items: ["api/classes/FFmpeg"],
32+
items: ["api/ffmpeg/index", "api/util/index"],
3333
},
3434
{
3535
type: "category",

‎packages/ffmpeg/src/classes.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,6 @@ export class FFmpeg {
109109
* })
110110
* ```
111111
*
112-
* @remarks
113-
* log includes output to stdout and stderr.
114-
*
115112
* @example
116113
* ```ts
117114
* ffmpeg.on("progress", ({ progress, time }) => {
@@ -120,7 +117,8 @@ export class FFmpeg {
120117
* ```
121118
*
122119
* @remarks
123-
* The progress events are accurate only when the length of
120+
* - log includes output to stdout and stderr.
121+
* - The progress events are accurate only when the length of
124122
* input and output video/audio file are the same.
125123
*
126124
* @category FFmpeg

‎packages/util/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import {
55
import { HeaderContentLength } from "./const.js";
66
import { ProgressCallback } from "./types.js";
77

8-
export const readFromBlobOrFile = (blob: Blob | File): Promise<Uint8Array> =>
8+
const readFromBlobOrFile = (blob: Blob | File): Promise<Uint8Array> =>
99
new Promise((resolve, reject) => {
1010
const fileReader = new FileReader();
1111
fileReader.onload = () => {

0 commit comments

Comments
 (0)