InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IAdobeMediaMgmtMetaData Class Referenceabstract

#include <IAdobeMediaMgmtMetaData.h>

Inheritance diagram for IAdobeMediaMgmtMetaData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IADOBEMEDIAMGMTMETADATA }
 

Public Member Functions

virtual void AddManifestItem (metadata::LinkForm linkForm, const metadata::ResourceRef &resource, Fixed xRes, Fixed yRes)=0
 
virtual void RemoveManifestItem (const int32 &nth)=0
 
virtual bool16 GetNthManifestItem (const int32 &nth, metadata::LinkForm linkForm, metadata::ResourceRef &resource) const =0
 
virtual int32 GetManifestItemCount () const =0
 
virtual void ClearManifest ()=0
 
virtual void SetDerivedFrom (const metadata::ResourceRef &resource)=0
 
virtual metadata::ResourceRef GetDerivedFrom () const =0
 
virtual void SetDocumentID (const metadata::URI &documentID)=0
 
virtual metadata::URI GetDocumentID () const =0
 
virtual void SetOrigDocumentID (const metadata::URI &origDocumentID)=0
 
virtual metadata::URI GetOrigDocumentID () const =0
 
virtual void SetManagedFrom (const metadata::ResourceRef &resource)=0
 
virtual metadata::ResourceRef GetManagedFrom () const =0
 
virtual void SetManager (const PMString &manager)=0
 
virtual PMString GetManager () const =0
 
virtual void SetManageTo (const metadata::URI &serverURL)=0
 
virtual metadata::URI GetManageTo () const =0
 
virtual void SetManageUI (const metadata::URI &manageUI)=0
 
virtual metadata::URI GetManageUI () const =0
 
virtual void SetManagerVariant (const PMString &managerVariant)=0
 
virtual PMString GetManagerVariant () const =0
 
virtual void SetRenditionClass (const PMString &renditionClass)=0
 
virtual PMString GetRenditionClass () const =0
 
virtual void SetRenditionParams (const PMString &renditionParams)=0
 
virtual PMString GetRenditionParams () const =0
 
virtual void SetVersionID (const PMString &documentID)=0
 
virtual PMString GetVersionID () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This interface encapsulates routines of the XMPToolkit for accessing XMP Media Management Schema Properties defined in 'xapMM' namespace.

See Also
IAdobeBasicJobMetaData
IAdobeCoreMetaData
IAdobeRightsMgmtMetaData
IMetaDataAccess

Member Function Documentation

virtual void IAdobeMediaMgmtMetaData::AddManifestItem (metadata::LinkForm linkForm,
const metadata::ResourceRefresource,
Fixed xRes,
Fixed yRes 
)
pure virtual

Adds an resource references to a bag of references to linked documents that are part of this compound document, defined by 'xapMM:Manifest' property.

Parameters
linkFormIN Link form.
resourceIN The resource references to added.
xResIN x resolution of the added item.
yResIN y resoulution of the added item.
virtual void IAdobeMediaMgmtMetaData::ClearManifest ()
pure virtual

Clears all the resource references from the bag of references to linked documents, defined by 'xapMM:Manifest' property.

virtual metadata::ResourceRef IAdobeMediaMgmtMetaData::GetDerivedFrom () const
pure virtual

Returns the reference to the original document from which this one is derived, defined by 'xapMM:DerivedFrom' property.

Returns
The resource reference from which this one is derived.
virtual metadata::URI IAdobeMediaMgmtMetaData::GetDocumentID () const
pure virtual

Returns the common identifier for all versions and renditions of a document, defined by 'xapMM:DocumentID' property.

Returns
The common identifier for all versions and renditions of a document.
virtual metadata::ResourceRef IAdobeMediaMgmtMetaData::GetManagedFrom () const
pure virtual

Returns the reference to the document as obtained from a separate asset management system, defined by 'xapMM:ManagedFrom' property.

Returns
The reference to the document as obtained from a separate asset management system, defined by 'xapMM:ManagedFrom'.
virtual PMString IAdobeMediaMgmtMetaData::GetManager () const
pure virtual

Returns the name of the asset management system that manages this resource, defined by 'xapMM:Manager' property.

Returns
The name of the asset management system that manages this resource.
virtual PMString IAdobeMediaMgmtMetaData::GetManagerVariant () const
pure virtual

Returns a particular variant of the asset management system, defined by 'xapMM:ManagerVariant' property.

Returns
A particular variant of the asset management system.
virtual metadata::URI IAdobeMediaMgmtMetaData::GetManageTo () const
pure virtual

Returns the URI identifying the managed resource to the asset management system, defined by 'xapMM:ManageTo' property.

Returns
A URI identifying the managed resource to the asset management system.
virtual metadata::URI IAdobeMediaMgmtMetaData::GetManageUI () const
pure virtual

Returns the URI that can be used to access information about the managed resource through a webbrowser, defined by 'xapMM:ManageUI' property.

Returns
The URI that can be used to access information about the managed resource through a webbrowser.
virtual int32 IAdobeMediaMgmtMetaData::GetManifestItemCount () const
pure virtual

Returns the number of resource references in the bag of references to linked documents, defined by 'xapMM:Manifest' property.

Returns
The number of resource references in bag of the references to linked documents.
virtual bool16 IAdobeMediaMgmtMetaData::GetNthManifestItem (const int32 & nth,
metadata::LinkForm linkForm,
metadata::ResourceRefresource 
) const
pure virtual

Returns the nth item in the the bag of references to linked documents, defined by 'xapMM:Manifest' property.

Parameters
nthIN The index of the item to be removed, starts from 1.
linkFormIN Link form.
resourceOUT The resource reference at nth location.
Returns
kTrue if nth item exist, kFalse otherewise.
virtual metadata::URI IAdobeMediaMgmtMetaData::GetOrigDocumentID () const
pure virtual

Returns the common identifier for the origianl document from which all deriviatives, conversions, versions, and renditions came from, defined by 'xapMM:OriginalDocumentID' property.

Returns
The common identifier for the original document (should stay the same for all derivatives, conversions, versions, and renditions of the document).
virtual PMString IAdobeMediaMgmtMetaData::GetRenditionClass () const
pure virtual

Returns the rendition class name for this resource, defined by 'xapMM:RenditionClass' property.

Returns
The rendition class name for this resource.
virtual PMString IAdobeMediaMgmtMetaData::GetRenditionParams () const
pure virtual

Returns the additional rendition parameters that are too complex or verbose to encode in RenditionClass, defined by 'xapMM:RenditionParams'.

Returns
The additional rendition parameters.
virtual PMString IAdobeMediaMgmtMetaData::GetVersionID () const
pure virtual

Returns the version id defined by 'xapMM:VersionID' property.

Returns
The version id.
virtual void IAdobeMediaMgmtMetaData::RemoveManifestItem (const int32 & nth)
pure virtual

Remove the nth resource references from the bag of references to linked documents, defined by 'xapMM:Manifest' property.

Parameters
nthIN The index of the item to be removed, starts from 1.
virtual void IAdobeMediaMgmtMetaData::SetDerivedFrom (const metadata::ResourceRefresource)
pure virtual

Sets the reference to the original document from which this one is derived, defined by 'xapMM:DerivedFrom' property.

Parameters
resourceIN The resource reference from which this one is derived.
virtual void IAdobeMediaMgmtMetaData::SetDocumentID (const metadata::URIdocumentID)
pure virtual

Sets the common identifier for all versions and renditions of a document, defined by 'xapMM:DocumentID' property.

Parameters
documentIDIN The common identifier for all versions and renditions of a document.
virtual void IAdobeMediaMgmtMetaData::SetManagedFrom (const metadata::ResourceRefresource)
pure virtual

Sets a reference to the document as obtained from a separate asset management system, defined by 'xapMM:ManagedFrom' property.

Parameters
resourceIN A reference to the document as obtained from a separate asset management system.
virtual void IAdobeMediaMgmtMetaData::SetManager (const PMStringmanager)
pure virtual

Sets the name of the asset management system that manages this resource, defined by 'xapMM:Manager' property.

Parameters
managerIN The name of the asset management system that manages this resource.
virtual void IAdobeMediaMgmtMetaData::SetManagerVariant (const PMStringmanagerVariant)
pure virtual

Sets a particular variant of the asset management system, defined by 'xapMM:ManagerVariant' property.

Parameters
managerVariantIN A particular variant of the asset management system.
virtual void IAdobeMediaMgmtMetaData::SetManageTo (const metadata::URIserverURL)
pure virtual

Sets a URI identifying the managed resource to the asset management system, defined by 'xapMM:ManageTo' property.

Parameters
serverURLIN A URI identifying the managed resource to the asset management system.
virtual void IAdobeMediaMgmtMetaData::SetManageUI (const metadata::URImanageUI)
pure virtual

Sets a URI that can be used to access information about the managed resource through a webbrowser, defined by 'xapMM:ManageUI' property.

Parameters
manageUIIN A URI that can be used to access information about the managed resource through a webbrowser.
virtual void IAdobeMediaMgmtMetaData::SetOrigDocumentID (const metadata::URIorigDocumentID)
pure virtual

Sets the common identifier for the original document (should stay the same for all derivatives, conversions, versions, and renditions of the document), defined by 'xapMM:OriginalDocumentID' property.

Parameters
origDocumentIDIN The common identifier for the original document.
virtual void IAdobeMediaMgmtMetaData::SetRenditionClass (const PMStringrenditionClass)
pure virtual

Sets the rendition class name for this resource, defined by 'xapMM:RenditionClass' property. This property should be absent or set to "default" for a document version that is not a derived rendition.

Parameters
renditionClassIN The rendition class name for this resource.
virtual void IAdobeMediaMgmtMetaData::SetRenditionParams (const PMStringrenditionParams)
pure virtual

Sets the additional rendition parameters that are too complex or verbose to encode in RenditionClass, defined by 'xapMM:RenditionParams' property.

Parameters
renditionParamsIN The additional rendition parameters.
virtual void IAdobeMediaMgmtMetaData::SetVersionID (const PMStringdocumentID)
pure virtual

Sets the version id defined by 'xapMM:VersionID' property. This property should be used primarily by a media management system.

Parameters
documentIDIN The version id.