///
///
///
///
/**
* Type Definitions for Gjs (https://gjs.guide/)
*
* These type definitions are automatically generated, do not edit them by hand.
* If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
*
* The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
*/
declare module 'gi://GExiv2?version=0.10' {
// Module dependencies
import type Gio from 'gi://Gio?version=2.0';
import type GObject from 'gi://GObject?version=2.0';
import type GLib from 'gi://GLib?version=2.0';
import type GModule from 'gi://GModule?version=2.0';
export namespace GExiv2 {
/**
* GExiv2-0.10
*/
/**
* Options to control the byte order of binary EXIF data exports
*/
/**
* Options to control the byte order of binary EXIF data exports
*/
export namespace ByteOrder {
export const $gtype: GObject.GType;
}
enum ByteOrder {
/**
* Use little-endian byte order
*/
LITTLE,
/**
* Use big-endian byte order
*/
BIG,
}
/**
* GExiv2 log levels
*/
/**
* GExiv2 log levels
*/
export namespace LogLevel {
export const $gtype: GObject.GType;
}
enum LogLevel {
/**
* Log level for debugging
*/
DEBUG,
/**
* Log level for informational messages
*/
INFO,
/**
* Log level for warning messages
*/
WARN,
/**
* Log level for error messages
*/
ERROR,
/**
* Suppress all log messages
*/
MUTE,
}
/**
* The orientation of an image is defined as the location of it's x,y origin. More than rotation,
* orientation allows for every variation of rotation, flips, and mirroring to be described in
* 3 bits of data.
*
* A handy primer to orientation can be found at
*
*/
/**
* The orientation of an image is defined as the location of it's x,y origin. More than rotation,
* orientation allows for every variation of rotation, flips, and mirroring to be described in
* 3 bits of data.
*
* A handy primer to orientation can be found at
*
*/
export namespace Orientation {
export const $gtype: GObject.GType;
}
enum Orientation {
/**
* The orientation of the image is unknown
*/
UNSPECIFIED,
/**
* The orientation of the image is without any rotation.
*/
NORMAL,
/**
* The image is flipped on its horizontal axis
*/
HFLIP,
/**
* The image is rotated by 180 degrees
*/
ROT_180,
/**
* The Image is flipped on its vertical axis
*/
VFLIP,
/**
* The image is rotated by 90 degrees clockwise and flipped on its horizontal axis
*/
ROT_90_HFLIP,
/**
* The image is rotated by 90 degrees clockwise
*/
ROT_90,
/**
* The image is rotated by 90 degrees clockwise and flipped on its vertical axis
*/
ROT_90_VFLIP,
/**
* The image is rotated 270 degrees clockwise
*/
ROT_270,
}
/**
* Used in gexiv2_metadata_set_xmp_tag_struct() to determine the array type
*/
/**
* Used in gexiv2_metadata_set_xmp_tag_struct() to determine the array type
*/
export namespace StructureType {
export const $gtype: GObject.GType;
}
enum StructureType {
/**
* Structure is not an array
*/
NONE,
/**
* A list of alternative values
*/
ALT,
/**
* An unordered list of values
*/
BAG,
/**
* An ordered list of values
*/
SEQ,
/**
* Not supported. For completeness only
*/
LANG,
}
const MAJOR_VERSION: number;
const MICRO_VERSION: number;
const MINOR_VERSION: number;
function get_version(): number;
/**
* gexiv2 requires initialization before its methods are used. In particular, this call must be
* made in a thread-safe fashion. Best practice is to call from the application's main thread and
* not to use any Gexiv2 code until it has returned.
* @returns %TRUE if initialized. If %FALSE, GExiv2 should not be used (unable to initialize properly).
*/
function initialize(): boolean;
function log_get_level(): LogLevel;
/**
* Log messages below this level will not be logged.
* @param level The #GExiv2LogLevel gexiv2 should respect.
*/
function log_set_level(level: LogLevel | null): void;
/**
* When called, gexiv2 will install it's own #GExiv2LogHandler which redirects all Exiv2 and gexiv2
* log messages to GLib's logging calls (g_debug(), g_message(), g_warning(), and g_critical() for the
* respective #GExiv2LogLevel value). #GEXIV2_LOG_LEVEL_MUTE logs are dropped.
*
* One advantage to using this is that GLib's logging control and handlers can be used rather than
* GExiv2's ad hoc scheme. It also means an application can use GLib logging and have all its
* messages routed through the same calls.
*/
function log_use_glib_logging(): void;
interface LogHandler {
(level: LogLevel, msg: string): void;
}
/**
* Options to control the format of the serialized XMP packet
* Taken from: exiv2/src/xmp.hpp
*/
/**
* Options to control the format of the serialized XMP packet
* Taken from: exiv2/src/xmp.hpp
*/
export namespace XmpFormatFlags {
export const $gtype: GObject.GType;
}
enum XmpFormatFlags {
/**
* Omit the XML packet wrapper.
*/
OMIT_PACKET_WRAPPER,
/**
* Default is a writeable packet.
*/
READ_ONLY_PACKET,
/**
* Use a compact form of RDF.
*/
USE_COMPACT_FORMAT,
/**
* Include a padding allowance for a thumbnail image.
*/
INCLUDE_THUMBNAIL_PAD,
/**
* The padding parameter is the overall packet length.
*/
EXACT_PACKET_LENGTH,
/**
* Show aliases as XML comments.
*/
WRITE_ALIAS_COMMENTS,
/**
* Omit all formatting whitespace.
*/
OMIT_ALL_FORMATTING,
}
namespace Metadata {
// Constructor properties interface
interface ConstructorProps extends GObject.Object.ConstructorProps {}
}
/**
* An object holding all the Exiv2 metadata. Previews, if present, are also available.
*
* As gexiv2 is only a wrapper around Exiv2, it's better to read its documentation to understand
* the full scope of what it offers:
*
* In particular, rather than providing a getter/setter method pair for every metadata value
* available for images (of which there are thousands), Exiv2 uses a dotted addressing scheme.
* For example, to access a photo's EXIF Orientation field, the caller passes to Exiv2
* "Exif.Photo.Orientation". These tags (in Exiv2 parlance) are key to using Exiv2 (and
* therefore gexiv2) to its fullest.
*
* A full reference for all supported Exiv2 tags can be found at
*
*/
class Metadata extends GObject.Object {
static $gtype: GObject.GType;
// Constructors
constructor(properties?: Partial, ...args: any[]);
_init(...args: any[]): void;
static ['new'](): Metadata;
// Static methods
/**
* The Exiv2 Tag Reference can be found at
* @param tag An Exiv2 tag
*/
static get_tag_description(tag: string): string | null;
/**
* The Exiv2 Tag Reference can be found at
* @param tag An Exiv2 tag
*/
static get_tag_label(tag: string): string | null;
/**
* The names of the various Exiv2 tag types can be found at Exiv2::TypeId,
*
*
* The Exiv2 Tag Reference can be found at
* @param tag An Exiv2 tag
*/
static get_tag_type(tag: string): string | null;
static get_xmp_namespace_for_tag(tag: string): string;
/**
* The Exiv2 Tag Reference can be found at
* @param tag An Exiv2 tag
*/
static is_exif_tag(tag: string): boolean;
/**
* The Exiv2 Tag Reference can be found at
* @param tag An Exiv2 tag
*/
static is_iptc_tag(tag: string): boolean;
/**
* The Exiv2 Tag Reference can be found at
* @param tag An Exiv2 tag
*/
static is_xmp_tag(tag: string): boolean;
static register_xmp_namespace(name: string, prefix: string): boolean;
/**
* The Exiv2 Tag Reference can be found at
* @param tag An Exiv2 tag
*/
static try_get_tag_description(tag: string): string | null;
/**
* The Exiv2 Tag Reference can be found at
* @param tag An Exiv2 tag
*/
static try_get_tag_label(tag: string): string | null;
/**
* The names of the various Exiv2 tag types can be found at Exiv2::TypeId,
*
*
* The Exiv2 Tag Reference can be found at
* @param tag An Exiv2 tag
*/
static try_get_tag_type(tag: string): string | null;
static try_get_xmp_namespace_for_tag(tag: string): string;
static try_register_xmp_namespace(name: string, prefix: string): boolean;
static try_unregister_all_xmp_namespaces(): void;
static try_unregister_xmp_namespace(name: string): boolean;
static unregister_all_xmp_namespaces(): void;
static unregister_xmp_namespace(name: string): boolean;
// Methods
/**
* Removes all tags for all domains (EXIF, IPTC, and XMP).
*/
clear(): void;
/**
* This is a composite clear method that will clear a number of fields. See
* #gexiv2_metadata_get_comment for more information.
*/
clear_comment(): void;
/**
* Clears all EXIF metadata from the loaded image.
*/
clear_exif(): void;
/**
* Clears all IPTC metadata from the loaded image.
*/
clear_iptc(): void;
/**
* Removes the Exiv2 tag from the metadata object.
*
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag
* @returns TRUE if the tag was present.
*/
clear_tag(tag: string): boolean;
/**
* Clears all XMP metadata from the loaded image.
*/
clear_xmp(): void;
/**
* Removes all GPS metadata from the loaded image
*/
delete_gps_info(): void;
/**
* Removes the EXIF thumbnail from the loaded image.
*/
erase_exif_thumbnail(): void;
/**
* Destroys the #GExiv2Metadata object and frees all associated memory.
*/
free(): void;
/**
* Load only an EXIF buffer, typically stored in a JPEG's APP1 segment.
* @param data A buffer containing the data to be read
* @returns Boolean success indicator.
*/
from_app1_segment(data: Uint8Array | string): boolean;
/**
* This function does not work and will be removed in a future release.
* @param stream
*/
from_stream(stream: Gio.InputStream): boolean;
/**
* Encode the XMP packet as a %NULL-terminated string.
* @param xmp_format_flags One of #GExiv2XmpFormatFlags
* @param padding The padding (FIXME: Add documentation)
* @returns Encode the XMP packet and return as a %NULL-terminated string.
*/
generate_xmp_packet(xmp_format_flags: XmpFormatFlags | null, padding: number): string | null;
/**
* A composite accessor that uses the first available metadata field from a list of well-known
* locations to find the photo's comment (or description).
*
* MWG guidelines refer to these as Description: a textual description of a resource's content.
*
* These fields are:
*
* - Exif.Image.ImageDescription (MWG Guidelines)
* - Exif.Photo.UserComment
* - Exif.Image.XPComment
* - Iptc.Application2.Caption (MWG Guidelines)
* - Xmp.dc.description (MWG Guidelines)
* - Xmp.acdsee.notes (Commonly requested, read only)
*
* Note that in the EXIF specification Exif.Image.ImageDescription is
* described as "the title of the image". Also, it does not support
* two-byte character codes for encoding. However, it's still used here for legacy reasons.
*
*
* For fine-grained control, it's recommended to use Exiv2 tags directly rather than this method,
* which is more useful for quick or casual use.
* @returns The photo's comment field.
*/
get_comment(): string | null;
get_exif_data(byte_order: ByteOrder | null): GLib.Bytes | null;
/**
* Fetch EXIF `tag` represented by a fraction. `nom` will contain the numerator,
* `den` the denominator of the fraction on successful return.
* @param tag The tag you want the rational value for
* @returns Boolean success value
*/
get_exif_tag_rational(tag: string): [boolean, number, number];
/**
* Query `self` for a list of available EXIF tags
* @returns A unique list of the available EXIF tags in the loaded image
*/
get_exif_tags(): string[];
/**
* Get the thumbnail stored in the EXIF data of `self`
* @returns Boolean success value
*/
get_exif_thumbnail(): [boolean, Uint8Array];
/**
* Returns the exposure time in seconds (shutter speed, not date-time of exposure) as a
* rational. See for more information.
* @returns Boolean success value
*/
get_exposure_time(): [boolean, number, number];
/**
* See for more information.
* If Exif.Photo.FNumber does not exist, it will fall back to calculating the FNumber from
* Exif.Photo.ApertureValue (if available);
* @returns The exposure Fnumber as a gdouble, or -1.0 if tag is not present or invalid.
*/
get_fnumber(): number;
/**
* See for more information.
* @returns The focal length as a gdouble, or -1.0 if tag is not present or invalid.
*/
get_focal_length(): number;
/**
* Convenience function to query the altitude stored in the GPS tags of the
* image
* @returns Boolean success value
*/
get_gps_altitude(): [boolean, number];
/**
* Convenience function to query all available GPS information at once.
* @returns Boolean success value.
*/
get_gps_info(): [boolean, number, number, number];
/**
* Query the latitude stored in the GPS tags of `self`
* @returns Boolean success value
*/
get_gps_latitude(): [boolean, number];
/**
* Query the longitude stored in the GPS tags of `self`
* @returns Boolean success value
*/
get_gps_longitude(): [boolean, number];
/**
* Query `self` for a list of available IPTC tags
* @returns A unique list of the available IPTC tags
*/
get_iptc_tags(): string[];
/**
* See for more information.
* @returns The ISO speed rating as a gint, or 0 if tag is not present or invalid.
*/
get_iso_speed(): number;
/**
* Composite accessor to query the pixel with stored in the metadata. This
* might differ from the height of image that is available through
* gexiv2_metadata_get_pixel_height()
* @returns Height of images in pixels as stored in the metadata
*/
get_metadata_pixel_height(): number;
/**
* Composite accessor to query the pixel with stored in the metadata. This
* might differ from the width of image that is available through
* gexiv2_metadata_get_pixel_width()
* @returns Width of images in pixels as stored in the metadata
*/
get_metadata_pixel_width(): number;
/**
* Query mime type of currently loaded image.
* @returns The MIME type of the loaded image, %NULL if not loaded or unknown.
*/
get_mime_type(): string;
/**
* The EXIF Orientation field
* @returns A #GExiv2Orientation value representing the EXIF orientation value.
*/
get_orientation(): Orientation;
/**
* Get the actual unoriented display height in pixels of the loaded image. This may
* be different than the height reported by various metadata tags, i.e. "Exif.Photo.PixelYDimension".
* @returns Pixel height of current image
*/
get_pixel_height(): number;
/**
* Get the actual unoriented display width in pixels of the loaded
* image. May be different than the width reported by various metadata tags,
* i.e. "Exif.Photo.PixelXDimension".
* @returns Pixel width of current image
*/
get_pixel_width(): number;
get_preview_image(props: PreviewProperties): PreviewImage;
/**
* An image may have stored one or more previews, often of different qualities, sometimes of
* different image formats than the containing image. This call returns the properties of all
* previews Exiv2 finds within the loaded image. Use #gexiv2_metadata_get_preview_image to
* load a particular preview into memory.
* @returns An array of #GExiv2PreviewProperties instances, one for each preview present in the loaded image.
*/
get_preview_properties(): PreviewProperties[] | null;
/**
* Query `self` whether it supports writing EXIF metadata.
* @returns %TRUE if the loaded image type supports writing EXIF metadata.
*/
get_supports_exif(): boolean;
/**
* Query `self` whether it supports writing IPTC metadata.
* @returns %TRUE if the loaded image type supports writing IPTC metadata.
*/
get_supports_iptc(): boolean;
/**
* Query `self` whether it supports writing XMP metadata.
* @returns %TRUE if the loaded image type supports writing XMP metadata.
*/
get_supports_xmp(): boolean;
/**
* An interpreted string is one fit for user display. It may display units or use formatting
* appropriate to the type of data the tag holds.
*
* Tags that support multiple values are returned as a single string, with elements separated by ", ".
*
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag name
* @returns The tag's interpreted value as a string
*/
get_tag_interpreted_string(tag: string): string | null;
/**
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag name
* @returns The tag's value as a glong
*/
get_tag_long(tag: string): number;
/**
* The Exiv2 Tag Reference can be found at
*
* In case of error, a GLib warning will be logged. Use instead
* gexiv2_metadata_try_get_tag_multiple() if you want to avoid this and
* control if and how the error is outputted.
* @param tag Exiv2 tag name
* @returns The multiple string values of the tag. Returns %NULL if parameters are %NULL or @tag does not begin with recognised type of metadata ("Exif.", "Xmp." or "Iptc."). For a well formed @tag, returns array[0] = %NULL if @tag is undefined or is not set in the current metadata. (Note: xmpText/langAlt bug is fixed in gexiv2_metadata_try_get_tag_multiple())
*/
get_tag_multiple(tag: string): string[] | null;
/**
* The Exiv2 Tag Reference can be found at
*
* Tags that support multiple values may bereturned as a single byte array, with records separated
* by 4x INFORMATION SEPARATOR FOUR (ASCII 0x1c)
* @param tag Exiv2 tag name
* @returns The tag's raw value as a byte array
*/
get_tag_raw(tag: string): GLib.Bytes | null;
/**
* The Exiv2 Tag Reference can be found at
*
* Tags that support multiple values are returned as a single string, with elements separated by ", ".
*
* In case of error, a GLib warning will be logged. Use instead
* gexiv2_metadata_try_get_tag_string() if you want to avoid this and
* control if and how the error is outputted.
* @param tag Exiv2 tag name
* @returns The tag's value as a string
*/
get_tag_string(tag: string): string | null;
get_xmp_packet(): string | null;
get_xmp_tags(): string[];
has_exif(): boolean;
has_iptc(): boolean;
/**
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag
* @returns TRUE if the tag is present.
*/
has_tag(tag: string): boolean;
has_xmp(): boolean;
/**
* The buffer must be an image format supported by Exiv2.
* @param data A buffer containing the data to be read
* @returns Boolean success indicator
*/
open_buf(data: Uint8Array | string): boolean;
/**
* The file must be an image format supported by Exiv2.
* @param path Path to the file you want to open
* @returns Boolean success indicator
*/
open_path(path: string): boolean;
/**
* Saves the metadata to the specified using an XMP sidecar file.
* @param path Path to the file you want to save to.
* @returns Boolean success indicator.
*/
save_external(path: string): boolean;
/**
* Saves the metadata to the specified file by reading the file into memory,copying this object's
* metadata into the image, then writing the image back out.
* @param path Path to the file you want to save to.
* @returns Boolean success indicator.
*/
save_file(path: string): boolean;
/**
* This is a composite setter that will set a number of fields to the supplied value. See
* #gexiv2_metadata_get_comment for more information.
* @param comment Comment string to set. Must not be %NULL
*/
set_comment(comment: string): void;
/**
* Set EXIF `tag` represented by a fraction, with `nom` being the numerator,
* `den` the denominator of the fraction.
* @param tag The Exiv2 tag
* @param nom Rational numerator
* @param den Rational denominator
* @returns Boolean success value
*/
set_exif_tag_rational(tag: string, nom: number, den: number): boolean;
set_exif_thumbnail_from_buffer(buffer: Uint8Array | string): void;
/**
* Sets or replaces the EXIF thumbnail with the image in the file
* @param path Path of image file
* @returns Boolean success value
*/
set_exif_thumbnail_from_file(path: string): boolean;
/**
* Convenience function to create a new set of simple GPS data. Warning: Will remove any other
* GPS information that is currently set. See gexiv2_metadata_update_gps_info() for
* just modifying the GPS data.
* @param longitude Longitude value to set or replace current value
* @param latitude Latitude value to set or replace current value
* @param altitude Altitude value to set or replace current value
* @returns Boolean success value.
*/
set_gps_info(longitude: number, latitude: number, altitude: number): boolean;
/**
* Update the image's metadata with `height`
* @param height The width of the image as it should be put into the metadata.
*/
set_metadata_pixel_height(height: number): void;
/**
* Composite setter to update the image's metadata with `width`
* @param width The width of the image as it should be put into the metadata
*/
set_metadata_pixel_width(width: number): void;
/**
* The orientation must be valid and cannot be #GEXIV2_ORIENTATION_UNSPECIFIED.
* @param orientation The new #GExiv2Orientation for the image.
*/
set_orientation(orientation: Orientation | null): void;
/**
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag name
* @param value The value to set or replace the existing value
* @returns TRUE on success
*/
set_tag_long(tag: string, value: number): boolean;
/**
* The Exiv2 Tag Reference can be found at
*
* All previous `tag` values are erased. For multiple value tags, each of the non %NULL
* entries in `values` is stored. For single value tags, only the last non %NULL value
* is assigned.
*
* In case of error, a GLib warning will be logged. Use instead
* gexiv2_metadata_try_set_tag_multiple() if you want to avoid this and
* control if and how the error is outputted.
* @param tag Exiv2 tag name
* @param values An array of values to set or replace the existing value(s)
* @returns Boolean success value
*/
set_tag_multiple(tag: string, values: string[]): boolean;
/**
* The Exiv2 Tag Reference can be found at
*
* If a tag supports multiple values, then `value` is added to any existing values. For single
* value tags, `value` replaces the value.
*
* In case of error, a GLib warning will be logged. Use instead
* gexiv2_metadata_try_set_tag_string() if you want to avoid this and
* control if and how the error is outputted.
* @param tag Exiv2 tag name
* @param value The value to set or replace the existing value
* @returns TRUE on success
*/
set_tag_string(tag: string, value: string): boolean;
/**
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag name
* @param type The GExiv2StructureType specifying the type of structure
* @returns TRUE on success
*/
set_xmp_tag_struct(tag: string, type: StructureType | null): boolean;
/**
* Removes the Exiv2 tag from the metadata object.
*
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag
* @returns TRUE if the tag was present.
*/
try_clear_tag(tag: string): boolean;
/**
* Removes all GPS metadata from the loaded image
*/
try_delete_gps_info(): void;
/**
* Removes the EXIF thumbnail from the loaded image.
*/
try_erase_exif_thumbnail(): void;
/**
* Encode the XMP packet as a %NULL-terminated string.
* @param xmp_format_flags One of #GExiv2XmpFormatFlags
* @param padding The padding (FIXME: Add documentation)
* @returns Encode the XMP packet and return as a %NULL-terminated string.
*/
try_generate_xmp_packet(xmp_format_flags: XmpFormatFlags | null, padding: number): string | null;
/**
* A composite accessor that uses the first available metadata field from a list of well-known
* locations to find the photo's comment (or description).
*
* MWG guidelines refer to these as Description: a textual description of a resource's content.
*
* These fields are:
*
* - Exif.Image.ImageDescription (MWG Guidelines)
* - Exif.Photo.UserComment
* - Exif.Image.XPComment
* - Iptc.Application2.Caption (MWG Guidelines)
* - Xmp.dc.description (MWG Guidelines)
* - Xmp.acdsee.notes (Commonly requested, read only)
*
* Note that in the EXIF specification Exif.Image.ImageDescription is
* described as "the title of the image". Also, it does not support
* two-byte character codes for encoding. However, it's still used here for legacy reasons.
*
*
* For fine-grained control, it's recommended to use Exiv2 tags directly rather than this method,
* which is more useful for quick or casual use.
* @returns The photo's comment field.
*/
try_get_comment(): string | null;
/**
* Fetch EXIF `tag` represented by a fraction. `nom` will contain the numerator,
* `den` the denominator of the fraction on successful return.
* @param tag The tag you want the rational value for
* @returns Boolean success value
*/
try_get_exif_tag_rational(tag: string): [boolean, number, number];
/**
* Returns the exposure time in seconds (shutter speed, not date-time of exposure) as a
* rational. See for more information.
* @returns Boolean success value
*/
try_get_exposure_time(): [boolean, number, number];
/**
* See for more information.
* If Exif.Photo.FNumber does not exist, it will fall back to calculating the FNumber from
* Exif.Photo.ApertureValue (if available);
* @returns The exposure Fnumber as a gdouble, or -1.0 if tag is not present or invalid.
*/
try_get_fnumber(): number;
/**
* See for more information.
* @returns The focal length as a gdouble, or -1.0 if tag is not present or invalid.
*/
try_get_focal_length(): number;
/**
* Convenience function to query the altitude stored in the GPS tags of the
* image
* @returns Boolean success value
*/
try_get_gps_altitude(): [boolean, number];
/**
* Convenience function to query all available GPS information at once.
* @returns Boolean success value.
*/
try_get_gps_info(): [boolean, number, number, number];
/**
* Query the latitude stored in the GPS tags of `self`
* @returns Boolean success value
*/
try_get_gps_latitude(): [boolean, number];
/**
* Query the longitude stored in the GPS tags of `self`
* @returns Boolean success value
*/
try_get_gps_longitude(): [boolean, number];
/**
* See for more information.
* @returns The ISO speed rating as a gint, or 0 if tag is not present or invalid.
*/
try_get_iso_speed(): number;
/**
* Composite accessor to query the pixel with stored in the metadata. This
* might differ from the height of image that is available through
* gexiv2_metadata_get_pixel_height()
* @returns Height of images in pixels as stored in the metadata
*/
try_get_metadata_pixel_height(): number;
/**
* Composite accessor to query the pixel with stored in the metadata. This
* might differ from the width of image that is available through
* gexiv2_metadata_get_pixel_width()
* @returns Width of images in pixels as stored in the metadata
*/
try_get_metadata_pixel_width(): number;
/**
* The EXIF Orientation field
* @returns A #GExiv2Orientation value representing the EXIF orientation value.
*/
try_get_orientation(): Orientation;
try_get_preview_image(props: PreviewProperties): PreviewImage;
/**
* An interpreted string is one fit for user display. It may display units or use formatting
* appropriate to the type of data the tag holds.
*
* Tags that support multiple values are returned as a single string, with elements separated by ", ".
*
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag name
* @returns The tag's interpreted value as a string
*/
try_get_tag_interpreted_string(tag: string): string | null;
/**
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag name
* @returns The tag's value as a glong
*/
try_get_tag_long(tag: string): number;
/**
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag name
* @returns The multiple string values of @tag. Returns %NULL if parameters are %NULL or @tag does not begin with recognised type of metadata ("Exif.", "Xmp." or "Iptc."). For a well formed @tag, returns array[0] = %NULL if @tag is undefined or is not set in the current metadata.
*/
try_get_tag_multiple(tag: string): string[] | null;
/**
* The Exiv2 Tag Reference can be found at
*
* Tags that support multiple values may be returned as a single byte array, with records separated
* by 4x INFORMATION SEPARATOR FOUR (ASCII 0x1c)
* @param tag Exiv2 tag name
* @returns The tag's raw value as a byte array
*/
try_get_tag_raw(tag: string): GLib.Bytes | null;
/**
* The Exiv2 Tag Reference can be found at
*
* Tags that support multiple values are returned as a single string, with elements separated by ", ".
* @param tag Exiv2 tag name
* @returns The tag's value as a string
*/
try_get_tag_string(tag: string): string | null;
try_get_xmp_packet(): string | null;
/**
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag
* @returns TRUE if the tag is present.
*/
try_has_tag(tag: string): boolean;
/**
* This is a composite setter that will set a number of fields to the supplied value. See
* #gexiv2_metadata_get_comment for more information.
* @param comment Comment string to set. Must not be %NULL
*/
try_set_comment(comment: string): void;
/**
* Set EXIF `tag` represented by a fraction, with `nom` being the numerator,
* `den` the denominator of the fraction.
* @param tag The Exiv2 tag
* @param nom Rational numerator
* @param den Rational denominator
* @returns Boolean success value
*/
try_set_exif_tag_rational(tag: string, nom: number, den: number): boolean;
try_set_exif_thumbnail_from_buffer(buffer: Uint8Array | string): void;
/**
* Convenience function to create a new set of simple GPS data. Warning: Will remove any other
* GPS information that is currently set. See gexiv2_metadata_update_gps_info() for
* just modifying the GPS data.
* @param longitude Longitude value to set or replace current value
* @param latitude Latitude value to set or replace current value
* @param altitude Altitude value to set or replace current value
* @returns Boolean success value.
*/
try_set_gps_info(longitude: number, latitude: number, altitude: number): boolean;
/**
* Update the image's metadata with `height`
* @param height The width of the image as it should be put into the metadata.
*/
try_set_metadata_pixel_height(height: number): void;
/**
* Composite setter to update the image's metadata with `width`
* @param width The width of the image as it should be put into the metadata
*/
try_set_metadata_pixel_width(width: number): void;
/**
* The orientation must be valid and cannot be #GEXIV2_ORIENTATION_UNSPECIFIED.
* @param orientation The new #GExiv2Orientation for the image.
*/
try_set_orientation(orientation: Orientation | null): void;
/**
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag name
* @param value The value to set or replace the existing value
* @returns TRUE on success
*/
try_set_tag_long(tag: string, value: number): boolean;
/**
* The Exiv2 Tag Reference can be found at
*
* All previous `tag` values are erased. For multiple value tags, each of the non %NULL
* entries in `values` is stored. For single value tags, only the last non %NULL value
* is assigned.
* @param tag Exiv2 tag name
* @param values An array of values to set or replace the existing value(s)
* @returns Boolean success value
*/
try_set_tag_multiple(tag: string, values: string[]): boolean;
/**
* If a tag supports multiple values, then `value` is added to any existing values. For single
* tags, `value` replaces the value.
*
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag name
* @param value The value to set or replace the existing value
* @returns TRUE on success
*/
try_set_tag_string(tag: string, value: string): boolean;
/**
* The Exiv2 Tag Reference can be found at
* @param tag Exiv2 tag name
* @param type The GExiv2StructureType specifying the type of structure
* @returns TRUE on success
*/
try_set_xmp_tag_struct(tag: string, type: StructureType | null): boolean;
/**
* The Exiv2 Tag Reference can be found at
*
* Multiple value tags are Xmp tags of type "XmpAlt", "XmpBag", "XmpSeq" or "LangAlt", or Iptc
* tags marked as Repeatable (which can be of any Iptc type). There are no multiple value Exif
* tags.
* @param tag An Exiv2 tag
* @returns Whether @tag is capable of storing multiple values or not. If @tag is undefined (i.e. not built-in and not added to @self), then @error is set and %FALSE is returned.
*/
try_tag_supports_multiple_values(tag: string): boolean;
/**
* Convenience function to update longitude, latitude and altitude at once.
* @param longitude Longitude value to set or replace current value
* @param latitude Latitude value to set or replace current value
* @param altitude Altitude value to set or replace current value
* @returns Boolean success value.
*/
try_update_gps_info(longitude: number, latitude: number, altitude: number): boolean;
/**
* Convenience function to update longitude, latitude and altitude at once.
* @param longitude Longitude value to set or replace current value
* @param latitude Latitude value to set or replace current value
* @param altitude Altitude value to set or replace current value
* @returns Boolean success value.
*/
update_gps_info(longitude: number, latitude: number, altitude: number): boolean;
}
namespace PreviewImage {
// Constructor properties interface
interface ConstructorProps extends GObject.Object.ConstructorProps {}
}
class PreviewImage extends GObject.Object {
static $gtype: GObject.GType;
// Constructors
constructor(properties?: Partial, ...args: any[]);
_init(...args: any[]): void;
// Methods
/**
* Releases the preview image and all associated memory.
*/
free(): void;
get_data(): Uint8Array;
// Conflicted with GObject.Object.get_data
get_data(...args: never[]): any;
get_extension(): string;
get_height(): number;
get_mime_type(): string;
get_width(): number;
try_write_file(path: string): number;
write_file(path: string): number;
}
namespace PreviewProperties {
// Constructor properties interface
interface ConstructorProps extends GObject.Object.ConstructorProps {}
}
class PreviewProperties extends GObject.Object {
static $gtype: GObject.GType;
// Constructors
constructor(properties?: Partial, ...args: any[]);
_init(...args: any[]): void;
// Methods
get_extension(): string;
get_height(): number;
get_mime_type(): string;
get_size(): number;
get_width(): number;
}
type MetadataClass = typeof Metadata;
abstract class MetadataPrivate {
static $gtype: GObject.GType;
// Constructors
_init(...args: any[]): void;
}
type PreviewImageClass = typeof PreviewImage;
abstract class PreviewImagePrivate {
static $gtype: GObject.GType;
// Constructors
_init(...args: any[]): void;
}
type PreviewPropertiesClass = typeof PreviewProperties;
abstract class PreviewPropertiesPrivate {
static $gtype: GObject.GType;
// Constructors
_init(...args: any[]): void;
}
/**
* Name of the imported GIR library
* `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
*/
const __name__: string;
/**
* Version of the imported GIR library
* `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
*/
const __version__: string;
}
export default GExiv2;
}
declare module 'gi://GExiv2' {
import GExiv2010 from 'gi://GExiv2?version=0.10';
export default GExiv2010;
}
// END