XmpPacketWrapper Class
Contents
[
Hide
]Summary: Contains serialized xmp package including header and trailer.
Module: aspose.imaging.xmp
Full Name: aspose.imaging.xmp.XmpPacketWrapper
Inheritance: IXmlValue
Constructors
| Name | Description |
|---|---|
| XmpPacketWrapper() | Initializes a new instance of the XmpPacketWrapper class. |
| XmpPacketWrapper(header, trailer, xmp_meta) | Initializes a new instance of the XmpPacketWrapper class. |
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| header_pi | XmpHeaderPi | r | Gets the header processing instruction. |
| meta | XmpMeta | r/w | Gets the XMP meta. Optional. |
| packages | XmpPackage[] | r | Gets array of XmpPackage inside XMP. |
| packages_count | int | r | Gets amount of packages inside XMP structure. |
| trailer_pi | XmpTrailerPi | r | Gets the trailer processing instruction. |
Methods
| Name | Description |
|---|---|
| add_package(package) | Adds the package. |
| clear_packages() | Removes all XmpPackage inside XMP. |
| contains_package(namespace_uri) | Determines whethere package is exist in xmp wrapper. |
| get_package(namespace_uri) | Gets package by namespace URI. |
| get_xml_value() | Converts XMP value to the XML representation. |
| remove_package(package) | Removes the XMP package. |
Constructor: XmpPacketWrapper()
XmpPacketWrapper()
Initializes a new instance of the XmpPacketWrapper class.
Constructor: XmpPacketWrapper(header, trailer, xmp_meta)
XmpPacketWrapper(header, trailer, xmp_meta)
Initializes a new instance of the XmpPacketWrapper class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| header | XmpHeaderPi | The XMP header of processing instruction. |
| trailer | XmpTrailerPi | The XMP trailer of processing instruction. |
| xmp_meta | XmpMeta | The XMP metadata. |
Method: add_package(package)
add_package(package)
Adds the package.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| package | XmpPackage | The package. |
Method: contains_package(namespace_uri)
contains_package(namespace_uri)
Determines whethere package is exist in xmp wrapper.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| namespace_uri | string | Package schema uri. |
Returns
| Type | Description |
|---|---|
| bool | Returns true if package with specified namespace Uri exist in XMP wrapper. |
Method: get_package(namespace_uri)
get_package(namespace_uri)
Gets package by namespace URI.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| namespace_uri | string | The package schema URI. |
Returns
| Type | Description |
|---|---|
| XmpPackage | Returns the XMP package for specified namespace URI. |
Method: get_xml_value()
get_xml_value()
Converts XMP value to the XML representation.
Returns
| Type | Description |
|---|---|
| string | Returns converted XMP value to XML. |
Method: remove_package(package)
remove_package(package)
Removes the XMP package.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| package | XmpPackage | The package. |