@capawesome/capacitor-exif 0.0.1

package/dist/docs.json

@@ -0,0 +1,746 @@
+{
+  "api": {
+    "name": "ExifPlugin",
+    "slug": "exifplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "readExif",
+        "signature": "(options: ReadExifOptions) => Promise<ReadExifResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ReadExifOptions"
+          }
+        ],
+        "returns": "Promise<ReadExifResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Read the EXIF metadata of an image file.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "ReadExifResult",
+          "ReadExifOptions"
+        ],
+        "slug": "readexif"
+      },
+      {
+        "name": "removeExif",
+        "signature": "(options: RemoveExifOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RemoveExifOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Remove the EXIF metadata from an image file in place.\n\nThe pixel data is never re-encoded, so the image quality\nis not affected.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "RemoveExifOptions"
+        ],
+        "slug": "removeexif"
+      },
+      {
+        "name": "writeExif",
+        "signature": "(options: WriteExifOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "WriteExifOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Write EXIF metadata to an image file in place.\n\nOnly the provided tags are updated. All other tags remain unchanged.\nThe pixel data is never re-encoded, so the image quality\nis not affected.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "WriteExifOptions"
+        ],
+        "slug": "writeexif"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "ReadExifResult",
+      "slug": "readexifresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "tags",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The EXIF tags that were read from the image file.",
+          "complexTypes": [
+            "ExifTags"
+          ],
+          "type": "ExifTags"
+        }
+      ]
+    },
+    {
+      "name": "ExifTags",
+      "slug": "exiftags",
+      "docs": "The EXIF tags of an image file.\n\nEvery property is optional and only present if the tag\nexists in the file.",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "dateTimeOriginal",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'2026:01:15 10:30:00'",
+              "name": "example"
+            }
+          ],
+          "docs": "The date and time when the image was originally captured\nin the EXIF date format `YYYY:MM:DD HH:MM:SS`.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "exposureTime",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "0.008",
+              "name": "example"
+            }
+          ],
+          "docs": "The exposure time in seconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "fNumber",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "1.8",
+              "name": "example"
+            }
+          ],
+          "docs": "The F number (aperture) of the lens.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "flash",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            }
+          ],
+          "docs": "Whether or not the flash fired when the image was captured.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "focalLength",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "26",
+              "name": "example"
+            }
+          ],
+          "docs": "The focal length of the lens in millimeters.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "gpsAltitude",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "11.5",
+              "name": "example"
+            }
+          ],
+          "docs": "The altitude in meters above (positive) or below (negative) sea level.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "gpsLatitude",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "51.503364",
+              "name": "example"
+            }
+          ],
+          "docs": "The latitude in signed decimal degrees.\n\nPositive values are north of the equator, negative values are south.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "gpsLongitude",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "-0.127625",
+              "name": "example"
+            }
+          ],
+          "docs": "The longitude in signed decimal degrees.\n\nPositive values are east of the prime meridian, negative values are west.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "iso",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "125",
+              "name": "example"
+            }
+          ],
+          "docs": "The ISO speed rating (photographic sensitivity).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "lensModel",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'iPhone 15 Pro back triple camera 6.765mm f/1.78'",
+              "name": "example"
+            }
+          ],
+          "docs": "The model of the lens.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "make",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Apple'",
+              "name": "example"
+            }
+          ],
+          "docs": "The manufacturer of the camera.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "model",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'iPhone 15 Pro'",
+              "name": "example"
+            }
+          ],
+          "docs": "The model of the camera.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "orientation",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "6",
+              "name": "example"
+            }
+          ],
+          "docs": "The orientation of the image as defined by the EXIF specification (1-8).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "pixelHeight",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "480",
+              "name": "example"
+            }
+          ],
+          "docs": "The height of the image in pixels.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "pixelWidth",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "640",
+              "name": "example"
+            }
+          ],
+          "docs": "The width of the image in pixels.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "software",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Adobe Photoshop'",
+              "name": "example"
+            }
+          ],
+          "docs": "The name of the software that was used to create or edit the image.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ReadExifOptions",
+      "slug": "readexifoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'/data/user/0/dev.robingenz.capacitor.plugindemo/cache/photo.jpg'",
+              "name": "example"
+            }
+          ],
+          "docs": "The path to the image file to read the EXIF metadata from.\n\nLocal file paths and `file://` URIs are supported.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "RemoveExifOptions",
+      "slug": "removeexifoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "keepOrientation",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "default"
+            },
+            {
+              "text": "false",
+              "name": "example"
+            }
+          ],
+          "docs": "Whether or not to keep the orientation tag when removing\nthe EXIF metadata.\n\nThis is enabled by default so that images are not suddenly\ndisplayed rotated after the metadata has been removed.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "path",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'/data/user/0/dev.robingenz.capacitor.plugindemo/cache/photo.jpg'",
+              "name": "example"
+            }
+          ],
+          "docs": "The path to the image file to remove the EXIF metadata from.\n\nLocal file paths and `file://` URIs are supported.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "WriteExifOptions",
+      "slug": "writeexifoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'/data/user/0/dev.robingenz.capacitor.plugindemo/cache/photo.jpg'",
+              "name": "example"
+            }
+          ],
+          "docs": "The path to the image file to write the EXIF metadata to.\n\nLocal file paths and `file://` URIs are supported.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "tags",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The EXIF tags to write to the image file.\n\nOnly the provided tags are updated. All other tags remain unchanged.",
+          "complexTypes": [
+            "WritableExifTags"
+          ],
+          "type": "WritableExifTags"
+        }
+      ]
+    },
+    {
+      "name": "WritableExifTags",
+      "slug": "writableexiftags",
+      "docs": "The writable subset of the EXIF tags.",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "dateTimeOriginal",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'2026:01:15 10:30:00'",
+              "name": "example"
+            }
+          ],
+          "docs": "The date and time when the image was originally captured\nin the EXIF date format `YYYY:MM:DD HH:MM:SS`.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "exposureTime",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "0.008",
+              "name": "example"
+            }
+          ],
+          "docs": "The exposure time in seconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "fNumber",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "1.8",
+              "name": "example"
+            }
+          ],
+          "docs": "The F number (aperture) of the lens.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "flash",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            }
+          ],
+          "docs": "Whether or not the flash fired when the image was captured.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "focalLength",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "26",
+              "name": "example"
+            }
+          ],
+          "docs": "The focal length of the lens in millimeters.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "gpsAltitude",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "11.5",
+              "name": "example"
+            }
+          ],
+          "docs": "The altitude in meters above (positive) or below (negative) sea level.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "gpsLatitude",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "51.503364",
+              "name": "example"
+            }
+          ],
+          "docs": "The latitude in signed decimal degrees.\n\nPositive values are north of the equator, negative values are south.\nMust be provided together with `gpsLongitude`.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "gpsLongitude",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "-0.127625",
+              "name": "example"
+            }
+          ],
+          "docs": "The longitude in signed decimal degrees.\n\nPositive values are east of the prime meridian, negative values are west.\nMust be provided together with `gpsLatitude`.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "iso",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "125",
+              "name": "example"
+            }
+          ],
+          "docs": "The ISO speed rating (photographic sensitivity).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "lensModel",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'iPhone 15 Pro back triple camera 6.765mm f/1.78'",
+              "name": "example"
+            }
+          ],
+          "docs": "The model of the lens.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "make",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Apple'",
+              "name": "example"
+            }
+          ],
+          "docs": "The manufacturer of the camera.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "model",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'iPhone 15 Pro'",
+              "name": "example"
+            }
+          ],
+          "docs": "The model of the camera.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "orientation",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "6",
+              "name": "example"
+            }
+          ],
+          "docs": "The orientation of the image as defined by the EXIF specification (1-8).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "software",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Adobe Photoshop'",
+              "name": "example"
+            }
+          ],
+          "docs": "The name of the software that was used to create or edit the image.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}