@chilkat/react-native 11.6.1

package/src/specs/Xmp.nitro.ts

@@ -0,0 +1,364 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { StringArray } from './StringArray.nitro'
+import type { Xml } from './Xml.nitro'
+
+/**
+ * Read, modify, add, remove, and save XMP metadata in JPG and TIFF files.
+ *
+ * `Xmp` is a legacy class for working with embedded XMP
+ * metadata in `JPG` and `TIFF` image files. It can load
+ * image files or image data from memory, locate embedded XMP documents, return
+ * XMP metadata as `Chilkat.Xml`, create new XMP documents, add or
+ * update simple string and integer properties, manage arrays and structured
+ * properties, add namespace mappings, remove selected XMP properties or entire
+ * embedded XMP documents, and save the updated image back to a file or byte
+ * buffer.
+ *
+ * **Legacy class:**
+ * `Xmp` is maintained for existing JPG/TIFF XMP workflows,
+ * but it is not planned to be extended to support additional file types.
+ *
+ * **Load JPG or TIFF metadata**
+ *
+ * Load a `JPG` or `TIFF` file from disk or memory and
+ * inspect how many embedded XMP documents were found.
+ *
+ * **Access XMP as XML**
+ *
+ * Retrieve embedded XMP documents as `Chilkat.Xml` objects for
+ * inspection, editing, or direct XML-level processing.
+ *
+ * **Add simple properties**
+ *
+ * Add or update namespace-qualified string and integer properties such as
+ * `dc:subject`, `photoshop:Credit`, or
+ * `tiff:XResolution`.
+ *
+ * **Arrays and structures**
+ *
+ * Work with XMP arrays such as `bag`, `seq`, and
+ * `alt`, and manage structured property values.
+ *
+ * **Namespaces**
+ *
+ * Use built-in namespace mappings or add custom namespace-to-URI mappings
+ * for application-specific XMP properties.
+ *
+ * **Remove and save**
+ *
+ * Remove properties, arrays, structures, or embedded XMP documents, then
+ * persist changes to a file or return the updated image as a byte buffer.
+ *
+ * **Common pattern:**
+ * Load a JPG or TIFF with `LoadAppFile` or
+ * `LoadFromBuffer`, retrieve an embedded XMP document with
+ * `GetEmbedded` or create one with `NewXmp`, modify it
+ * using the add/remove property methods, then call `SaveAppFile` or
+ * `SaveToBuffer` to persist the updated image metadata.
+ *
+ * **Persistence note:**
+ * Changes made to the XMP XML object are not written back to the image file
+ * until `SaveAppFile` is called. For memory workflows, use
+ * `SaveToBuffer` to obtain the updated JPG or TIFF bytes.
+ *
+ * Each `Xmp` instance owns a native Chilkat object. It is released when the JavaScript object is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new Xmp()`.
+ */
+export interface Xmp extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * Provides HTML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: string
+
+  /**
+   * Provides plain text information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: string
+
+  /**
+   * Provides XML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: string
+
+  /**
+   * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
+   * call to the specified file. This logging helps identify the context and history of Chilkat
+   * calls leading up to any crash or hang, aiding in debugging.
+   *
+   * Enabling the VerboseLogging property provides more detailed information.
+   *
+   * This property is mainly used for debugging rare instances where a Chilkat method call causes a
+   * hang or crash, which should generally not happen.
+   *
+   * Possible causes of hangs include:
+   *
+   * - A timeout property set to 0, indicating an infinite timeout.
+   *
+   * - A hang occurring within an event callback in the application code.
+   *
+   * - An internal bug in the Chilkat code causing the hang.
+   */
+  debugLogFilePath: string
+
+  /**
+   * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
+   * contain more verbose information. The default value is `false`. Verbose logging should only be
+   * used for debugging. The potentially large quantity of logged information may adversely affect
+   * peformance.
+   */
+  verboseLogging: boolean
+
+  /**
+   * Indicates the success or failure of the most recent method call: `true` means success, `false`
+   * means failure. This property remains unchanged by property setters or getters. This method is
+   * present to address challenges in checking for null or Nothing returns in certain programming
+   * languages. Note: This property does not apply to methods that return integer values or to
+   * boolean-returning methods where the boolean does not indicate success or failure.
+   */
+  lastMethodSuccess: boolean
+
+  /**
+   * The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile.
+   *
+   * This property is read-only.
+   */
+  readonly numEmbedded: number
+
+  /**
+   * Determines whether structures are stored with rdf:parseType=`Resource`, or within an
+   * `rdf:Description` sub-node.
+   */
+  structInnerDescrip: boolean
+
+  /**
+   * A property to be used for future uncommon needs.  The default value is the empty string.
+   */
+  uncommonOptions: string
+
+  // ---- Methods ----
+
+  /**
+   * Adds or replaces an XMP property array. The XMP metadata to be updated is contained in the XML
+   * object passed in the 1st argument. The 2nd argument specifies the array type, which can be
+   * `bag`, `seq`, or `alt`. The property name should be prefixed with the namespace, such as
+   * `dc:subject`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  addArray(xml: Xml, arrType: string, propName: string, values: StringArray): void
+
+  /**
+   * Adds a namespace to URI mapping. When a property is added via AddSimpleString or any of the
+   * other methods, the property name is namespace qualified. When adding the first property in a
+   * namespace, the rdf:Description is automatically added and the URI is obtained from the
+   * namespace-to-URI mappings. The standard (and commonly used) namespace mappings are defined by
+   * default. This is only used if the namespace is custom or not already handled.
+   */
+  addNsMapping(ns: string, uri: string): void
+
+  /**
+   * Adds or updates an XMP integer property. The XMP metadata to be updated is contained in the XML
+   * object passed in the 1st argument. The property name should be prefixed with the namespace,
+   * such as `tiff:XResolution`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  addSimpleInt(iXml: Xml, propName: string, propVal: number): void
+
+  /**
+   * Adds or updates a simple XMP string property. The XMP metadata to be updated is contained in
+   * the XML object passed in the 1st argument. The property name should be prefixed with the
+   * namespace, such as `photoshop:Credit`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  addSimpleStr(iXml: Xml, propName: string, propVal: string): void
+
+  /**
+   * Adds or updates an XMP structured property value. The XMP metadata to be updated is contained
+   * in the XML object passed in the 1st argument. The structure name should be prefixed with the
+   * namespace, such as `Iptc4xmpCore:CreatorContactInfo`. The property name within the structure
+   * should also be prefixed with the namespace, such as `Iptc4xmpCore:CiAdrCity`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  addStructProp(iChilkatXml: Xml, structName: string, propName: string, propValue: string): void
+
+  /**
+   * Appends a new XMP metadata file to the XMP object. Any XMPs appended via this method will be
+   * present in the file when SaveAppFile is called. Files containing XMP metadata typically only
+   * include a single XMP document, so this method is usually only called when adding XMP metadata
+   * to a file for the first time.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  append(iXml: Xml): void
+
+  /**
+   * Finds and returns an XMP array property. The property name should be prefixed with the
+   * namespace, such as `dc:subject`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  getArray(iXml: Xml, propName: string): StringArray
+
+  /**
+   * Returns the Nth embedded XMP document as a Chilkat XML object.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  getEmbedded(index: number): Xml
+
+  /**
+   * The `GetProperty` method.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  getProperty(iXml: Xml, propName: string): Xml
+
+  /**
+   * Finds and returns an XMP integer property. The property name should be prefixed with the
+   * namespace, such as `tiff:ResolutionUnit`.
+   */
+  getSimpleInt(iXml: Xml, propName: string): number
+
+  /**
+   * Finds and returns an XMP simple string property. The property name should be prefixed with the
+   * namespace, such as `photoshop:Source`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  getSimpleStr(iXml: Xml, propName: string): string
+
+  /**
+   * Returns the property names used by an exsting structure within an XMP document. The contents of
+   * the structure can be retrieved by calling GetStructValue for each property name returned by
+   * GetStructPropNames.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  getStructPropNames(iXml: Xml, structName: string): StringArray
+
+  /**
+   * Returns the value of a single item within an XMP structure property. Property names should
+   * always be prefixed with the namespace.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  getStructValue(iXml: Xml, structName: string, propName: string): string
+
+  /**
+   * Loads a TIFF or JPG file into the XMP object.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  loadAppFile(filename: string): void
+
+  /**
+   * Creates and returns a new/empty XMP metadata document as a Chilkat XML object.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  newXmp(): Xml
+
+  /**
+   * Removes all XMP metadata documents from an XMP object. After calling this method, call
+   * SaveAppFile to rewrite the JPG or TIFF file with the XMP metadata removed.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  removeAllEmbedded(): void
+
+  /**
+   * Removes an XMP array property from the XMP document.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  removeArray(iXml: Xml, propName: string): void
+
+  /**
+   * Removes a single XMP metadata document from the JPG or TIFF file. Call SaveAppFile to persist
+   * the changes to disk.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  removeEmbedded(index: number): void
+
+  /**
+   * Removes a namespace-to-URI mapping.
+   */
+  removeNsMapping(ns: string): void
+
+  /**
+   * Removes a simple XMP property from the XMP document.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  removeSimple(iXml: Xml, propName: string): void
+
+  /**
+   * Removes an XMP structure property from the XMP document.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  removeStruct(iXml: Xml, structName: string): void
+
+  /**
+   * Removes a single member from an XMP structured property.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  removeStructProp(iXml: Xml, structName: string, propName: string): void
+
+  /**
+   * Persists all changes made to the XMP document(s) by saving the XMP object to a file. Changes
+   * made by adding, updating, or removing properties are not persisted to the filesystem until this
+   * is called.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Xmp.lastErrorText}.
+   */
+  saveAppFile(filename: string): void
+}