XmpPacketWrapper class

XmpPacketWrapper class

Contains serialized XMP package including header and trailer. A wrapper consisting of a pair of XML processing instructions (PIs) may be placed around the rdf:RDF element.

Learn more:

The XmpPacketWrapper type exposes the following members:

Constructors

Constructor Description
init Initializes a new XmpPacketWrapper instance.
init Initializes a new instance of the XmpPacketWrapper class.

Methods

Method Description
add_package Adds the package.
add_package_xmp_package
clear_packages Removes all XmpPackage inside XMP.
contains_package Determines whether a package exists in the XMP wrapper.
contains_package_file
contains_package_string
get_package Gets the package by namespace URI.
get_package_file
get_package_string
get_xmp_representation Returns the XMP representation as a string.
remove_package Removes the specified package.
remove_package_xmp_package
add_properties Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. (inherited from MetadataPackage)
add_properties_func (inherited from MetadataPackage)
contains Returns True if the package contains a metadata property with the specified name; otherwise, False. (inherited from MetadataPackage)
contains_file (inherited from MetadataPackage)
contains_string (inherited from MetadataPackage)
find_properties Finds metadata properties that satisfy the specified predicate, searching recursively through all nested packages. (inherited from MetadataPackage)
find_properties_func (inherited from MetadataPackage)
get (inherited from MetadataPackage)
get_enumerator Returns an enumerator that iterates through the collection. (inherited from MetadataPackage)
get_file (inherited from MetadataPackage)
get_string (inherited from MetadataPackage)
remove_properties Removes metadata properties satisfying the specified predicate. (inherited from MetadataPackage)
remove_properties_func (inherited from MetadataPackage)
sanitize Removes writable metadata properties from the package, recursively affecting all nested packages. (inherited from MetadataPackage)
set_properties Sets known metadata properties satisfying the specified predicate. (inherited from MetadataPackage)
set_properties_func (inherited from MetadataPackage)
update_properties Updates known metadata properties that satisfy the specified predicate, recursively affecting all nested packages. (inherited from MetadataPackage)
update_properties_func (inherited from MetadataPackage)

Properties

Property Description
header_pi The header processing instruction.
meta The XMP meta.
package_count The number of packages inside the XMP structure.
packages The XMP packages contained in the packet.
schemes The XMP schemes. Provides access to known XMP schemas.
trailer_pi The trailer processing instruction.
count The number of metadata properties. (inherited from MetadataPackage)
keys The collection of metadata property names. (inherited from MetadataPackage)
know_property_descriptors The collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. (inherited from MetadataPackage)
metadata_type The metadata type of the package. (inherited from MetadataPackage)
property_descriptors The collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. (inherited from MetadataPackage)

Example

from datetime import date
from groupdocs.metadata import Metadata
from groupdocs.metadata.standards.xmp import XmpArray, XmpArrayType, XmpPackage, XmpPacketWrapper

with Metadata("input.jpg") as metadata:
    root = metadata.get_root_package()
    packet = XmpPacketWrapper()
    custom = XmpPackage("gd", "https://groupdocs.com")
    custom.set("gd:Copyright", "Copyright (C) 2026 GroupDocs. All Rights Reserved.")
    custom.set("gd:CreationDate", date.today())
    custom.set(
        "gd:Company",
        XmpArray.from_(["Aspose", "GroupDocs"], XmpArrayType.ORDERED)
    )
    packet.add_package(custom)
    root.xmp_package = packet
    metadata.save("output.jpg")

See Also