diff --git a/apps/website/docs/migration.md b/apps/website/docs/migration.md
index 5e6fcda..d8dfba3 100644
--- a/apps/website/docs/migration.md
+++ b/apps/website/docs/migration.md
@@ -1,3 +1,4 @@
+import MuiThemeProvider from "@site/src/components/common/MuiThemeProvider";
import Table from '@mui/material/Table';
import TableBody from '@mui/material/TableBody';
import TableCell from '@mui/material/TableCell';
@@ -11,38 +12,40 @@ import Paper from '@mui/material/Paper';
As 0.12+ is not backward compatible with 0.11.x, below is a quick mapping
table to transform 0.11.x to 0.12+
-
-
-
-
- 0.11.x
- 0.12+
- Note
-
-
-
- {[
- {"0.11.x": "import { createFFmpeg } from '@ffmpeg/ffmpeg'", "0.12+": "import { FFmpeg } from '@ffmpeg/ffmpeg'", note: ""},
- {"0.11.x": "createFFmpeg()", "0.12+": "new FFmpeg()", note: "argumens of createFFmpeg() is moved to ffmpeg.load()"},
- {"0.11.x": "await ffmpeg.load()", "0.12+": "await ffmpeg.load()", note: ""},
- {"0.11.x": "await ffmpeg.run(...args)", "0.12+": "await ffmpeg.exec([...args])", note: ""},
- {"0.11.x": "ffmpeg.FS.writeFile()", "0.12+": "await ffmpeg.writeFile()", note: ""},
- {"0.11.x": "ffmpeg.FS.readFile()", "0.12+": "await ffmpeg.readFile()", note: ""},
- {"0.11.x": "ffmpeg.exit()", "0.12+": "await ffmpeg.terminate()", note: ""},
- {"0.11.x": "ffmpeg.setLogger()", "0.12+": "ffmpeg.on(\"log\", () => {})", note: ""},
- {"0.11.x": "ffmpeg.setProgress()", "0.12+": "ffmpeg.on(\"progress\", () => {})", note: ""},
- {"0.11.x": "import { fetchFile } from '@ffmpeg/ffmpeg'", "0.12+": "import { fetchFile } from '@ffmpeg/util'", note: ""},
- ].map((row) => (
-
-
- {row['0.11.x']}
-
- {row['0.12+']}
- {row.note}
-
- ))}
-
-
-
+
+
+
+
+
+ 0.11.x
+ 0.12+
+ Note
+
+
+
+ {[
+ {"0.11.x": "import { createFFmpeg } from '@ffmpeg/ffmpeg'", "0.12+": "import { FFmpeg } from '@ffmpeg/ffmpeg'", note: ""},
+ {"0.11.x": "createFFmpeg()", "0.12+": "new FFmpeg()", note: "argumens of createFFmpeg() is moved to ffmpeg.load()"},
+ {"0.11.x": "await ffmpeg.load()", "0.12+": "await ffmpeg.load()", note: ""},
+ {"0.11.x": "await ffmpeg.run(...args)", "0.12+": "await ffmpeg.exec([...args])", note: ""},
+ {"0.11.x": "ffmpeg.FS.writeFile()", "0.12+": "await ffmpeg.writeFile()", note: ""},
+ {"0.11.x": "ffmpeg.FS.readFile()", "0.12+": "await ffmpeg.readFile()", note: ""},
+ {"0.11.x": "ffmpeg.exit()", "0.12+": "await ffmpeg.terminate()", note: ""},
+ {"0.11.x": "ffmpeg.setLogger()", "0.12+": "ffmpeg.on(\"log\", () => {})", note: ""},
+ {"0.11.x": "ffmpeg.setProgress()", "0.12+": "ffmpeg.on(\"progress\", () => {})", note: ""},
+ {"0.11.x": "import { fetchFile } from '@ffmpeg/ffmpeg'", "0.12+": "import { fetchFile } from '@ffmpeg/util'", note: ""},
+ ].map((row) => (
+
+
+ {row['0.11.x']}
+
+ {row['0.12+']}
+ {row.note}
+
+ ))}
+
+
+
+
diff --git a/apps/website/docs/overview.md b/apps/website/docs/overview.md
index 8715798..b0abe7d 100644
--- a/apps/website/docs/overview.md
+++ b/apps/website/docs/overview.md
@@ -1,3 +1,4 @@
+import MuiThemeProvider from "@site/src/components/common/MuiThemeProvider";
import Table from '@mui/material/Table';
import TableBody from '@mui/material/TableBody';
import TableCell from '@mui/material/TableCell';
@@ -49,44 +50,46 @@ be spawned by `ffmpeg-core` inside `ffmpeg.worker`
ffmpeg.wasm is built with toolchains / libraries:
-
-
-
-
- Name
- Version
- Note
-
-
-
- {[
- {name: "Emscripten", version: "3.1.40", note: ""},
- {name: "FFmpeg", version: "n5.1.3", note: ""},
- {name: "x264", version: "0.164.x", note: ""},
- {name: "x265", version: "3.4", note: ""},
- {name: "libvpx", version: "v1.9.0", note: ""},
- {name: "lame", version: "3.100", note: ""},
- {name: "ogg", version: "v1.3.4", note: ""},
- {name: "theora", version: "v1.1.1", note: ""},
- {name: "opus", version: "v1.3.1", note: ""},
- {name: "vorbis", version: "v1.3.3", note: ""},
- {name: "zlib", version: "v1.2.11", note: ""},
- {name: "libwebp", version: "v1.1.0", note: ""},
- {name: "freetype2", version: "v2.10.4", note: ""},
- {name: "fribidi", version: "v1.0.9", note: ""},
- {name: "harfbuzz", version: "5.2.0", note: ""},
- {name: "libass", version: "0.15.0", note: ""},
- ].map((row) => (
-
-
- {row.name}
-
- {row.version}
- {row.note}
-
- ))}
-
-
-
+
+
+
+
+
+ Name
+ Version
+ Note
+
+
+
+ {[
+ {name: "Emscripten", version: "3.1.40", note: ""},
+ {name: "FFmpeg", version: "n5.1.3", note: ""},
+ {name: "x264", version: "0.164.x", note: ""},
+ {name: "x265", version: "3.4", note: ""},
+ {name: "libvpx", version: "v1.9.0", note: ""},
+ {name: "lame", version: "3.100", note: ""},
+ {name: "ogg", version: "v1.3.4", note: ""},
+ {name: "theora", version: "v1.1.1", note: ""},
+ {name: "opus", version: "v1.3.1", note: ""},
+ {name: "vorbis", version: "v1.3.3", note: ""},
+ {name: "zlib", version: "v1.2.11", note: ""},
+ {name: "libwebp", version: "v1.1.0", note: ""},
+ {name: "freetype2", version: "v2.10.4", note: ""},
+ {name: "fribidi", version: "v1.0.9", note: ""},
+ {name: "harfbuzz", version: "5.2.0", note: ""},
+ {name: "libass", version: "0.15.0", note: ""},
+ ].map((row) => (
+
+
+ {row.name}
+
+ {row.version}
+ {row.note}
+
+ ))}
+
+
+
+
diff --git a/apps/website/docusaurus.config.js b/apps/website/docusaurus.config.js
index 3bfae52..da1654f 100644
--- a/apps/website/docusaurus.config.js
+++ b/apps/website/docusaurus.config.js
@@ -135,10 +135,27 @@ const config = {
[
"docusaurus-plugin-typedoc",
{
+ id: "ffmpeg",
entryPoints: ["../../packages/ffmpeg/src/index.ts"],
tsconfig: "../../packages/ffmpeg/tsconfig.json",
readme: "none",
+ out: "api/ffmpeg",
sidebar: {
+ indexLabel: "@ffmpeg/ffmpeg",
+ fullNames: true,
+ },
+ },
+ ],
+ [
+ "docusaurus-plugin-typedoc",
+ {
+ id: "util",
+ entryPoints: ["../../packages/util/src/index.ts"],
+ tsconfig: "../../packages/util/tsconfig.json",
+ readme: "none",
+ out: "api/util",
+ sidebar: {
+ indexLabel: "@ffmpeg/util",
fullNames: true,
},
},
diff --git a/apps/website/sidebars.js b/apps/website/sidebars.js
index 58559ef..f9f024b 100644
--- a/apps/website/sidebars.js
+++ b/apps/website/sidebars.js
@@ -29,7 +29,7 @@ const sidebars = {
{
type: "category",
label: "API",
- items: ["api/classes/FFmpeg"],
+ items: ["api/ffmpeg/index", "api/util/index"],
},
{
type: "category",
diff --git a/packages/ffmpeg/src/classes.ts b/packages/ffmpeg/src/classes.ts
index 0c4fc27..05ab730 100644
--- a/packages/ffmpeg/src/classes.ts
+++ b/packages/ffmpeg/src/classes.ts
@@ -109,9 +109,6 @@ export class FFmpeg {
* })
* ```
*
- * @remarks
- * log includes output to stdout and stderr.
- *
* @example
* ```ts
* ffmpeg.on("progress", ({ progress, time }) => {
@@ -120,7 +117,8 @@ export class FFmpeg {
* ```
*
* @remarks
- * The progress events are accurate only when the length of
+ * - log includes output to stdout and stderr.
+ * - The progress events are accurate only when the length of
* input and output video/audio file are the same.
*
* @category FFmpeg
diff --git a/packages/util/src/index.ts b/packages/util/src/index.ts
index b8613de..0f0756e 100644
--- a/packages/util/src/index.ts
+++ b/packages/util/src/index.ts
@@ -5,7 +5,7 @@ import {
import { HeaderContentLength } from "./const.js";
import { ProgressCallback } from "./types.js";
-export const readFromBlobOrFile = (blob: Blob | File): Promise =>
+const readFromBlobOrFile = (blob: Blob | File): Promise =>
new Promise((resolve, reject) => {
const fileReader = new FileReader();
fileReader.onload = () => {