AIAssetMgmtSuite Struct Reference
[API Suite List]

This suite provides simple XMP metadata manipulation routines and Adobe Version Cue(TM) functionality. More...

#include <AIAssetMgmt.h>

Public Attributes
AIAPI AIBoolean(*	IsAssetMgmtEnabled )()
	Reports whether Version Cue is enabled.
AIAPI AIErr(*	UpdateDynamicMetadataFields )(const char xapIn, const AIXMPDataFieldMap fields, const ai::int32 length, char **xapOut)
	Updates XMP metadata.
AIAPI AIErr(*	UpdateDynamicMetadata )(const char mimeType, const char managedURL, ai::uint32 metadataSelectors)
	Used internally to update the current document's XMP metadata.
AIAPI AIBoolean(*	Progress )(ai::int32 bytesTransferred, ai::int32 contentLength, char server, char uri, char method, char contentType, const ai::FilePath &localFile)
AIAPI AIErr(*	CreateXMPSession )(const char xmpIn, AIXMPSession xmp)
AIAPI AIErr(*	DisposeXMPSession )(AIXMPSession xmp)
AIAPI AIErr(*	GetXMPSessionSize )(AIXMPSession xmp, int *xmpSize)
AIAPI AIErr(*	GetXMPSessionBuffer )(AIXMPSession xmp, char *xmpOut)
AIAPI AIErr(*	GetPropertySize )(AIXMPSession xmp, const char nameSpace, const char key, ai::int32 *valueSize)
AIAPI AIErr(*	GetProperty )(AIXMPSession xmp, const char nameSpace, const char key, char *value)
AIAPI AIErr(*	SetProperty )(AIXMPSession xmp, const char nameSpace, const char key, const char *value)
AIAPI AIErr(*	DeleteProperty )(AIXMPSession xmp, const char nameSpace, const char key)
AIAPI AIErr(*	ShowMetadataDialog )(const char xmpIn, char xmpOut, const char dialogTitle)
	Shows the FileInfo dialog for an XMP packet.

Detailed Description

This suite provides simple XMP metadata manipulation routines and Adobe Version Cue(TM) functionality.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIAssetMgmtSuite and kAIAssetMgmtVersion.

Member Data Documentation

AIAPI AIErr(* AIAssetMgmtSuite::CreateXMPSession)(const char *xmpIn, AIXMPSession *xmp)

Deprecated:: Creates a new XMP session, which you can use to manipulate XMP metadata for the current document.

Parameters:

	xmpIn	A buffer containing the UTF-8 encoded XMP metadata for the current document. If null, a session object is still created and can be used with `SetProperty()`.
	xmp	[out] A buffer in which to return the new XMP session object.

Returns:: The error kBadParameterErr for any failure, including insufficient memory.

See also:: AIDocumentSuite::GetDocumentXAP()

AIAPI AIErr(* AIAssetMgmtSuite::DeleteProperty)(AIXMPSession xmp, const char *nameSpace, const char *key)

Deprecated:: Removes a property from XMP metadata.

Parameters:

	xmp	The XMP session object.
	nameSpace	The XMP namespace for the property.
	key	The key name for the property.

AIAPI AIErr(* AIAssetMgmtSuite::DisposeXMPSession)(AIXMPSession xmp)

Deprecated:: Frees memory associated with the XMP session object that is no longer needed.

Parameters:

xmp The session object, as returned by CreateXMPSession(). Upon return, this reference is no longer valid.

AIAPI AIErr(* AIAssetMgmtSuite::GetProperty)(AIXMPSession xmp, const char *nameSpace, const char *key, char *value)

Deprecated:: Retrieves the value of an XMP property.

Parameters:

	xmp	The XMP session object.
	nameSpace	The XMP namespace for the desired property.
	key	The key name for the desired property.
	value	[out] A buffer in which to return the value. Allocate sufficient memory using `GetPropertySize()`.

AIAPI AIErr(* AIAssetMgmtSuite::GetPropertySize)(AIXMPSession xmp, const char *nameSpace, const char *key, ai::int32 *valueSize)

Deprecated:: Gets the size of an XMP key value. Use this size to allocate memory before calling GetProperty().

Parameters:

	xmp	The XMP session object.
	nameSpace	The XMP namespace for the desired property.
	key	The key name for the desired property.
	valueSize	[out] A buffer in which to return the number of bytes in the key value.

Returns:: The error kNoSuchKey if key does not exist.

AIAPI AIErr(* AIAssetMgmtSuite::GetXMPSessionBuffer)(AIXMPSession xmp, char *xmpOut)

Deprecated:: Retrieves the buffer of the XMP session object.

Parameters:

	xmp	The XMP session object.
	xmpOUT	[out] A buffer in which to return the session buffer. Allocate sufficient memory using `GetXMPSessionSize()`.

AIAPI AIErr(* AIAssetMgmtSuite::GetXMPSessionSize)(AIXMPSession xmp, int *xmpSize)

Deprecated:: Gets the size of an XMP session object. Use this size to allocate memory before calling GetXMPSessionBuffer().

Parameters:

	xmp	The XMP session object.
	xmpSize	[out] A buffer in which to return the number of bytes in the session buffer.

AIAPI AIBoolean(* AIAssetMgmtSuite::IsAssetMgmtEnabled)()

Reports whether Version Cue is enabled.

(Note that this function returns a boolean value, not an error code.)

Returns:: True if Version Cue is enabled.

AIAPI AIBoolean(* AIAssetMgmtSuite::Progress)(ai::int32 bytesTransferred, ai::int32 contentLength, char *server, char *uri, char *method, char *contentType, const ai::FilePath &localFile)

Deprecated:: Used internally. Progress callback for Version Cue network operations.

Returns:: True to continue the operation, false to cancel.

AIAPI AIErr(* AIAssetMgmtSuite::SetProperty)(AIXMPSession xmp, const char *nameSpace, const char *key, const char *value)

Deprecated:: Sets the value of an XMP property.

Parameters:

	xmp	The XMP session object.
	nameSpace	The XMP namespace for the desired property.
	key	The key name for the desired property.
	value	The new value.

AIAPI AIErr(* AIAssetMgmtSuite::ShowMetadataDialog)(const char *xmpIn, char **xmpOut, const char *dialogTitle)

Shows the FileInfo dialog for an XMP packet.

Parameters:

	xmpIn	The current XMP metadata packet.
	xmpOUT	[out] A buffer in which to return the new XMP packet, allocated by `SPBasicSuite::AllocateBlock()`. Caller must free memory when no longer needed. If `NULL`, the function shows a read-only FileInfo dialog.
	dialogTitle	A UTF-8 title string for the dialog, typically the name of the artwork associated with the metadata. If a `NULL` pointer, the default title is "File Info".

Note:: The function does not check whether UserInteraction is on or off, the caller must do so..

AIAPI AIErr(* AIAssetMgmtSuite::UpdateDynamicMetadata)(const char *mimeType, const char *managedURL, ai::uint32 metadataSelectors)

Used internally to update the current document's XMP metadata.

Parameters:

	mimeType	The MIME type of the file being updated. Updates the "Format" property.
	managedURL	The URL of the file being updated, or `NULL` for local (unmanaged) files.Updates the "ManageTo" field of `kXMP_NS_XMP_MM` namespace.
	metadataSelectors	A logical OR of `AIXMPMetadataSelector` constants that specifies which types of metadata to update.

AIAPI AIErr(* AIAssetMgmtSuite::UpdateDynamicMetadataFields)(const char *xapIn, const AIXMPDataFieldMap *fields, const ai::int32 length, char **xapOut)

Updates XMP metadata.

Creates a new XMP metadata buffer.

Parameters:

	xapIn	The buffer containing the XMP metadata for the current document.
	fields	A pointer to an array of structures containing the new or changed metadata property name/value pairs.
	length	The number of structures in `fields`.
	xapOut	[out] A buffer in which to return the new XMP metadata. The caller is responsible for allocating and releasing the returned output buffer.

Note:: For details of the XMP properties, see the Adobe "XMP Specification",

See also:: AIDocumentSuite::GetDocumentXAP(), AIDocumentSuite::SetDocumentXAP() for getting and setting the XMP metadata buffer for the current document.

The documentation for this struct was generated from the following file:

AIAssetMgmt.h

AIAssetMgmtSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIAssetMgmtSuite Struct Reference
[API Suite List]