Xmp Node.js Reference Documentation

Xmp

Current Version: 9.5.0.97

Chilkat XMP is a software component (SDK, toolkit, library, etc) for accessing, manipulating, and adding XMP metadata to JPEG and TIFF files.

Object Creation

var obj = new chilkat.Xmp();

Properties

DebugLogFilePath
DebugLogFilePath
· string

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
LastErrorHtml
· string, read-only

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText
· string, read-only

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml
· string, read-only

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess
· boolean

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumEmbedded
NumEmbedded
· integer, read-only

The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile.

top
StructInnerDescrip
StructInnerDescrip
· boolean

Determines whether structures are stored with rdf:parseType="Resource", or within an "rdf:Description" sub-node.

top
UncommonOptions
UncommonOptions
· string
Introduced in version 9.5.0.80

A property to be used for future uncommon needs. The default value is the empty string.

top
VerboseLogging
VerboseLogging
· boolean

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version
· string, read-only

Version of the component/library, such as "9.5.0.94"

More Information and Examples
top

Methods

AddArray
var retBool = AddArray(xml, arrType, propName, values);
· Returns a Boolean.
· xml Xml
· arrType String
· propName String
· values StringArray

Adds or replaces an XMP property array. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The 2nd argument specifies the array type, which can be "bag", "seq", or "alt". The property name should be prefixed with the namespace, such as "dc:subject".

More Information and Examples
top
AddNsMapping
AddNsMapping(ns, uri);
· Does not return anything (returns Undefined).
· ns String
· uri String

Adds a namespace to URI mapping. When a property is added via AddSimpleString or any of the other methods, the property name is namespace qualified. When adding the first property in a namespace, the rdf:Description is automatically added and the URI is obtained from the namespace-to-URI mappings. The standard (and commonly used) namespace mappings are defined by default. This is only used if the namespace is custom or not already handled.

top
AddSimpleInt
var retBool = AddSimpleInt(iXml, propName, propVal);
· Returns a Boolean.
· iXml Xml
· propName String
· propVal Number

Adds or updates an XMP integer property. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The property name should be prefixed with the namespace, such as "tiff:XResolution".

top
AddSimpleStr
var retBool = AddSimpleStr(iXml, propName, propVal);
· Returns a Boolean.
· iXml Xml
· propName String
· propVal String

Adds or updates a simple XMP string property. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The property name should be prefixed with the namespace, such as "photoshop:Credit".

top
AddStructProp
var retBool = AddStructProp(iChilkatXml, structName, propName, propValue);
· Returns a Boolean.
· iChilkatXml Xml
· structName String
· propName String
· propValue String

Adds or updates an XMP structured property value. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The structure name should be prefixed with the namespace, such as "Iptc4xmpCore:CreatorContactInfo". The property name within the structure should also be prefixed with the namespace, such as "Iptc4xmpCore:CiAdrCity".

top
Append
var retBool = Append(iXml);
· Returns a Boolean.
· iXml Xml

Appends a new XMP metadata file to the XMP object. Any XMPs appended via this method will be present in the file when SaveAppFile is called. Files containing XMP metadata typically only include a single XMP document, so this method is usually only called when adding XMP metadata to a file for the first time.

top
GetArray
var ret_stringArray = GetArray(iXml, propName);
· Returns a StringArray
· iXml Xml
· propName String

Finds and returns an XMP array property. The property name should be prefixed with the namespace, such as "dc:subject".

Returns null on failure

top
GetEmbedded
var ret_xml = GetEmbedded(index);
· Returns a Xml
· index Number

Returns the Nth embedded XMP document as a Chilkat XML object.

Returns null on failure

More Information and Examples
top
GetProperty
var ret_xml = GetProperty(iXml, propName);
· Returns a Xml
· iXml Xml
· propName String

To be documented soon...

Returns null on failure

top
GetSimpleInt
var retInt = GetSimpleInt(iXml, propName);
· Returns a Number.
· iXml Xml
· propName String

Finds and returns an XMP integer property. The property name should be prefixed with the namespace, such as "tiff:ResolutionUnit".

top
GetSimpleStr
var retStr = GetSimpleStr(iXml, propName);
· Returns a String.
· iXml Xml
· propName String

Finds and returns an XMP simple string property. The property name should be prefixed with the namespace, such as "photoshop:Source".

Returns null on failure

More Information and Examples
top
GetStructPropNames
var ret_stringArray = GetStructPropNames(iXml, structName);
· Returns a StringArray
· iXml Xml
· structName String

Returns the property names used by an exsting structure within an XMP document. The contents of the structure can be retrieved by calling GetStructValue for each property name returned by GetStructPropNames.

Returns null on failure

top
GetStructValue
var retStr = GetStructValue(iXml, structName, propName);
· Returns a String.
· iXml Xml
· structName String
· propName String

Returns the value of a single item within an XMP structure property. Property names should always be prefixed with the namespace.

Returns null on failure

More Information and Examples
top
LoadAppFile
var retBool = LoadAppFile(filename);
· Returns a Boolean.
· filename String

Loads a TIFF or JPG file into the XMP object.

top
LoadFromBuffer
var retBool = LoadFromBuffer(fileData, ext);
· Returns a Boolean.
· fileData Buffer
· ext String

Loads a JPG or TIFF from an byte buffer containing the image file data.

top
NewXmp
var ret_xml = NewXmp();
· Returns a Xml

Creates and returns a new/empty XMP metadata document as a Chilkat XML object.

Returns null on failure

More Information and Examples
top
RemoveAllEmbedded
var status = RemoveAllEmbedded();
· Returns Boolean (true for success, false for failure).

Removes all XMP metadata documents from an XMP object. After calling this method, call SaveAppFile to rewrite the JPG or TIFF file with the XMP metadata removed.

Returns true for success, false for failure.

top
RemoveArray
var retBool = RemoveArray(iXml, propName);
· Returns a Boolean.
· iXml Xml
· propName String

Removes an XMP array property from the XMP document.

top
RemoveEmbedded
var status = RemoveEmbedded(index);
· Returns Boolean (true for success, false for failure).
· index Number

Removes a single XMP metadata document from the JPG or TIFF file. Call SaveAppFile to persist the changes to disk.

Returns true for success, false for failure.

top
RemoveNsMapping
RemoveNsMapping(ns);
· Does not return anything (returns Undefined).
· ns String

Removes a namespace-to-URI mapping.

top
RemoveSimple
var retBool = RemoveSimple(iXml, propName);
· Returns a Boolean.
· iXml Xml
· propName String

Removes a simple XMP property from the XMP document.

top
RemoveStruct
var retBool = RemoveStruct(iXml, structName);
· Returns a Boolean.
· iXml Xml
· structName String

Removes an XMP structure property from the XMP document.

top
RemoveStructProp
var retBool = RemoveStructProp(iXml, structName, propName);
· Returns a Boolean.
· iXml Xml
· structName String
· propName String

Removes a single member from an XMP structured property.

top
SaveAppFile
var retBool = SaveAppFile(filename);
· Returns a Boolean.
· filename String

Persists all changes made to the XMP document(s) by saving the XMP object to a file. Changes made by adding, updating, or removing properties are not persisted to the filesystem until this is called.

top
SaveToBuffer
var retBuf = SaveToBuffer();
· Returns a Buffer.

Saves a JPG or TIFF image with updated XMP to a byte buffer.

Returns null on failure

top