Document onwrite in conversion docs

This commit is contained in:
Vanilagy
2025-09-02 17:48:33 +02:00
parent 9d47b3c5dc
commit 5ca5fc4633
+11 -2
View File
@@ -77,10 +77,19 @@ This callback is called each time the progress of the conversion advances.
A progress of `1` doesn't indicate the conversion has finished; the conversion is only finished once the promise returned by `.execute()` resolves. A progress of `1` doesn't indicate the conversion has finished; the conversion is only finished once the promise returned by `.execute()` resolves.
::: :::
::: info ::: warning
Tracking conversion progress may slightly affect performance, as it requires knowledge of the input file's total duration - but this is usually negligible. Tracking conversion progress can slightly affect performance as it requires knowledge of the input file's total duration. This is usually negligible but should be avoided when using append-only input sources such as [`ReadableStreamSource`](./reading-media-files#readablestreamsource).
::: :::
If you want to monitor the output size of the conversion (in bytes), simply use the `onwrite` callback on your `Target`:
```ts
let currentFileSize = 0;
output.target.onwrite = (start, end) => {
currentFileSize = Math.max(currentFileSize, end);
};
```
### Canceling a conversion ### Canceling a conversion
Sometimes, you may want to cancel an ongoing conversion process. For this, use the `cancel` method: Sometimes, you may want to cancel an ongoing conversion process. For this, use the `cancel` method: