Capacitor Exif Plugin

@capacitor-community/exif

Capacitor community plugin for interacting with image exif metadata

Table of Contents

- Maintainers
- About
- Plugin versions
- Supported Platforms
- Installation
- Configuration
- API
- Troubleshooting

Maintainers

| Maintainer | GitHub | Active |
| ---------- | ------------------------------- | ------ |
| ryaa | ryaa | yes |

About

This plugins allows reading and setting coordinates to image files.
This plugin has been primarity implemented to enhance other plugins which require coordinates to be added to images, for example https://github.com/capacitor-community/camera-preview/issues/164.

Features:

- support reading coordinates from image files
- support setting coordinates to image files
- supports Android and iOS platforms

NOTE: The plugin version 7.0.0 is compatible with Capacitor 7

Plugin versions

| Capacitor version | Plugin version |
| ----------------- | -------------- |
| 7.x | 7.x |
| 6.x | 6.x |

Supported Platforms

- iOS
- Android

Installation

``bash
npm install @capacitor-community/exif
npx cap sync
`

Configuration

$3

This plugin will use the following project variables (defined in your app's variables.gradle file):

`
androidxExifInterfaceVersion: version of androidx.exifinterface:exifinterface (default: 1.3.6)
`

API

* setCoordinates(...)
* getCoordinates(...)
* Interfaces

$3

`typescript
setCoordinates(options: SetCoordinatesOptions) => Promise
`

Set the coordinates to the image EXIF metadata.

| Param | Type |
| ------------- | ----------------------------------------------------------------------- |
| options | SetCoordinatesOptions |

Since: 6.0.0

--------------------

$3

`typescript
getCoordinates(options: GetCoordinatesOptions) => Promise<{ lat: number; lng: number; } | undefined>
`

Get the coordinates from the image EXIF metadata.

| Param | Type |
| ------------- | ----------------------------------------------------------------------- |
| options | GetCoordinatesOptions |

Returns: Promise<{ lat: number; lng: number; }>

Since: 6.0.0

--------------------

$3


#### SetCoordinatesOptions

| Prop | Type | Description | Since |
| ----------------- | ------------------- | ------------------------------------------------------------------ | ----- |
| pathToImage | string | The path to the image to set the coordinates to the EXIF metadata. | 6.0.0 |
| lat | number | The latitude of the image coordinates. | 6.0.0 |
| lng | number | The longitude of the image coordinates. | 6.0.0 |


#### GetCoordinatesOptions

| Prop | Type | Description | Since |
| ----------------- | ------------------- | ---------------------------------------------------------------- | ----- |
| pathToImage | string | The path to the image to get the coordinates from EXIF metadata. | 6.0.0 |

Usage

Please also see example-app for a complete example.

$3

`
import { Exif } from '@capacitor-community/exif';

const options: SetCoordinatesOptions = {
pathToImage,
lat,
lng
};
await this.exifPlugin.setCoordinates(options);
`

$3

`
import { Exif } from '@capacitor-community/exif';

const options: GetCoordinatesOptions = { pathToImage };
const coordinates: {
lat: number;
lng: number;
} | undefined = await this.exifPlugin.getCoordinates(options);
``