feat(camera-preview): add white balance controls, getSupportedColorEffects and getBlob

Sync wrapper with cordova-plugin-camera-preview 0.14.0.
2026-08-04 00:00:08 +08:00 · 2026-07-27 22:17:26 +02:00
2 changed files with 175 additions and 123 deletions
@@ -30,9 +30,9 @@ export interface CameraPreviewOptions {

  /** Preview box drag across the screen, default 'false' */
  previewDrag?: boolean;
-  
-  /** Capture images to a file and return back the file path instead of returning base64 encoded data. */
-  storeToFile: boolean;
+
+  /** Capture images to a file and return back the file path instead of returning base64 encoded data. Defaults to false */
+  storeToFile?: boolean;

  /** Preview box to the back of the webview (true => back, false => front) , default false */
  toBack?: boolean;
@@ -166,6 +166,19 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
    CUSTOM: 'custom',
  };

+  WHITE_BALANCE_MODE = {
+    LOCK: 'lock',
+    AUTO: 'auto',
+    CONTINUOUS: 'continuous',
+    INCANDESCENT: 'incandescent',
+    CLOUDY_DAYLIGHT: 'cloudy-daylight',
+    DAYLIGHT: 'daylight',
+    FLUORESCENT: 'fluorescent',
+    SHADE: 'shade',
+    TWILIGHT: 'twilight',
+    WARM_FLUORESCENT: 'warm-fluorescent',
+  };
+
  FLASH_MODE = {
    OFF: 'off',
    ON: 'on',
@@ -297,6 +310,16 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
    return;
  }

+  /**
+   * Get color effects supported by the camera device currently started. Android only.
+   *
+   * @returns {Promise<any>}
+   */
+  @Cordova()
+  getSupportedColorEffects(): Promise<any> {
+    return;
+  }
+
  /**
   *
   * Set camera color effect.
@@ -507,6 +530,40 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
    return;
  }

+  /**
+   * Get white balance modes supported by the camera device currently started.
+   *
+   * @returns {Promise<any>}
+   */
+  @Cordova()
+  getSupportedWhiteBalanceModes(): Promise<any> {
+    return;
+  }
+
+  /**
+   * Get the current white balance mode of the camera device currently started.
+   *
+   * @returns {Promise<any>}
+   */
+  @Cordova()
+  getWhiteBalanceMode(): Promise<any> {
+    return;
+  }
+
+  /**
+   * Set the white balance mode for the camera device currently started.
+   *
+   * @param {string} [whiteBalanceMode] 'lock', 'auto', 'continuous', 'incandescent', 'cloudy-daylight', 'daylight', 'fluorescent', 'shade', 'twilight' or 'warm-fluorescent'
+   * @returns {Promise<any>}
+   */
+  @Cordova({
+    successIndex: 1,
+    errorIndex: 2,
+  })
+  setWhiteBalanceMode(whiteBalanceMode?: string): Promise<any> {
+    return;
+  }
+
  /**
   * Set specific focus point. Note, this assumes the camera is full-screen.
   *
@@ -548,4 +605,18 @@ export class CameraPreview extends AwesomeCordovaNativePlugin {
  getCameraCharacteristics(): Promise<any> {
    return;
  }
+
+  /**
+   * Convert a local file (e.g. a `file://` path returned by takePicture with storeToFile) into a Blob.
+   *
+   * @param {string} path the local url to convert
+   * @returns {Promise<any>}
+   */
+  @Cordova({
+    successIndex: 1,
+    errorIndex: 2,
+  })
+  getBlob(path: string): Promise<any> {
+    return;
+  }
 }
@@ -62,35 +62,35 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
    return;
  }

-  /**
-   * Sets the user's consent for event and profile tracking.
-   *
-   * You must call this method separately for each active user profile,
-   * for example, when switching user profiles using `onUserLogin`.
-   *
-   * Consent Scenarios:
-   *
-   * 1. **Complete Opt-Out**
-   *    `userOptOut = true`, `allowSystemEvents = false`
-   *    → No events (custom or system) are saved locally or remotely. Maximum privacy.
-   *
-   * 2. **Full Opt-In**
-   *    `userOptOut = false`, `allowSystemEvents = true`
-   *    → All events (custom and system) are tracked. Default behavior.
-   *
-   * 3. **Partial Opt-In**
-   *    `userOptOut = true`, `allowSystemEvents = true`
-   *    → Only system events (e.g., app launch, notification viewed) are tracked. Custom events are ignored.
-   *
-   * ⚠️ The combination `userOptOut = false` and `allowSystemEvents = false` is invalid.
-   * In such cases, the SDK defaults to **Full Opt-In**.
-   *
-   * To re-enable full tracking after opting out, call with:
-   * `userOptOut = false`, `allowSystemEvents = true`.
-   *
-   * @param {boolean} userOptOut - Set to `true` to disable custom event tracking.
-   * @param {boolean} allowSystemEvents - Set to `true` to allow system-level event tracking.
-   */
+/**
+* Sets the user's consent for event and profile tracking.
+*
+* You must call this method separately for each active user profile,
+* for example, when switching user profiles using `onUserLogin`.
+*
+* Consent Scenarios:
+*
+* 1. **Complete Opt-Out**
+*    `userOptOut = true`, `allowSystemEvents = false`
+*    → No events (custom or system) are saved locally or remotely. Maximum privacy.
+*
+* 2. **Full Opt-In**
+*    `userOptOut = false`, `allowSystemEvents = true`
+*    → All events (custom and system) are tracked. Default behavior.
+*
+* 3. **Partial Opt-In**
+*    `userOptOut = true`, `allowSystemEvents = true`
+*    → Only system events (e.g., app launch, notification viewed) are tracked. Custom events are ignored.
+*
+* ⚠️ The combination `userOptOut = false` and `allowSystemEvents = false` is invalid.
+* In such cases, the SDK defaults to **Full Opt-In**.
+*
+* To re-enable full tracking after opting out, call with:
+* `userOptOut = false`, `allowSystemEvents = true`.
+*
+* @param {boolean} userOptOut - Set to `true` to disable custom event tracking.
+* @param {boolean} allowSystemEvents - Set to `true` to allow system-level event tracking.
+*/
  @Cordova()
  setOptOut(optOut: boolean, allowSystemEvents?: boolean): Promise<any> {
    return;
@@ -361,7 +361,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
   */
  @Cordova()
  getUserEventLog(eventName: string): Promise<any> {
-    return;
+      return;
  }

  /**
@@ -372,7 +372,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
   */
  @Cordova()
  getUserEventLogCount(eventName: string): Promise<any> {
-    return;
+      return;
  }

  /**
@@ -382,7 +382,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
   */
  @Cordova()
  getUserLastVisitTs(): Promise<any> {
-    return;
+      return;
  }

  /**
@@ -392,7 +392,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
   */
  @Cordova()
  getUserAppLaunchCount(): Promise<any> {
-    return;
+      return;
  }

  /**
@@ -402,9 +402,10 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
   */
  @Cordova()
  getUserEventLogHistory(): Promise<any> {
-    return;
+      return;
  }

+
  /**
   * @deprecated - Use getUserEventLog() instead
   * Get Event First Time
@@ -669,7 +670,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
   * @returns {Promise<any>}
   */
  @Cordova()
-  profileIncrementValueBy(key: string, value: number): Promise<any> {
+  profileIncrementValueBy(key: string,value: number): Promise<any> {
    return;
  }

@@ -681,7 +682,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
   * @returns {Promise<any>}
   */
  @Cordova()
-  profileDecrementValueBy(key: string, value: number): Promise<any> {
+  profileDecrementValueBy(key: string,value: number): Promise<any> {
    return;
  }

@@ -705,12 +706,9 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
   * Discards inApp notifications until 'resumeInAppNotifications' is called for current session.
   * Automatically resumes InApp notifications display on CleverTap shared instance creation.
   * Pending inApp notifications are not displayed.
-   *
-   * @param dismissInAppIfVisible {boolean} - Optional. If true, also dismisses the currently visible InApp notification.
-   * @returns {Promise<any>}
   */
  @Cordova()
-  discardInAppNotifications(dismissInAppIfVisible?: boolean): Promise<any> {
+  discardInAppNotifications(): Promise<any> {
    return;
  }

@@ -741,10 +739,10 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
   * @param expiredOnly {boolean} - to clear only assets which will not be needed further for inapps
   * @returns {Promise<any>}
   */
-  @Cordova()
-  clearFileResources(expiredOnly: boolean): Promise<any> {
-    return;
-  }
+    @Cordova()
+    clearFileResources(expiredOnly: boolean): Promise<any> {
+      return;
+    }

  /**
   * Fetches In Apps from server.
@@ -756,6 +754,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
    return;
  }

+
  /*******************
   * Session
   ******************/
@@ -1222,10 +1221,10 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
   * @returns {Promise<any>}
   * @param {string} variable The String specifying the name of file varible to be created.
   */
-  @Cordova()
-  defineFileVariable(variable: string): Promise<any> {
-    return;
-  }
+    @Cordova()
+    defineFileVariable(variable: string): Promise<any> {
+      return;
+    }

  /**
   * Get a variable or a group for the specified name.
@@ -1246,28 +1245,6 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
    return;
  }

-  /**
-   * Returns information about the active A/B experiment variants for the current user.
-   * Each variant object contains an "id" key mapping to the numeric ID of the variant.
-   *
-   * @returns {Promise<any>} - Returns an array of variant objects.
-   */
-  @Cordova()
-  variants(): Promise<any> {
-    return;
-  }
-
-  /**
-   * Clears any active mute state set by the backend, allowing the SDK to resume
-   * normal event tracking and network operations immediately.
-   *
-   * @returns {Promise<any>}
-   */
-  @Cordova()
-  unmute(): Promise<any> {
-    return;
-  }
-
  /**
   * Adds a callback to be invoked when variables are initialised with server values. Will be called each time new values are fetched.
   * @returns {Promise<any>}
@@ -1287,6 +1264,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
    return;
  }

+
  /**
   * Called when the value of the file variable is downloaded and ready
   * @param {name} string the name of the variable
@@ -1324,6 +1302,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
    return;
  }

+
  /****************************
   * Custom Templates methods
   ****************************/
@@ -1352,104 +1331,105 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
  }

  /**
-   * Notify the SDK that an active custom template is dismissed. The active custom template is considered to be
-   * visible to the user until this method is called. Since the SDK can show only one InApp message at a time, all
-   * other messages will be queued until the current one is dismissed.
-   * @param {string} templateName The name of the active template
-   * @returns {Promise<any>}
-   */
+  * Notify the SDK that an active custom template is dismissed. The active custom template is considered to be
+  * visible to the user until this method is called. Since the SDK can show only one InApp message at a time, all
+  * other messages will be queued until the current one is dismissed.
+  * @param {string} templateName The name of the active template
+  * @returns {Promise<any>}
+  */
  @Cordova()
  customTemplateSetDismissed(templateName: string): Promise<any> {
    return;
  }

+
  /**
-   * Notify the SDK that an active custom template is presented to the user.
-   * @param {string} templateName The name of the active template
-   * @returns {Promise<any>}
-   */
+  * Notify the SDK that an active custom template is presented to the user.
+  * @param {string} templateName The name of the active template
+  * @returns {Promise<any>}
+  */
  @Cordova()
  customTemplateSetPresented(templateName: string): Promise<any> {
    return;
  }

  /**
-   * Trigger a custom template action argument by name.
-   *
-   * @param {string} templateName The name of an active template for which the action is defined
-   * @param {string} argName The action argument na
-   * @returns {Promise<any>}
-   */
+  * Trigger a custom template action argument by name.
+  *
+  * @param {string} templateName The name of an active template for which the action is defined
+  * @param {string} argName The action argument na
+  * @returns {Promise<any>}
+  */
  @Cordova()
  customTemplateRunAction(templateName: string, argName: string): Promise<any> {
    return;
  }

  /**
-   * Retrieve a string argument by name.
-   *
-   * @param {string} templateName The name of an active template for which the argument is defined
-   * @param {string} argName The action argument name
-   * @returns {Promise<any>}
-   */
+  * Retrieve a string argument by name.
+  *
+  * @param {string} templateName The name of an active template for which the argument is defined
+  * @param {string} argName The action argument name
+  * @returns {Promise<any>}
+  */
  @Cordova()
  customTemplateGetStringArg(templateName: string, argName: string): Promise<any> {
    return;
  }

  /**
-   * Retrieve a number argument by name.
-   *
-   * @param {string} templateName The name of an active template for which the argument is defined
-   * @param {string} argName The action argument name
-   * @returns {Promise<any>}
-   */
+  * Retrieve a number argument by name.
+  *
+  * @param {string} templateName The name of an active template for which the argument is defined
+  * @param {string} argName The action argument name
+  * @returns {Promise<any>}
+  */
  @Cordova()
  customTemplateGetNumberArg(templateName: string, argName: string): Promise<any> {
    return;
  }

  /**
-   * Retrieve a boolean argument by name.
-   *
-   * @param {string} templateName The name of an active template for which the argument is defined
-   * @param {string} argName The action argument name
-   * @returns {Promise<any>}
-   */
+  * Retrieve a boolean argument by name.
+  *
+  * @param {string} templateName The name of an active template for which the argument is defined
+  * @param {string} argName The action argument name
+  * @returns {Promise<any>}
+  */
  @Cordova()
  customTemplateGetBooleanArg(templateName: string, argName: string): Promise<any> {
    return;
  }

  /**
-   * Retrieve a file argument by name.
-   *
-   * @param {string} templateName The name of an active template for which the argument is defined
-   * @param {string} argName The action argument name
-   * @returns {Promise<any>}
-   */
+  * Retrieve a file argument by name.
+  *
+  * @param {string} templateName The name of an active template for which the argument is defined
+  * @param {string} argName The action argument name
+  * @returns {Promise<any>}
+  */
  @Cordova()
  customTemplateGetFileArg(templateName: string, argName: string): Promise<any> {
    return;
  }

  /**
-   * Retrieve an object argument by name.
-   *
-   * @param {string} templateName The name of an active template for which the argument is defined
-   * @param {string} argName The action argument name
-   * @returns {Promise<any>}
-   */
+  * Retrieve an object argument by name.
+  *
+  * @param {string} templateName The name of an active template for which the argument is defined
+  * @param {string} argName The action argument name
+  * @returns {Promise<any>}
+  */
  @Cordova()
  customTemplateGetObjectArg(templateName: string, argName: string): Promise<any> {
    return;
  }

  /**
-   * Get a string representation of an active's template context with information about all arguments.
-   * @param {string} templateName The name of an active template
-   * @returns {Promise<any>}
-   */
+  * Get a string representation of an active's template context with information about all arguments.
+  * @param {string} templateName The name of an active template
+  * @returns {Promise<any>}
+  */
  @Cordova()
  customTemplateContextToString(templateName: string): Promise<any> {
    return;
@@ -1489,6 +1469,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin {
    return;
  }

+
  /*******************
   * Developer Options
   ******************/