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 6.0.0 is compatible with Capacitor 6

Plugin versions

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

Supported Platforms

• iOS
• Android

Installation

npm install @capacitor-community/exif
npx cap sync

Configuration

Android

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

setCoordinates(...)

setCoordinates(options: SetCoordinatesOptions) => Promise<void>

Set the coordinates to the image EXIF metadata.

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

Since: 6.0.0

getCoordinates(...)

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

Interfaces

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

Set coordinates to image file

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

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

Read coordinates from image file

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

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