react-native-video-trim 4.0.0 → 4.1.0

package/src/VideoTrim.nitro.ts

@@ -1,16 +1,80 @@
 import type { HybridObject } from 'react-native-nitro-modules';
 
-export interface EditorConfig {
-  /**
-   * Enable haptic feedback
-   * @default true
-   */
-  enableHapticFeedback: boolean;
+export interface BaseOptions {
   /**
    * Save the output file to Photos Library. Only video is supported. Note that you have to make sure you have permission to save to Photos Library.
    * @default false
    */
   saveToPhoto: boolean;
+  /**
+   * Type of the file to edit. If video file, recommend to use `video`. If audio file, recommend to use `audio`.
+   * @default "video"
+   */
+  type: string;
+  /**
+   * Output file extension. If video file, recommend to use `mp4` or `mov`. If audio file, recommend to use `wav` or `m4a`.
+   * @default "mp4"
+   * @example "mp4", "mov", "wav", "m4a", "3gp", "avi", "mkv", "flv", "wmv", "webm"
+   */
+  outputExt: string;
+  /**
+   * Whether to open Documents app after finish editing
+   * @default false
+   */
+  openDocumentsOnFinish: boolean;
+  /**
+   * Whether to open Share Sheet after finish editing
+   * @default false
+   */
+  openShareSheetOnFinish: boolean;
+  /**
+   * Remove the file after saved to Photos Library
+   * @default false
+   */
+  removeAfterSavedToPhoto: boolean;
+  /**
+   * Remove the file after failed to save to Photos Library
+   * @default false
+   */
+  removeAfterFailedToSavePhoto: boolean;
+  /**
+   * Remove the file after saved to Documents app
+   * @default false
+   */
+  removeAfterSavedToDocuments: boolean;
+  /**
+   * Remove the file after failed to save to Documents app
+   * @default false
+   */
+  removeAfterFailedToSaveDocuments: boolean;
+  /**
+   * Remove the file after shared to other apps. Currently only support iOS, on Android there's no way to detect if the file is shared or not.
+   * @default false
+   */
+  removeAfterShared: boolean;
+  /**
+   * Remove the file after failed to share to other apps. Currently only support iOS, on Android there's no way to detect if the file is shared or not.
+   * @default false
+   */
+  removeAfterFailedToShare: boolean;
+  /**
+   * Enable rotation
+   * @default false
+   */
+  enableRotation: boolean;
+  /**
+   * Rotation angle in degrees
+   * @default 0
+   */
+  rotationAngle: number;
+}
+
+export interface EditorConfig extends BaseOptions {
+  /**
+   * Enable haptic feedback
+   * @default true
+   */
+  enableHapticFeedback: boolean;
   maxDuration: number;
   /**
    * Minimum duration for trimmer
@@ -87,57 +151,6 @@ export interface EditorConfig {
    * @default false
    */
   fullScreenModalIOS: boolean;
-  /**
-   * Type of the file to edit. If video file, recommend to use `video`. If audio file, recommend to use `audio`.
-   * @default "video"
-   */
-  type: string;
-  /**
-   * Output file extension. If video file, recommend to use `mp4` or `mov`. If audio file, recommend to use `wav` or `m4a`.
-   * @default "mp4"
-   * @example "mp4", "mov", "wav", "m4a", "3gp", "avi", "mkv", "flv", "wmv", "webm"
-   */
-  outputExt: string;
-  /**
-   * Whether to open Documents app after finish editing
-   * @default false
-   */
-  openDocumentsOnFinish: boolean;
-  /**
-   * Whether to open Share Sheet after finish editing
-   * @default false
-   */
-  openShareSheetOnFinish: boolean;
-  /**
-   * Remove the file after saved to Photos Library
-   * @default false
-   */
-  removeAfterSavedToPhoto: boolean;
-  /**
-   * Remove the file after failed to save to Photos Library
-   * @default false
-   */
-  removeAfterFailedToSavePhoto: boolean;
-  /**
-   * Remove the file after saved to Documents app
-   * @default false
-   */
-  removeAfterSavedToDocuments: boolean;
-  /**
-   * Remove the file after failed to save to Documents app
-   * @default false
-   */
-  removeAfterFailedToSaveDocuments: boolean;
-  /**
-   * Remove the file after shared to other apps. Currently only support iOS, on Android there's no way to detect if the file is shared or not.
-   * @default false
-   */
-  removeAfterShared: boolean;
-  /**
-   * Remove the file after failed to share to other apps. Currently only support iOS, on Android there's no way to detect if the file is shared or not.
-   * @default false
-   */
-  removeAfterFailedToShare: boolean;
   /**
    * Whether to enable autoplay on load
    */
@@ -223,6 +236,11 @@ export interface EditorConfig {
   alertOnFailCloseText: string;
 }
 
+export interface TrimOptions extends BaseOptions {
+  startTime: number; // in milliseconds
+  endTime: number; // in milliseconds
+}
+
 export interface FileValidationResult {
   isValid: boolean;
   fileType: string;
@@ -241,4 +259,5 @@ export interface VideoTrim
   deleteFile(filePath: string): Promise<boolean>;
   closeEditor(onComplete: () => void): void;
   isValidFile(url: string): Promise<FileValidationResult>;
+  trim(url: string, options: TrimOptions): Promise<string>;
 }

package/src/index.tsx

@@ -1,7 +1,9 @@
 import { NitroModules } from 'react-native-nitro-modules';
 import type {
+  BaseOptions,
   EditorConfig,
   FileValidationResult,
+  TrimOptions,
   VideoTrim,
 } from './VideoTrim.nitro';
 import { processColor } from 'react-native';
@@ -9,12 +11,30 @@ import { processColor } from 'react-native';
 const VideoTrimHybridObject =
   NitroModules.createHybridObject<VideoTrim>('VideoTrim');
 
+function createBaseOptions(overrides: Partial<BaseOptions> = {}): BaseOptions {
+  return {
+    saveToPhoto: false,
+    type: 'video',
+    outputExt: 'mp4',
+    openDocumentsOnFinish: false,
+    openShareSheetOnFinish: false,
+    removeAfterSavedToPhoto: false,
+    removeAfterFailedToSavePhoto: false,
+    removeAfterSavedToDocuments: false,
+    removeAfterFailedToSaveDocuments: false,
+    removeAfterShared: false,
+    removeAfterFailedToShare: false,
+    enableRotation: false,
+    rotationAngle: 0,
+    ...overrides,
+  };
+}
+
 function createEditorConfig(
   overrides: Partial<EditorConfig> = {}
 ): EditorConfig {
   return {
     enableHapticFeedback: true,
-    saveToPhoto: false,
     maxDuration: -1, // Adjust default as needed
     minDuration: 1000,
     cancelButtonText: 'Cancel',
@@ -31,16 +51,6 @@ function createEditorConfig(
     saveDialogConfirmText: 'Proceed',
     trimmingText: 'Trimming video...',
     fullScreenModalIOS: false,
-    type: 'video',
-    outputExt: 'mp4',
-    openDocumentsOnFinish: false,
-    openShareSheetOnFinish: false,
-    removeAfterSavedToPhoto: false,
-    removeAfterFailedToSavePhoto: false,
-    removeAfterSavedToDocuments: false,
-    removeAfterFailedToSaveDocuments: false,
-    removeAfterShared: false,
-    removeAfterFailedToShare: false,
     autoplay: false, // Adjust default as needed
     jumpToPositionOnLoad: -1,
     closeWhenFinish: true,
@@ -59,6 +69,16 @@ function createEditorConfig(
     alertOnFailMessage:
       'Fail to load media. Possibly invalid file or no network connection',
     alertOnFailCloseText: 'Close',
+    ...createBaseOptions(overrides),
+    ...overrides,
+  };
+}
+
+function createTrimOptions(overrides: Partial<TrimOptions> = {}): TrimOptions {
+  return {
+    startTime: 0,
+    endTime: 1000,
+    ...createBaseOptions(overrides),
     ...overrides,
   };
 }
@@ -138,3 +158,17 @@ export function closeEditor(onComplete?: () => void): void {
 export function isValidFile(url: string): Promise<FileValidationResult> {
   return VideoTrimHybridObject.isValidFile(url);
 }
+
+/**
+ * Trim a video file
+ *
+ * @param {string} url: absolute non-empty file path to edit
+ * @param {TrimOptions} options: trim options
+ * @returns {Promise<string>} A **Promise** which resolves to the trimmed file path
+ */
+export function trim(
+  url: string,
+  options: Partial<TrimOptions>
+): Promise<string> {
+  return VideoTrimHybridObject.trim(url, createTrimOptions(options));
+}