Gjsify LogoGjsify Logo

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

g_type_instance: TypeInstance
parent_instance: GObject.Object
name: string

Methods

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transform_from: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • clear(): void
  • clear_comment(): void
  • This is a composite clear method that will clear a number of fields. See #gexiv2_metadata_get_comment for more information.

    Returns void

  • clear_exif(): void
  • clear_iptc(): void
  • clear_tag(tag: string): boolean
  • Removes the Exiv2 tag from the metadata object.

    The Exiv2 Tag Reference can be found at

    Parameters

    • tag: string

      Exiv2 tag

    Returns boolean

  • clear_xmp(): void
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • delete_gps_info(): void
  • disconnect(id: number): void
  • emit(sigName: string, ...args: any[]): void
  • erase_exif_thumbnail(): void
  • force_floating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • free(): void
  • freeze_notify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • from_app1_segment(data: Uint8Array): boolean
  • Load only an EXIF buffer, typically stored in a JPEG's APP1 segment.

    Parameters

    • data: Uint8Array

      A buffer containing the data to be read

    Returns boolean

  • generate_xmp_packet(xmp_format_flags: XmpFormatFlags, padding: number): string
  • Encode the XMP packet as a %NULL-terminated string.

    Parameters

    • xmp_format_flags: XmpFormatFlags

      One of #GExiv2XmpFormatFlags

    • padding: number

      The padding (FIXME: Add documentation)

    Returns string

  • get_comment(): string
  • 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 string

  • get_data(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • get_exif_tag_rational(tag: string): [boolean, number, number]
  • Fetch EXIF tag represented by a fraction. nom will contain the numerator, den the denominator of the fraction on successful return.

    Parameters

    • tag: string

      The tag you want the rational value for

    Returns [boolean, number, number]

  • get_exif_tags(): string[]
  • get_exif_thumbnail(): [boolean, Uint8Array]
  • get_exposure_time(): [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, number, number]

  • get_fnumber(): 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 number

  • get_focal_length(): number
  • get_gps_altitude(): [boolean, number]
  • get_gps_info(): [boolean, number, number, number]
  • get_gps_latitude(): [boolean, number]
  • get_gps_longitude(): [boolean, number]
  • get_iptc_tags(): string[]
  • get_iso_speed(): number
  • get_metadata_pixel_height(): 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 number

  • get_metadata_pixel_width(): 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 number

  • get_mime_type(): string
  • get_pixel_height(): number
  • 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 number

  • get_pixel_width(): 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 number

  • 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 PreviewProperties[]

  • get_property(property_name?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • get_supports_exif(): boolean
  • get_supports_iptc(): boolean
  • get_supports_xmp(): boolean
  • get_tag_interpreted_string(tag: string): string
  • 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

    Parameters

    • tag: string

      Exiv2 tag name

    Returns string

  • get_tag_long(tag: string): number
  • get_tag_multiple(tag: string): string[]
  • 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.

    Parameters

    • tag: string

      Exiv2 tag name

    Returns string[]

  • get_tag_raw(tag: string): Bytes
  • 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)

    Parameters

    • tag: string

      Exiv2 tag name

    Returns Bytes

  • get_tag_string(tag: string): string
  • 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.

    Parameters

    • tag: string

      Exiv2 tag name

    Returns string

  • get_xmp_packet(): string
  • get_xmp_tags(): string[]
  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • has_exif(): boolean
  • has_iptc(): boolean
  • has_tag(tag: string): boolean
  • has_xmp(): boolean
  • is_floating(): boolean
  • notify(property_name: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • open_buf(data: Uint8Array): boolean
  • The buffer must be an image format supported by Exiv2.

    Parameters

    • data: Uint8Array

      A buffer containing the data to be read

    Returns boolean

  • open_path(path: string): boolean
  • The file must be an image format supported by Exiv2.

    Parameters

    • path: string

      Path to the file you want to open

    Returns boolean

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • run_dispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • save_external(path: string): boolean
  • Saves the metadata to the specified using an XMP sidecar file.

    Parameters

    • path: string

      Path to the file you want to save to.

    Returns boolean

  • save_file(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.

    Parameters

    • path: string

      Path to the file you want to save to.

    Returns boolean

  • set_comment(comment: string): void
  • This is a composite setter that will set a number of fields to the supplied value. See #gexiv2_metadata_get_comment for more information.

    Parameters

    • comment: string

      Comment string to set. Must not be %NULL

    Returns void

  • set_data(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • set_exif_tag_rational(tag: string, nom: number, den: number): boolean
  • Set EXIF tag represented by a fraction, with nom being the numerator, den the denominator of the fraction.

    Parameters

    • tag: string

      The Exiv2 tag

    • nom: number

      Rational numerator

    • den: number

      Rational denominator

    Returns boolean

  • set_exif_thumbnail_from_buffer(buffer: Uint8Array): void
  • set_exif_thumbnail_from_file(path: string): boolean
  • Sets or replaces the EXIF thumbnail with the image in the file

    Parameters

    • path: string

      Path of image file

    Returns boolean

  • set_gps_info(longitude: number, latitude: number, altitude: number): 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.

    Parameters

    • longitude: number

      Longitude value to set or replace current value

    • latitude: number

      Latitude value to set or replace current value

    • altitude: number

      Altitude value to set or replace current value

    Returns boolean

  • set_metadata_pixel_height(height: number): void
  • Update the image's metadata with height

    Parameters

    • height: number

      The width of the image as it should be put into the metadata.

    Returns void

  • set_metadata_pixel_width(width: number): void
  • Composite setter to update the image's metadata with width

    Parameters

    • width: number

      The width of the image as it should be put into the metadata

    Returns void

  • set_property(property_name: string, value?: any): void
  • set_tag_long(tag: string, value: number): boolean
  • The Exiv2 Tag Reference can be found at

    Parameters

    • tag: string

      Exiv2 tag name

    • value: number

      The value to set or replace the existing value

    Returns boolean

  • set_tag_multiple(tag: string, values: string[]): 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.

    Parameters

    • tag: string

      Exiv2 tag name

    • values: string[]

      An array of values to set or replace the existing value(s)

    Returns boolean

  • set_tag_string(tag: string, value: 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.

    Parameters

    • tag: string

      Exiv2 tag name

    • value: string

      The value to set or replace the existing value

    Returns boolean

  • steal_data(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • steal_qdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thaw_notify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • try_clear_tag(tag: string): boolean
  • Removes the Exiv2 tag from the metadata object.

    The Exiv2 Tag Reference can be found at

    Parameters

    • tag: string

      Exiv2 tag

    Returns boolean

  • try_delete_gps_info(): void
  • try_erase_exif_thumbnail(): void
  • try_generate_xmp_packet(xmp_format_flags: XmpFormatFlags, padding: number): string
  • Encode the XMP packet as a %NULL-terminated string.

    Parameters

    • xmp_format_flags: XmpFormatFlags

      One of #GExiv2XmpFormatFlags

    • padding: number

      The padding (FIXME: Add documentation)

    Returns string

  • try_get_comment(): string
  • 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 string

  • try_get_exif_tag_rational(tag: string): [boolean, number, number]
  • Fetch EXIF tag represented by a fraction. nom will contain the numerator, den the denominator of the fraction on successful return.

    Parameters

    • tag: string

      The tag you want the rational value for

    Returns [boolean, number, number]

  • try_get_exposure_time(): [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, number, number]

  • try_get_fnumber(): 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 number

  • try_get_focal_length(): number
  • try_get_gps_altitude(): [boolean, number]
  • try_get_gps_info(): [boolean, number, number, number]
  • try_get_gps_latitude(): [boolean, number]
  • try_get_gps_longitude(): [boolean, number]
  • try_get_iso_speed(): number
  • try_get_metadata_pixel_height(): 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 number

  • try_get_metadata_pixel_width(): 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 number

  • try_get_tag_interpreted_string(tag: string): string
  • 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

    Parameters

    • tag: string

      Exiv2 tag name

    Returns string

  • try_get_tag_long(tag: string): number
  • try_get_tag_multiple(tag: string): string[]
  • try_get_tag_raw(tag: string): Bytes
  • 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)

    Parameters

    • tag: string

      Exiv2 tag name

    Returns Bytes

  • try_get_tag_string(tag: string): string
  • The Exiv2 Tag Reference can be found at

    Tags that support multiple values are returned as a single string, with elements separated by ", ".

    Parameters

    • tag: string

      Exiv2 tag name

    Returns string

  • try_get_xmp_packet(): string
  • try_has_tag(tag: string): boolean
  • try_set_comment(comment: string): void
  • This is a composite setter that will set a number of fields to the supplied value. See #gexiv2_metadata_get_comment for more information.

    Parameters

    • comment: string

      Comment string to set. Must not be %NULL

    Returns void

  • try_set_exif_tag_rational(tag: string, nom: number, den: number): boolean
  • Set EXIF tag represented by a fraction, with nom being the numerator, den the denominator of the fraction.

    Parameters

    • tag: string

      The Exiv2 tag

    • nom: number

      Rational numerator

    • den: number

      Rational denominator

    Returns boolean

  • try_set_exif_thumbnail_from_buffer(buffer: Uint8Array): void
  • try_set_gps_info(longitude: number, latitude: number, altitude: number): 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.

    Parameters

    • longitude: number

      Longitude value to set or replace current value

    • latitude: number

      Latitude value to set or replace current value

    • altitude: number

      Altitude value to set or replace current value

    Returns boolean

  • try_set_metadata_pixel_height(height: number): void
  • Update the image's metadata with height

    Parameters

    • height: number

      The width of the image as it should be put into the metadata.

    Returns void

  • try_set_metadata_pixel_width(width: number): void
  • Composite setter to update the image's metadata with width

    Parameters

    • width: number

      The width of the image as it should be put into the metadata

    Returns void

  • try_set_tag_long(tag: string, value: number): boolean
  • The Exiv2 Tag Reference can be found at

    Parameters

    • tag: string

      Exiv2 tag name

    • value: number

      The value to set or replace the existing value

    Returns boolean

  • try_set_tag_multiple(tag: string, values: string[]): 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.

    Parameters

    • tag: string

      Exiv2 tag name

    • values: string[]

      An array of values to set or replace the existing value(s)

    Returns boolean

  • try_set_tag_string(tag: string, value: 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

    Parameters

    • tag: string

      Exiv2 tag name

    • value: string

      The value to set or replace the existing value

    Returns boolean

  • try_tag_supports_multiple_values(tag: string): 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.

    Parameters

    • tag: string

      An Exiv2 tag

    Returns boolean

  • try_update_gps_info(longitude: number, latitude: number, altitude: number): boolean
  • Convenience function to update longitude, latitude and altitude at once.

    Parameters

    • longitude: number

      Longitude value to set or replace current value

    • latitude: number

      Latitude value to set or replace current value

    • altitude: number

      Altitude value to set or replace current value

    Returns boolean

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • update_gps_info(longitude: number, latitude: number, altitude: number): boolean
  • Convenience function to update longitude, latitude and altitude at once.

    Parameters

    • longitude: number

      Longitude value to set or replace current value

    • latitude: number

      Latitude value to set or replace current value

    • altitude: number

      Altitude value to set or replace current value

    Returns boolean

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    virtual

    Parameters

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • watch_closure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compat_control(what: number, data: object): number
  • get_tag_description(tag: string): string
  • get_tag_label(tag: string): string
  • get_tag_type(tag: string): string
  • The names of the various Exiv2 tag types can be found at Exiv2::TypeId,

    The Exiv2 Tag Reference can be found at

    Parameters

    • tag: string

      An Exiv2 tag

    Returns string

  • get_xmp_namespace_for_tag(tag: string): string
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • property_name: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • is_exif_tag(tag: string): boolean
  • is_iptc_tag(tag: string): boolean
  • is_xmp_tag(tag: string): boolean
  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

  • register_xmp_namespace(name: string, prefix: string): boolean
  • try_get_tag_description(tag: string): string
  • try_get_tag_label(tag: string): string
  • try_get_tag_type(tag: string): string
  • The names of the various Exiv2 tag types can be found at Exiv2::TypeId,

    The Exiv2 Tag Reference can be found at

    Parameters

    • tag: string

      An Exiv2 tag

    Returns string

  • try_get_xmp_namespace_for_tag(tag: string): string
  • try_register_xmp_namespace(name: string, prefix: string): boolean
  • try_unregister_all_xmp_namespaces(): void
  • try_unregister_xmp_namespace(name: string): boolean
  • unregister_all_xmp_namespaces(): void
  • unregister_xmp_namespace(name: string): boolean

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method