From 329d025a39e45f74de564c31b014ea2606c203e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20Rodri=CC=81guez?= Date: Sun, 27 Mar 2022 20:25:23 +0200 Subject: [PATCH] doc: Update edit options --- README.md | 39 ++++++++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 16144ee..474641c 100644 --- a/README.md +++ b/README.md @@ -74,11 +74,28 @@ addListener(eventName: 'transcodeProgress', listenerFunc: (info: ProgressInfo) = #### EditOptions -| Prop | Type | -| --------------- | ---------------------------------------------------------------------------- | -| **`path`** | string | -| **`trim`** | { startsAt?: number; endsAt?: number; } | -| **`transcode`** | { height?: number; width?: number; keepAspectRatio?: boolean; } | +| Prop | Type | +| --------------- | ------------------------------------------------------------- | +| **`path`** | string | +| **`trim`** | TrimOptions | +| **`transcode`** | TranscodeOptions | + + +#### TrimOptions + +| Prop | Type | Description | +| -------------- | ------------------- | ------------------------ | +| **`startsAt`** | number | StartsAt in milliseconds | +| **`endsAt`** | number | EndsAt in milliseconds | + + +#### TranscodeOptions + +| Prop | Type | +| --------------------- | -------------------- | +| **`height`** | number | +| **`width`** | number | +| **`keepAspectRatio`** | boolean | #### MediaFileResult @@ -100,12 +117,12 @@ addListener(eventName: 'transcodeProgress', listenerFunc: (info: ProgressInfo) = #### ThumbnailOptions -| Prop | Type | -| ------------ | ------------------- | -| **`path`** | string | -| **`at`** | number | -| **`width`** | number | -| **`height`** | number | +| Prop | Type | Description | +| ------------ | ------------------- | -------------------------------------------------------------------- | +| **`path`** | string | | +| **`at`** | number | The time position where the frame will be retrieved in milliseconds. | +| **`width`** | number | | +| **`height`** | number | | #### ProgressInfo