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.

Inheritance: XmpPacketWrapper → MetadataPackage

The XmpPacketWrapper type exposes the following members:

Constructors

Constructor	Description
`__init__(self, header, trailer, xmp_meta)`	Initializes a new instance of the `XmpPacketWrapper` class.
`__init__(self)`	Initializes a new instance of the `XmpPacketWrapper` class.

Properties

Property	Description
metadata_type	Gets the metadata type.
keys	Gets a collection of the metadata property names.
property_descriptors	Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
count	Gets the number of metadata properties.
header_pi	Gets or sets the header processing instruction.
meta	Gets or sets the XMP meta.
trailer_pi	Gets or sets the trailer processing instruction.
packages	Gets array of `XmpPackage` inside XMP.
package_count	Gets the number of packages inside the XMP structure.
schemes	Provides access to known XMP schemas.

Methods

Method	Description
`contains(self, property_name)`	Determines whether the package contains a metadata property with the specified name.
`find_properties(self, specification)`	Finds the metadata properties satisfying a specification. The search is recursive so it affects all nested packages as well.
`update_properties(self, specification, value)`	Updates known metadata properties satisfying a specification. The operation is recursive so it affects all nested packages as well.
`remove_properties(self, specification)`	Removes metadata properties satisfying a specification.
`add_properties(self, specification, value)`	Adds known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well.
`set_properties(self, specification, value)`	Sets known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well. This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`. If an existing property satisfies the specification its value is updated. If there is a known property missing in the package that satisfies the specification it is added to the package.
`sanitize(self)`	Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.
`add_package(self, package)`	Adds the package.
`get_package(self, namespace_uri)`	Gets package by namespace uri.
`contains_package(self, namespace_uri)`	Determines whether package is exist in XMP wrapper.
`remove_package(self, package)`	Removes the specified package.
`clear_packages(self)`	Removes all `XmpPackage` inside XMP.
`get_xmp_representation(self)`	Returns string contained value in XMP format.

Remarks

Learn more | | |

Example

This example shows how to update XMP metadata properties.

XmpPacketWrapper class

XmpPacketWrapper class

Constructors

Properties

Methods

Remarks

Example

See Also