arcodange/mediabunny
1
0
Fork 0
mirror of https://github.com/arcodange-org/mediabunny.git synced 2026-10-01 21:03:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add "Quick start" to docs, small API and docs adjustments

Browse Source
This commit is contained in:
Vanilagy
2025-06-18 12:25:10 +02:00
parent a2fc4decda
commit befab215b4
8 changed files with 533 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/output-format.ts
+6 -6
View File
@@ -303,11 +303,11 @@ export class MovOutputFormat extends IsobmffOutputFormat {
*/
export type MkvOutputFormatOptions = {
/**
* Configures the output to only write data monotonically, useful for live-streaming the file as it's being muxed.
* When enabled, some features such as storing duration and seeking will be disabled or impacted, so don't use this
* option when you want to write out a file for later use.
* Configures the output to only append new data at the end, useful for live-streaming the file as it's being
* created. When enabled, some features such as storing duration and seeking will be disabled or impacted, so don't
* use this option when you want to write out a clean file for later use.
*/
streamable?: boolean;
appendOnly?: boolean;
/**
* This field controls the minimum duration of each Matroska cluster, in seconds. New clusters will only be created
@@ -354,8 +354,8 @@ export class MkvOutputFormat extends OutputFormat {
if (!options || typeof options !== 'object') {
throw new TypeError('options must be an object.');
}
if (options.streamable !== undefined && typeof options.streamable !== 'boolean') {
throw new TypeError('options.streamable, when provided, must be a boolean.');
if (options.appendOnly !== undefined && typeof options.appendOnly !== 'boolean') {
throw new TypeError('options.appendOnly, when provided, must be a boolean.');
}
if (
options.minimumClusterDuration !== undefined