AAFA Developer Support

Classes | Functions
AAF.idl File Reference

Go to the source code of this file.

Classes

interface  IAAFAES3PCMDescriptor
 The IAAFAES3PCMDescriptor is DEPRECATED, please use IAAFAES3PCMDescriptor2. More...
interface  IAAFAIFCDescriptor
 The IAAFAIFCDescriptor interface is implemented by objects which describe audio content data formatted according to the AIFC compressed Audio File Format. More...
interface  IAAFAuxiliaryDescriptor
 The IAAFAuxiliaryDescriptor interface is implemented by objects that describe a file source which has no physical source. More...
interface  IAAFBWFImportDescriptor
 In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values: More...
interface  IAAFCDCIDescriptor
 IAAFCDCIDescriptor is DEPRECATED. More...
interface  IAAFCachePageAllocator
 This interface is used by the toolkit for allocation and deallocation of pages in a page cache. More...
interface  IAAFClassDef
 This interface is used with an object representing an AAF class definition. More...
interface  IAAFCodecDef
 This interface is used with an object representing a particular kind of essence codec, which may be implemented by one or more AAFPluginDescriptors. More...
interface  IAAFCommentMarker
 The IAAFCommentMarker interface is implemented by objects which represent a user comment associated with a point in time. More...
interface  IAAFComponent
 IAAFComponent is DEPRECATED, please use IAAFComponent2. More...
interface  IAAFCompositionMob
 IAAFCompositionMob is DEPRECATED, please use IAAFCompositionMob2. More...
interface  IAAFConstantValue
 The IAAFConstantValue interface is implemented by objects that specify a parameter whose value is constant for an entire operation group. More...
interface  IAAFContainerDef
 This interface is used with an object representing a particular kind of essence stream factory object, which may be implemented by one or more AAFPluginDescriptors. More...
interface  IAAFContentStorage
 Objects that implement IAAFContentStorage also implement the following interfaces: More...
interface  IAAFControlPoint
 The IAAFControlPoint interface is implemented by objects that store an individual point value of a parameter whose value changes during the operation group. More...
interface  IAAFDataDef
 IAAFDataDef is DEPRECATED, Please use IAAFDataDef2. More...
interface  IAAFDataEssenceDescriptor
 AAFRESULT_NOMEMORY. More...
interface  IAAFDefObject
 This interface is defines an item to be referenced in the AAF file. More...
interface  IAAFDescriptiveClip
 In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values: More...
interface  IAAFDescriptiveFramework
 The IAAFDescriptiveFramework interface is implemented by objects that represent descriptive metadata. More...
interface  IAAFDescriptiveMarker
 The IAAFDescriptiveMarker interface is implemented by objects which represent a descriptive metadata associated with a point in time. More...
interface  IAAFDescriptiveObject
 The IAAFDescriptiveObject interface is implemented by objects that represent descriptive metadata. More...
interface  IAAFDictionary
 This interface is used to access dictionary services in an AAF file. More...
interface  IAAFDigitalImageDescriptor
 IAAFDigitalImageDescriptor is DEPRECATED. More...
interface  IAAFEdgecode
 Objects that implement IAAFEdgecode also implement the following interfaces: More...
interface  IAAFEssenceAccess
 AAFEssenceAccess is an interace which provides streaming access over multiple channels of essence data. More...
interface  IAAFEssenceData
 This interface is DEPRECATED, please use IAAFEssenceData2. More...
interface  IAAFEssenceDescriptor
 The IAAFEssenceDescriptor interface is implemented by objects which describe the format of the content data associated with a File Source mob or of the media associated with a Physical Source mob. More...
interface  IAAFEssenceFormat
 The AAFEssenceFormat class represents a collection of parameters (such as image height/width, audio sample width) which describes a piece of essence. More...
interface  IAAFEssenceGroup
 This interface provides access to the IAAFEssenceGroup interface, which contains multiple representations of the same media within a MasterMob. More...
interface  IAAFEvent
 The IAAFEvent interface is implemented by objects which represent a text comment, a trigger, or an area in the image that has an associated interactive action. More...
interface  IAAFEventMobSlot
 IAAFEventMobSlot is DEPRECATED, please use IAAFEventMobSlot2. More...
interface  IAAFFile
 This interface is used with an object representing an AAF file. More...
interface  IAAFFileDescriptor
 IAAFFileDescriptor is DEPRECATED, please use IAAFFileDescriptor2. More...
interface  IAAFFileEncoding
 Start of the comment. More...
interface  IAAFFiller
 The IAAFFiller interface is supported by objects which serve as placeholders for an unknown values for the component duration. More...
interface  IAAFFilmDescriptor
 The IAAFFilmDescriptor interface is implemented by objects which describe film essence. More...
interface  IAAFFindSourceInfo
interface  IAAFGPITrigger
 The IAAFGPITrigger interface is implemented by objects which represent an trigger action that should be taken when its position in time is reached. More...
interface  IAAFGetFileBits
 This interface is implemented by the toolkit, and is provided to clients of IAAFFile to allow them to obtain the raw bits of a file after close. More...
interface  IAAFHeader
 The IAAFHeader interface provides file-wide information and indexes. More...
interface  IAAFIdentification
 The IAAFIdentification interface provides information about an application that either created or modified the AAF file. More...
interface  IAAFImportDescriptor
 The IAAFImportDescriptor interface is implemented by objects which describe a file which was imported into AAF. More...
interface  IAAFInterpolationDef
 This interface is used with an object representing a particular kind of interpolator, which may be implemented by one or more AAFPluginDescriptors. More...
interface  IAAFKLVData
 The IAAFKLVData interface is implemented by objects that specify an User defined tag and value. More...
interface  IAAFKLVDataDefinition
 This interface is used to describe the data type of a value stored in an AAFKLVData object. More...
interface  IAAFLocator
 The IAAFLocator interface is implemented by objects that provide information to help find a file that contains the essence. More...
interface  IAAFMasterMob
 The IAAFMasterMob interface is implemented by objects which provide access to the File Source Mobs and EssenceData objects. More...
interface  IAAFMetaDefinition
 This interface is defines an item to be referenced in the AAF file. More...
interface  IAAFMob
 IAAFMob is DEPRECATED, Please use IAAFMob2. More...
interface  IAAFMobSlot
 The IAAFMobSlot interface is implemented by objects which represent a Segment of essence in a Mob. More...
interface  IAAFMPEGVideoDescriptor
 In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values: More...
interface  IAAFMultipleDescriptor
 The IAAFMultipleDescriptor interface is implemented by objects which describe the format of the content data associated with a File Source mob containing multiple tracks of essence. More...
interface  IAAFNestedScope
 This interface is used with an object which contains an ordered set of AAFSegments and produces the value specified by the last AAFSegement in the ordered seta reference to a segment. More...
interface  IAAFNetworkLocator
 The IAAFNetworkLocator interface is implemented by objects which provide information to help find a file containing essence data. More...
interface  IAAFObject
 This interface is implemented for all AAF persistent classes. More...
interface  IAAFOperationDef
 The IAAFOperationDef interface is implemented by objects that specify an operation definition. More...
interface  IAAFOperationGroup
 The IAAFOperationGroup interface is implemented by objects describe an operation (such as an effect) affecting the interpretation of zero or more input segments. More...
interface  IAAFPCMDescriptor
 The IAAFPCMDescriptor interface is implemented by objects which describe audio essence. More...
interface  IAAFParameter
 The IAAFParameter interface is implemented by objects that specify an Instantiation of an operation parameter. More...
interface  IAAFParameterDef
 The IAAFParameterDef interface is implemented by objects that specify a definition of an operation group parameter. More...
interface  IAAFPhysicalDescriptor
 The AAFPhysicalDescriptor interface is implemented by objects which describe physical sources. More...
interface  IAAFPlainEssenceData
 This is a default inerface for a class used to provide access to file encoding-independent stream data. More...
interface  IAAFPlainStreamData
 This interface is used to define Stream types used in AAF persistent objects. More...
interface  IAAFPluginDef
 An object which describes a particular implementation of a plug-in interface. More...
interface  IAAFPluginManager
 This interface is used with an object representing an AAF class definition. More...
interface  IAAFProperty
 This interface is used to access instances of properties contained in AAF persistent objects. More...
interface  IAAFPropertyDef
 This interface is used to access the definitions of types for properties contained in AAF persistent objects. More...
interface  IAAFPropertyValue
 This interface is used to access the values of properties contained in AAF persistent objects. More...
interface  IAAFPulldown
 This interface is used with an object which converts between film frame rates and videotape frame rates by describing the mapping between them. More...
interface  IAAFRGBADescriptor
 IAAFRGBADescriptor is DEPRECATED. More...
interface  IAAFRandomFile
 Specialized file interface for use with files which exist on storage media which has random access capability. More...
interface  IAAFRandomRawStorage
 This interface is used by the toolkit to access storage in which AAF files are to be read and written. More...
interface  IAAFRawStorage
 This interface is used by the toolkit to access storage in which AAF files are to be read and written. More...
interface  IAAFRIFFChunk
 In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values: More...
interface  IAAFRecordingDescriptor
 The IAAFRecordingDescriptor interface is implemented by objects that describe a file source which has no physical source. More...
interface  IAAFScopeReference
 This interface is used with an object representing a reference to a segment on another slot of this scope (AAFNestedScope or AAFMob) or an enclosing scope. More...
interface  IAAFSegment
 The IAAFSegment interface is implemented by objects which represent a component that is independent of any other components which may surround it in a sequence. More...
interface  IAAFSelector
 The IAAFSelector interface is implemented by objects that specify a single segment while preserving references to unused alternatives. More...
interface  IAAFSequence
 This interface provides access to the list of Segment and Transition objects maintained by a Sequence object. More...
interface  IAAFSetFileBits
 This interface is implemented by the toolkit, and is provided to clients of IAAFFile to allow them to supply the raw bits of a file before open. More...
interface  IAAFSoundDescriptor
 The IAAFSoundDescriptor interface is implemented by objects which describe the basic parameters of Sound used by all compression or coding schemes. More...
interface  IAAFSourceClip
 The IAAFSourceClip interface is implemented by objects that reference the content data and identify the source of the content data. More...
interface  IAAFSourceMob
 This interface is used with an object representing a SourceMob containing some form of AAFEssenceDescriptor, either an AAFTapeDescriptor, AAFFileDescriptor AAFFilmDescriptor, or some extended descriptor not in the v1 specification. More...
interface  IAAFSourceReference
 The IAAFSourceReference interface is implemented by objects that represent the essence or other data described by a MobSlot in a Mob. More...
interface  IAAFStaticMobSlot
 StaticMobSlot describes essence data that has no relationship to time, such as a static image; consequently, a StaticMobSlot does not define an edit rate. More...
interface  IAAFTIFFDescriptor
 The IAAFTIFFDescriptor interface is implemented by objects which describe TIFF format media. More...
interface  IAAFTaggedValue
 The IAAFTaggedValue interface is implemented by objects that specify an User defined tag and value. More...
interface  IAAFTaggedValueDefinition
 This interface is used to describe the data type of a value stored in an AAFTaggedValue object. More...
interface  IAAFTapeDescriptor
 The IAAFTapeDescriptor interface is implemented by objects which describe audio tape or videotape media. More...
interface  IAAFTextLocator
 The IAAFTextLocator interface is implemented by objects which provide information to help find a file containing essence data in a descriptive way for files that are held off-line. More...
interface  IAAFTimecode
 The IAAFTimecode interface is implemented by objects which store videotape or audio tape timecode information. More...
interface  IAAFTimecodeStream
 Objects which support IAAFTimecodeStream specify a stream of timecode data. More...
interface  IAAFTimecodeStream12M
 Objects that implement IAAFTimecodeStream12M also implement the following interfaces: More...
interface  IAAFTimelineMobSlot
 This interface is DEPRECATED, please use IAAFTimelineMobSlot2. More...
interface  IAAFTransition
 The IAAFTransition interface is implemented by objects describe a change or transition from one piece of essence to another. More...
interface  IAAFTypeDef
 This interface is used to define types used in AAF persistent objects. More...
interface  IAAFTypeDefCharacter
 This interface is used to define Integer types used in AAF persistent objects. More...
interface  IAAFTypeDefEnum
 This interface is used to define enumerated types used in AAF persistent objects. More...
interface  IAAFTypeDefExtEnum
 This interface is used to define field-extendible enumerated types used in AAF persistent objects. More...
interface  IAAFTypeDefFixedArray
 This interface is used to define fixed-sized Array types used in AAF persistent objects. More...
interface  IAAFTypeDefIndirect
 This interface is used to define Integer types used in AAF persistent objects. More...
interface  IAAFTypeDefInt
 This interface is used to define Integer types used in AAF persistent objects. More...
interface  IAAFTypeDefObjectRef
 This interface is used to define Object references (either strong or weak) used in AAF persistent objects. More...
interface  IAAFTypeDefOpaque
 This interface is used to define Integer types used in AAF persistent objects. More...
interface  IAAFTypeDefRecord
 This interface is used to define C-like structured types used in AAF persistent objects. More...
interface  IAAFTypeDefRename
 This interface is used to define Renamed types (analogous to C typedefs) used in AAF persistent objects. More...
interface  IAAFTypeDefSet
 This interface is used to define variably-sized set types used in AAF persistent objects. More...
interface  IAAFTypeDefStream
 AAFTypeDefStream is DEPRECATED, please use AAFTypeDefStream3. More...
interface  IAAFTypeDefString
 This interface is used to define variably-sized Array types whose length is determined by a special terminator element value. More...
interface  IAAFTypeDefStrongObjRef
 This interface is used to implement Strong Object references. More...
interface  IAAFTypeDefVariableArray
 This interface is used to define variably-sized Array types used in AAF persistent objects. More...
interface  IAAFTypeDefWeakObjRef
 This interface is used to implement Weak Object references. More...
interface  IAAFVaryingValue
 The IAAFVaryingValue interface is implemented by objects that specify a parameter whose value changes during the operation group. More...
interface  IAAFWAVEDescriptor
 The IAAFWaveDescriptor interface is implemented by objects which describe audio content data formatted according to the RIFF Waveform Audio File Format (WAVE). More...
interface  IEnumAAFClassDefs
 This interface is used to enumerate across Class Definition objects. More...
interface  IEnumAAFCodecDefs
interface  IEnumAAFCodecFlavours
 An object which allows iteration over all of the flavour codes which a given codec is able to handle. More...
interface  IEnumAAFComponents
 This interface is used to enumerate over the AAFComponents contained in an AAFSequence. More...
interface  IEnumAAFContainerDefs
interface  IEnumAAFControlPoints
interface  IEnumAAFDataDefs
interface  IEnumAAFEssenceData
 The IEnumAAFEssenceData interface is used enumerate all of the AAFEssenceData objects in a file. More...
interface  IEnumAAFFileDescriptors
 This interface is used to enumerate across File Descriptor objects. More...
interface  IEnumAAFFileEncodings
 In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values: More...
interface  IEnumAAFIdentifications
 This interfaces allows access to individual IAAFIdentification-supporting objects within a collection. More...
interface  IEnumAAFInterpolationDefs
interface  IEnumAAFKLVData
interface  IEnumAAFKLVDataDefs
interface  IEnumAAFLoadedPlugins
 An object which allows iteration over all of the AAFDefObject managed by the AAFPluginManager. More...
interface  IEnumAAFLocators
 This interface is for the enumerator which is generated by IAAFEssenceDescriptor and is used for enumerating over IAAFLocators attached to EssenceDescriptor attached to an AAFSourceMob. More...
interface  IEnumAAFMobSlots
 This interface is for the enumerator which is generated by IAAFMob and is used for enumerating over IAAFMobSlots attached to the mob. More...
interface  IEnumAAFMobs
 This interface is for the enumerator which is generated by IAAFHeader and is used for enumerating over IAAFMobs attached to the content storage attached to the header. More...
interface  IEnumAAFOperationDefs
interface  IEnumAAFParameterDefs
 This interface is used to enumerate over the AAFParameterDefinitions referenced from in an AAFOperationDefinition or AAFParameter, and contained within the AAFDictionary. More...
interface  IEnumAAFParameters
 This interface is used to enumerate over the AAFParameters referenced from in an AAFOperationDefinition or AAFParameter, and contained within the AAFDictionary. More...
interface  IEnumAAFPluginDefs
 An object which allows iteration over all of the AAFPluginDefinitions in the dictionary. More...
interface  IEnumAAFPluginLocators
 An object which allows iteration over all of the AAFLocators attached to an AAFPluginDescriptor. More...
interface  IEnumAAFProperties
 This interface is used to enumerate over the AAFProperties contained in a collection. More...
interface  IEnumAAFPropertyDefs
interface  IEnumAAFPropertyValues
 This interface is used to enumerate over the AAFPropertyValues contained in a collection. More...
interface  IEnumAAFRIFFChunks
 This interface is used to enumerate across RIFFChunk objects. More...
interface  IEnumAAFSegments
interface  IEnumAAFTaggedValueDefs
interface  IEnumAAFTaggedValues
interface  IEnumAAFTypeDefs
interface  IAAFAES3PCMDescriptor2
 The IAAFAES3PCMDescriptor2 interface is implemented by objects which describe video essence formatted with one luminance component and two color-difference components. More...
interface  IAAFCDCIDescriptor2
 The IAAFCDCIDescriptor2 interface is implemented by objects which describe video essence formatted with one luminance component and two color-difference components. More...
interface  IAAFComponent2
 The component class represents an essence element. More...
interface  IAAFCompositionMob2
 The IAAFCompositionMob2 interface is implemented on objects which can specify how to combine content data elements into a sequence, how to modify content data elements, and how to synchronize content data elements. More...
interface  IAAFDataDef2
 Objects that implement IAAFDataDef2 also implement the following interfaces: More...
interface  IAAFDataDef3
 Objects that implement IAAFDataDef3 also implement the following interfaces: More...
interface  IAAFDiagnosticOutput
 This interface is used by AAF Toolkit as an output stream to which it writes diagnostic messages. More...
interface  IAAFDictionary2
 This interface is used to access dictionary services in an AAF file. More...
interface  IAAFDigitalImageDescriptor2
 The IAAFDigitalImageDescriptor2 interface is implemented by objects which describe video content data formatted either using RGBA or luminance/chrominance formatting. More...
interface  IAAFEndian
 This interface is used to allow the user to determine the byte order of this object. More...
interface  IAAFEssenceDataEx
 This interface is DEPRECATED, please use IAAFEssenceData2. More...
interface  IAAFEssenceData2
 The IAAFEssenceData2 interface is used to modify AAFEssenceData objects, which contain the actual essence data (ex. More...
interface  IAAFEssenceMultiAccess
 AAFEssenceMultiAccess is an interace which provides streaming access over essence data. More...
interface  IAAFEventMobSlot2
 An EventMobSlot, as all MobSlots, has a concrete segment, which is a concrete Event or a Sequence of ordered Events. More...
interface  IAAFFileDescriptor2
 The IAAFFileDescriptor2 interface is implemented by objects which describe the format of the content data associated with a File Source mob or the media associated with a Physical Source mob. More...
interface  IAAFHeader2
 The IAAFHeader2 interface provides file-wide information and indexes. More...
interface  IAAFKLVEssenceDataParameters
 In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values: More...
interface  IAAFKLVStreamParameters
 In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values: More...
interface  IAAFMasterMob2
 The IAAFMasterMob interface is implemented by objects which provide access to the File Source Mobs and EssenceData objects. More...
interface  IAAFMasterMob3
 The IAAFMasterMob interface is implemented by objects which provide access to the File Source Mobs and EssenceData objects. More...
interface  IAAFMasterMobEx
 The IAAFMasterMobEx interface extends IAAFMasterMob. More...
interface  IAAFMob2
 The IAAFMob2 interface is implemented by objects that specify a Metadata Object, which can describe a composition, essence, or physical media. More...
interface  IAAFProgress
 This interface is used by the toolkit. More...
interface  IAAFRGBADescriptor2
 The IAAFRGBADescriptor2 interface is implemented by objects which describe video content data formatted using RGBA formatting. More...
interface  IAAFSearchSource
 The IAAFSearchSource interface is used to return source information for some mob slots. More...
interface  IAAFSourceReference2
 The IAAFSourceReference2 interface is implemented by objects that represent the essence or other data described by a MobSlot in a Mob. More...
interface  IAAFStreamAccess
 This interface is used by the toolkit. More...
interface  IAAFTimelineMobSlot2
 The IAAFTimelineMobSlot interface is implemented by objects which contain time-varying timeline essence. More...
interface  IAAFTypeDefStreamEx
 This interface is an extension to the previously definined TypeDefStream interface. More...
interface  IAAFTypeDefStream3
 This interface is used to define Stream types used in AAF persistent objects. More...
interface  IAAFTypeDefVariableArrayEx
 This interface is an extension to the previously definined TypeDefVariableArray interface. More...

Functions

STDAPI AAFLoad (const char *dllname)
 ***********************************************************")
STDAPI AAFUnload ()
 ***********************************************************
STDAPI AAFFileOpenExistingRead (") cpp_quote("aafCharacter_constptr pFileName,") cpp_quote("aafUInt32 modeFlags,") cpp_quote("IAAFFile **ppFile)
 ***********************************************************")
STDAPI AAFFileOpenExistingModify (") cpp_quote("aafCharacter_constptr pFileName,") cpp_quote("aafUInt32 modeFlags,") cpp_quote("aafProductIdentification_t *pIdent,") cpp_quote("IAAFFile **ppFile)
 Creates an object associated with with an existing filesystem file that contains data which is to be read and written.
STDAPI AAFFileOpenNewModify (") cpp_quote("aafCharacter_constptr pFileName,") cpp_quote("aafUInt32 modeFlags,") cpp_quote("aafProductIdentification_t *pIdent,") cpp_quote("IAAFFile **ppFile)
 Creates an object associated with with a new filesystem file that contains data which is to be read and written.
STDAPI AAFFileOpenNewModifyEx (") cpp_quote("aafCharacter_constptr pFileName,") cpp_quote("aafUID_constptr pFileKind,") cpp_quote("aafUInt32 modeFlags,") cpp_quote("aafProductIdentification_t *pIdent,") cpp_quote("IAAFFile **ppFile)
 Creates an object associated with with a new filesystem file that contains data which is to be read and written.
STDAPI AAFFileOpenTransient (") cpp_quote("aafProductIdentification_t *pIdent,") cpp_quote("IAAFFile **ppFile)
 Creates an object associated with with a transient file, meaning that it is not associated with any filesystem file but may still be used to contain AAF objects as if it was associated with a filesystem file.
STDAPI AAFFileIsAAFFile (") cpp_quote("aafCharacter_constptr pFileName,") cpp_quote("aafUID_t *pAAFFileKind,") cpp_quote("aafBool *pFileIsAAFFile)
 Is the named file an AAF file ?
STDAPI AAFRawStorageIsAAFFile (") cpp_quote("IAAFRawStorage *pRawStorage,") cpp_quote("aafUID_t *pAAFFileKind,") cpp_quote("aafBool *pRawStorageIsAAFFile)
 Does the storage contain an AAF file ?
STDAPI AAFFileIsAAFFileKind (") cpp_quote("aafCharacter_constptr pFileName,") cpp_quote("aafUID_constptr pAAFFileKind,") cpp_quote("aafBool *pFileIsAAFFile)
 Is the named file an AAF file ?
STDAPI AAFRawStorageIsAAFFileKind (") cpp_quote("IAAFRawStorage *pRawStorage,") cpp_quote("aafUID_constptr pAAFFileKind,") cpp_quote("aafBool *pRawStorageIsAAFFile)
 Does the storage contain an AAF file ?
STDAPI AAFGetPluginManager (IAAFPluginManager **ppPluginManager)
 Returns an interface of the plugin manager, which is used to select plugins for exporting.
STDAPI AAFCreateRawStorageMemory (") cpp_quote("aafFileAccess_t access,") cpp_quote("IAAFRawStorage **ppNewRawStorage)
 Create a raw storage providing a built-in implementation of IAAFRawStorage on memory.
STDAPI AAFCreateRawStorageDisk (") cpp_quote("aafCharacter_constptr pFilename,") cpp_quote("aafFileExistence_t existence,") cpp_quote("aafFileAccess_t access,") cpp_quote("IAAFRawStorage **ppNewRawStorage)
 Create a raw storage providing a built-in implementation of IAAFRawStorage on a file on disk.
STDAPI AAFCreateRawStorageCachedDisk (") cpp_quote("aafCharacter_constptr pFilename,") cpp_quote("aafFileExistence_t existence,") cpp_quote("aafFileAccess_t access,") cpp_quote("aafUInt32 pageCount,") cpp_quote("aafUInt32 pageSize,") cpp_quote("IAAFRawStorage **ppNewRawStorage)
 Create a raw storage providing a built-in implementation of IAAFRawStorage on a file on disk with caching.
STDAPI AAFCreateRawStorageCached (") cpp_quote("IAAFRawStorage *pRawStorage,") cpp_quote("aafUInt32 pageCount,") cpp_quote("aafUInt32 pageSize,") cpp_quote("IAAFRawStorage **ppNewRawStorage)
 Create a new cached raw storage from an existing raw storage.
STDAPI AAFCreateRawStorageCached2 (") cpp_quote("IAAFRawStorage *pRawStorage,") cpp_quote("aafUInt32 pageCount,") cpp_quote("aafUInt32 pageSize,") cpp_quote("IAAFCachePageAllocator *pCachePageAllocator,") cpp_quote("IAAFRawStorage **ppNewRawStorage)
 Create a new cached raw storage from an existing raw storage with control over how the cache pages are allocated.
STDAPI AAFCreateAAFFileOnRawStorage (") cpp_quote("IAAFRawStorage *pRawStorage,") cpp_quote("aafFileExistence_t existence,") cpp_quote("aafFileAccess_t access,") cpp_quote("aafUID_constptr pFileKind,") cpp_quote("aafUInt32 modeFlags,") cpp_quote("aafProductIdentification_constptr pIdent,") cpp_quote("IAAFFile **ppNewFile)
 Given an IAAFRawStorage, create an IAAFFile.
STDAPI AAFSetProgressCallback (IAAFProgress *pProgress)
 Sets a progress callback, called back during load and save.
STDAPI AAFGetFileEncodings (IEnumAAFFileEncodings **ppFileEncodings)
 Returns an enumeration of file encodings supported by this version of the library.
STDAPI AAFSetDiagnosticOutput (IAAFDiagnosticOutput *pOutput)
 Make the specified diagnostic output stream the AAF Toolkit's diagnostic output stream.
STDAPI AAFGetLibraryVersion (aafProductVersion_t *pVersion)
 Return the version of the AAF library currently running on this machine, which implements these interfaces.
STDAPI AAFGetStaticLibraryVersion (aafProductVersion_t *pVersion)
 Return the version of the static (aaflib) library linked against the calling appplication.
STDAPI AAFGetLibraryPathNameBufLen (aafUInt32 *pBufSize)
 Returns size of buffer (in bytes) required for AAFGetLibraryPathName().
STDAPI AAFGetLibraryPathName (") cpp_quote("aafCharacter *pLibraryPathName,") cpp_quote("aafUInt32 bufSize)
 Get the pathname of the AAF library.
STDAPI AAFResultToTextBufLen (") cpp_quote("AAFRESULT result,") cpp_quote("aafUInt32 *pResultTextSize)
 Returns the size of the buffer, in bytes, required for the AAFResultToText() function.
STDAPI AAFResultToText (") cpp_quote("AAFRESULT result,") cpp_quote("aafCharacter *pResultText,") cpp_quote("aafUInt32 resultTextSize)
 /// Returns the text representation of an AAFRESULT.

Function Documentation

STDAPI AAFCreateAAFFileOnRawStorage ( ) const

Given an IAAFRawStorage, create an IAAFFile.

If pRawStorage is actually an IAAFRandomRawStorage, the created file will be an IAAFRandomFile.

Note that AAF files based on Binary Structured Storage will require the underlying IAAFRawStorage to be at least readable, even in the case of write-only AAF files.

Note also that only the following combinations of access and existence are legal:

existence access Legal? --------- ------ ------ existing read yes existing write no existing modify yes new read no new write yes new modify yes

This method will succeed if the following are true:

  • The pRawStorage pointer is valid.
  • The ppNewFile pointer is valid.
  • The accessibility of the specified raw storage matches that of the desired AAF File; additionally, if the file kind is Structured Storage Binary, the raw storage is also required to be at least readable.
  • A legal combination of existence and access flags is given.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • pRawStorage or ppNewFile arg is NULL.

AAFRESULT_NOT_READABLE

  • The access parameter specifies readability or if this file is Binary Structured Storage, but the specified raw storage is not readable.

AAFRESULT_NOT_WRITEABLE

  • The access parameter specifies writeability but the specified raw storage is not writeable.

AAFRESULT_NULL_PARAM

  • existence is new, and pFileKind is NULL.

AAFRESULT_INVALID_PARAM

  • The access or existence parameters are not set to a legal combination of values.
Parameters:
pRawStorage[in] storage to be associated with this file
existence[in] Governs whether storage is on pre-existing data, or is newly created.
access[in] Governs whether stream may be read from and/or written to.
pFileKind[in] kind of file to be created; only used for new files
modeFlags[in] File mode flags
pIdent[in] Identification to be associated with this file; only used for new files
ppNewFile[out] newly-created file
STDAPI AAFCreateRawStorageCached ( )

Create a new cached raw storage from an existing raw storage.

Succeeds if:

  • The pRawStorage pointer is valid.
  • The ppNewRawStorage pointer is valid.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • pRawStorage or ppNewRawStorage arg is NULL.
Parameters:
pRawStorage[in] Existing raw storage
pageCount[in] Count of cache pages
pageSize[in] Cache page size in bytes
ppNewRawStorage[out] Newly created cached storage
STDAPI AAFCreateRawStorageCached2 ( )

Create a new cached raw storage from an existing raw storage with control over how the cache pages are allocated.

Note that pages are allocated as needed so that the toolkit calls Allocate() a maximum of pageCount times (fewer than pageCount calls will be made if the data fits entirely within the cache).

Succeeds if:

  • The pRawStorage pointer is valid.
  • The pCachePageAllocator pointer is valid.
  • The ppNewRawStorage pointer is valid.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • either pRawStorage, pCachePageAllocator or ppNewRawStorage arg is NULL.
Parameters:
pRawStorage[in] Existing raw storage
pageCount[in] Count of cache pages
pageSize[in] Cache page size in bytes
pCachePageAllocator[in] Cache page memory allocator
ppNewRawStorage[out] Newly created cached storage
STDAPI AAFCreateRawStorageCachedDisk ( ) const

Create a raw storage providing a built-in implementation of IAAFRawStorage on a file on disk with caching.

Note that it is illegal to specify existence and access as "New" "Read".

This is considered a value-added function since clients could actually create their own.

Succeeds if:

  • The pFilename pointer is valid.
  • The ppNewRawStorage pointer is valid.
  • If the open mode is one of read, write, or modify.
  • If the file existence is one of new or existing.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • pFilename or ppNewRawStorage arg is NULL.

AAFRESULT_WRONG_OPENMODE

  • If none of read, modify, or write are specified as open mode, or if neither new or existing is specified for the existence.
Parameters:
pFilename[in] Name of file to be associated with this storage
existence[in] Governs whether storage is on pre-existing data, or is newly created.
access[in] Governs whether stream may be read from and/or written to.
pageCount[in] Count of cache pages
pageSize[in] Cache page size in bytes
ppNewRawStorage[out] Newly created storage
STDAPI AAFCreateRawStorageDisk ( ) const

Create a raw storage providing a built-in implementation of IAAFRawStorage on a file on disk.

Note that it is illegal to specify existence and access as "New" "Read".

This is considered a value-added function since clients could actually create their own.

Succeeds if:

  • The pFilename pointer is valid.
  • The ppNewRawStorage pointer is valid.
  • If the open mode is one of read, write, or modify.
  • If the file existence is one of new or existing.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • pFilename or ppNewRawStorage arg is NULL.

AAFRESULT_WRONG_OPENMODE

  • If none of read, modify, or write are specified as open mode, or if neither new or existing is specified for the existence.
Parameters:
pFilename[in] Name of file to be associated with this storage
existence[in] Governs whether storage is on pre-existing data, or is newly created.
access[in] Governs whether stream may be read from and/or written to.
ppNewRawStorage[out] Newly created storage
STDAPI AAFCreateRawStorageMemory ( )

Create a raw storage providing a built-in implementation of IAAFRawStorage on memory.

This is considered a value-added function since clients could actually create their own.

Succeeds if:

  • The ppNewRawStorage pointer is valid.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • ppNewRawStorage arg is NULL.
Parameters:
access[in] Governs whether stream may be read from and/or written to.
ppNewRawStorage[out] Newly created storage
STDAPI AAFFileIsAAFFile ( ) const

Is the named file an AAF file ?

Note that the function result is returned via the pFileIsAAFFile argument. If this function succeeds it returns AAFRESULT_SUCCESS even if the named file is not an AAF file.

This function will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • at least one of the pointer arguments is NULL.

AAFRESULT_FILE_NOT_FOUND

  • the file named by pFileName cannot be found.
Parameters:
pFileName[in, string] Null-terminated string containing name of filesystem file.
pAAFFileKind[out] Pointer to an AUID indicating the file kind
pFileIsAAFFile[out,retval] Returns AAFTrue if the given file is an AAF file, returns AAFFalse otherwise.
STDAPI AAFFileIsAAFFileKind ( ) const

Is the named file an AAF file ?

Note that the function result is returned via the pFileIsAAFFile argument. If this function succeeds it returns AAFRESULT_SUCCESS even if the named file is not an AAF file of the specified kind.

This function will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • at least one of the pointer arguments is NULL.

AAFRESULT_FILEKIND_NOT_REGISTERED

  • the specified file kind is not supported by the toolkit.
Parameters:
pFileName[in, string] Null-terminated string containing name of filesystem file.
pAAFFileKind[in] Pointer to an AUID indicating the file kind to check for
pFileIsAAFFile[out,retval] Returns AAFTrue if the given file is an AAF file of the specified kind, returns AAFFalse otherwise.
STDAPI AAFFileOpenExistingModify ( ) const

Creates an object associated with with an existing filesystem file that contains data which is to be read and written.

Associates the given identification with it. Does the following:

  • Opens the existing named file in the filesystem for reading and writing.
  • Associates an object with that filesystem file.
  • Places the object into the Open-read-write state.
  • This AAFFile object then can be used as the root of the containment tree representing all AAF objects contained within the file.

Succeeds if:

  • This object is currently Closed.
  • The pFileName argument is valid.
  • The pIdent argument is valid.
  • Only valid flags have been specified.
  • A valid combination of flags has been specified.
  • The named file exists in the filesystem.
  • The named filesystem file is readable.
  • The named filesystem file is writable.
  • The named file represents itself as a valid AAF file. Even if this succeeds, it is not guaranteed that the named file is in fact a valid AAF file.

This function will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • either pFileName or pIdent pointer argument is NULL.

AAFRESULT_BAD_FLAGS

  • one or more illegal flags were specified.

AAFRESULT_BAD_FLAG_COMBINATION

  • illegal combination of otherwise valid flags was specified.

AAFRESULT_FILE_NOT_FOUND

  • The named file does not exist in the filesystem.

AAFRESULT_NOT_READABLE

  • The named file cannot be read.

AAFRESULT_NOT_WRITEABLE

  • The named file cannot be written.

AAFRESULT_NOTAAFFILE

  • The named file is not a valid AAF file.
Parameters:
pFileName[in, string] Null-terminated string containing name of filesystem file to be opened for modification. The file name has no restrictions other than those imposed by the underlying file system. AAF files that use structured storage encoding typically use the extension .aaf or .isr. AAF files that use XML encoding typically use the .xml extension. AAF files that use KLV encoding typically use use the extension .mxf or .klv.
modeFlags[in] File open mode flags. May be any of the following ORed together. All other bits must be set to zero.
  • kAAFFileModeUnbuffered to indicate unbuffered mode. Default is buffered.
  • kAAFFileModeRevertable to indicate that Revert is possible on this file (for all changes except those to essence).
    Parameters:
    pIdent[in] Identification of the application which is modifying this file.
    ppFile[out] Pointer to buffer to receive pointer to new file.
STDAPI AAFFileOpenExistingRead ( ) const

***********************************************************")

Factory functions for AAF files:.") ***********************************************************") Creates an object associated with with an existing filesystem file that contains data which is only to be read. Does the following:

  • Opens the existing named file in the filesystem for reading.
  • Associates an object with that filesystem file.
  • Places the object into the Open-read-only state.
  • This AAFFile object then can be used as the root of the containment tree representing all AAF objects contained within the file.

Succeeds if:

  • The pFileName argument is valid.
  • Only valid flags have been specified.
  • A valid combination of flags has been specified.
  • The named file exists in the filesystem.
  • The named filesystem file is readable.
  • The named file represents itself as a valid AAF file. Even if this succeeds, it is not guaranteed that the named file is in fact a valid AAF file.

This function will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • the pFileName pointer arg is NULL.

AAFRESULT_BAD_FLAGS

  • one or more illegal flags were specified.

AAFRESULT_BAD_FLAG_COMBINATION

  • illegal combination of otherwise valid flags was specified.

AAFRESULT_FILE_NOT_FOUND

  • The named file does not exist in the filesystem.

AAFRESULT_NOT_READABLE

  • The named file cannot be read.

AAFRESULT_NOT_AAF_FILE

  • The named file does not claim to be a valid AAF file.
Parameters:
pFileName[in, string] Null-terminated string containing name of filesystem file to be opened for reading. The file name has no restrictions other than those imposed by the underlying file system. AAF files that use structured storage encoding typically use the extension .aaf or .isr. AAF files that use XML encoding typically use the .xml extension. AAF files that use KLV encoding typically use use the extension .mxf or .klv.
modeFlags[in] File open mode flags. May be any of the following ORed together. All other bits must be set to zero.
  • kAAFFileModeUnbuffered - to indicate buffered mode. Default is buffered.
    Parameters:
    ppFile[out] Pointer to buffer to receive pointer to new file.
STDAPI AAFFileOpenNewModify ( ) const

Creates an object associated with with a new filesystem file that contains data which is to be read and written.

Associates the given identification with it. Does the following:

  • Creates a new file in the filesystem with the given name.
  • Opens the filesystem file for reading and writing.
  • Associates this object with that filesystem file.
  • Places this object into the Open state.
  • This AAFFile object then can be used as the root of the containment tree representing all AAF objects contained within the file.

Succeeds if:

  • The pFileName argument is valid.
  • The pIdent argument is valid.
  • Only valid flags have been specified.
  • A valid combination of flags has been specified.
  • The named file does not exists in the filesystem.
  • There is sufficient space in the filesystem to create the file.

This function will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • either pFileName or pIdent pointer argument is NULL.

AAFRESULT_BAD_FLAGS

  • one or more illegal flags were specified.

AAFRESULT_BAD_FLAG_COMBINATION

  • illegal combination of otherwise valid flags was specified.

AAFRESULT_FILE_EXISTS

  • The named file already exists in the filesystem.

AAFRESULT_INSUFFICIENT_SPACE

  • There is insufficient space in the filesystem to create this file.
Parameters:
pFileName[in, string] Null-terminated string containing name of filesystem file to be opened for modification. The file name has no restrictions other than those imposed by the underlying file system. AAF files that use structured storage encoding typically use the extension .aaf or .isr. AAF files that use XML encoding typically use the .xml extension. AAF files that use KLV encoding typically use use the extension .mxf or .klv.
modeFlags[in] File open mode flags. May be any of the following ORed together. All other bits must be set to zero.
  • kAAFFileModeUnbuffered to indicate unbuffered mode. Default is buffered.
  • kAAFFileModeRevertable to indicate that Revert is possible on this file (for all changes except those to essence).
    Parameters:
    pIdent[in] Identification of the application which is creating this file.
    ppFile[out] Pointer to buffer to receive pointer to new file.
STDAPI AAFFileOpenNewModifyEx ( ) const

Creates an object associated with with a new filesystem file that contains data which is to be read and written.

Associates the given identification with it. Does the following:

  • Creates a new file in the filesystem with the given name.
  • Opens the filesystem file for reading and writing.
  • Associates this object with that filesystem file.
  • Places this object into the Open state.
  • This AAFFile object then can be used as the root of the containment tree representing all AAF objects contained within the file.

Succeeds if:

  • The pFileName argument is valid.
  • The pFileKind argument is valid.
  • The pIdent argument is valid.
  • Only valid flags have been specified.
  • A valid combination of flags has been specified.
  • The named file does not exists in the filesystem.
  • There is sufficient space in the filesystem to create the file.

This function will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • either pFileName or pIdent pointer argument is NULL.

AAFRESULT_BAD_FLAGS

  • one or more illegal flags were specified.

AAFRESULT_BAD_FLAG_COMBINATION

  • illegal combination of otherwise valid flags was specified.

AAFRESULT_FILE_EXISTS

  • The named file already exists in the filesystem.

AAFRESULT_INSUFFICIENT_SPACE

  • There is insufficient space in the filesystem to create this file.
Parameters:
pFileName[in, string] Null-terminated string containing name of filesystem file to be opened for modification. The file name has no restrictions other than those imposed by the underlying file system. AAF files that use structured storage encoding typically use the extension .aaf or .isr. AAF files that use XML encoding typically use the .xml extension. AAF files that use KLV encoding typically use use the extension .mxf or .klv.
pFileKind[in] kind of file to be created
modeFlags[in] File open mode flags
pIdent[in] Identification of the application which is creating this file.
ppFile[out] Pointer to buffer to receive pointer to new file.
STDAPI AAFFileOpenTransient ( )

Creates an object associated with with a transient file, meaning that it is not associated with any filesystem file but may still be used to contain AAF objects as if it was associated with a filesystem file.

Associates the given identification with this file.

Transient files are never considered Revertable.

Succeeds if:

  • This object has already been Initialize()d.
  • The pIdent argument is valid.
  • This object is currently closed.

This function will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NOT_INITIALIZED

  • This object has not yet had Initialize() called on it.

AAFRESULT_ALREADY_OPEN

  • This object is already open.

AAFRESULT_NULL_PARAM

  • the pIdent pointer argument is NULL.
Parameters:
pIdent[in] Identification which is to be associated with this file.
ppFile[out] Pointer to buffer to receive pointer to new file.
STDAPI AAFGetFileEncodings ( IEnumAAFFileEncodings **  ppFileEncodings)

Returns an enumeration of file encodings supported by this version of the library.

This method will succeed if the following are true:

  • The ppFileEncodings pointer is valid.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • ppFileEncodings arg is NULL.
Parameters:
ppFileEncodings[out] Available file encodings.
STDAPI AAFGetLibraryPathName ( )

Get the pathname of the AAF library.

Writes the LibraryPathName, with a trailing null character, into the pLibraryPathName buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize.

Caller may call AAFGetLibraryPathNameBufLen() to determine the required buffer size.

If this method fails nothing will be written to pLibraryPathName.

Succeeds if:

  • The pLibraryPathName pointer is valid.
  • bufSize indicates that the buffer is large enough to hold LibraryPathName.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • pLibraryPathName arg is NULL.

AAFRESULT_SMALLBUF

  • bufSize indicates that the allocated buffer is not large enough to hold LibraryPathName.
Parameters:
pLibraryPathName[out, string, size_is(bufSize)] buffer into which LibraryPathName is to be written
bufSize[in] size of *pLibraryPathName buffer in bytes
STDAPI AAFGetLibraryPathNameBufLen ( aafUInt32 *  pBufSize)

Returns size of buffer (in bytes) required for AAFGetLibraryPathName().

Succeeds if:

  • The pBufSize pointer is valid.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • pBufSize arg is NULL.
Parameters:
pBufSize[out] size of required buffer, in bytes
STDAPI AAFGetLibraryVersion ( aafProductVersion_t *  pVersion)

Return the version of the AAF library currently running on this machine, which implements these interfaces.

Succeeds if all of the following are true:

  • the pVersion pointer is valid.

If this method fails nothing is written to *pVersion.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • pVersion is null.
Parameters:
pVersion[out, retval] The library version
STDAPI AAFGetPluginManager ( IAAFPluginManager **  ppPluginManager)

Returns an interface of the plugin manager, which is used to select plugins for exporting.

Parameters:
ppPluginManager[out] Pointer to the interface of the plugin manager.
STDAPI AAFGetStaticLibraryVersion ( aafProductVersion_t *  pVersion)

Return the version of the static (aaflib) library linked against the calling appplication.

This version may be the same as or different from the version of the (dynamically linked) AAF Library containing the implementation of the various interfaces. The version of the AAF Library may be obtained by calling AAFGetLibraryVersion().

Succeeds if all of the following are true:

  • the pVersion pointer is valid.

If this method fails nothing is written to *pVersion.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • pVersion is null.
Parameters:
pVersion[out, retval] The static library version
STDAPI AAFLoad ( const char *  dllname)

***********************************************************")

Functions used to dynamically load and unload the AAF dll") without statically linking to the dll's export library.") To use these functions link to the stub library aaf.lib") (or aafd.lib for the debugging version). ") If the client is statically linking to the AAF dll's export") library then the following functions will always succeed:") ***********************************************************") Attempts to load the given implementation of AAF into the processes address space. Only one implementation of AAF can be active. Note: once AAFUnload has been called all subsequent access to AAF interfaces will fail

To use this function link to the stub library aaf.lib (or aafd.lib for the debugging version). If the client is statically linking to the AAF dll's export library then the function will always succeed.

Parameters:
dllname[in] Pointer to the name of AAF dll to load. If this pointer is NULL the function will attempt to load the default AAF dll.
STDAPI AAFRawStorageIsAAFFile ( )

Does the storage contain an AAF file ?

Note that the function result is returned via the pRawStorageIsAAFFile argument. If this function succeeds it returns AAFRESULT_SUCCESS even if the storage is not an AAF file.

This function will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • at least one of the pointer arguments is NULL.
Parameters:
pRawStorage[in] storage containing the purported file
pAAFFileKind[out] Pointer to an AUID indicating the file kind
pRawStorageIsAAFFile[out,retval] Returns AAFTrue if the given storage contains an AAF file, returns AAFFalse otherwise.
STDAPI AAFRawStorageIsAAFFileKind ( ) const

Does the storage contain an AAF file ?

Note that the function result is returned via the pRawStorageIsAAFFile argument. If this function succeeds it returns AAFRESULT_SUCCESS even if the storage is not an AAF file of the specified kind.

This function will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • at least one of the pointer arguments is NULL.

AAFRESULT_FILEKIND_NOT_REGISTERED

  • the specified file kind is not supported by the toolkit.
Parameters:
pRawStorage[in] storage containing the purported file
pAAFFileKind[in] Pointer to an AUID indicating the file kind to check for
pRawStorageIsAAFFile[out,retval] Returns AAFTrue if the given storage contains an AAF file of the specified kind, returns AAFFalse otherwise.
STDAPI AAFResultToText ( )

/// Returns the text representation of an AAFRESULT.

Succeeds if all of the following are true:

  • the pResultText pointer is valid.
  • the result is an AAFRESULT.
  • the result is a recognized AAFRESULT.
  • the buffer is large enough to hold the result text.

If this method fails nothing will be written to resultText.

This method will return the following codes:

AAFRESULT_SUCCESS

  • succeeded.

AAFRESULT_NULL_PARAM

  • pResultText arg is NULL.

AAFRESULT_RESULT_NOT_AAF

  • result is not an AAFRESULT.

AAFRESULT_RESULT_NOT_RECOGNIZED

  • result is not a recognized AAFRESULT.

AAFRESULT_SMALLBUF

  • pResultText is too small to hold the result text.
Parameters:
result[in] The result
pResultText[out, string, size_is(resultTextSize)] The text representation of the result
resultTextSize[in] The size, in bytes, of pResultText
STDAPI AAFResultToTextBufLen ( )

Returns the size of the buffer, in bytes, required for the AAFResultToText() function.

Succeeds if all of the following are true:

  • the pResultTextSize pointer is valid.
  • the result is an AAFRESULT.
  • the result is a recognized AAFRESULT.

If this method fails nothing will be written to *pResultTextSize.

This method will return the following codes:

AAFRESULT_SUCCESS

  • succeeded.

AAFRESULT_NULL_PARAM

  • pResultTextSize arg is NULL.

AAFRESULT_RESULT_NOT_AAF

  • result is not an AAFRESULT.

AAFRESULT_RESULT_NOT_RECOGNIZED

  • result is not a recognized AAFRESULT.
Parameters:
result[in] The result
pResultTextSize[out] The size of the required buffer, in bytes.
STDAPI AAFSetDiagnosticOutput ( IAAFDiagnosticOutput pOutput)

Make the specified diagnostic output stream the AAF Toolkit's diagnostic output stream.

By default the diagnostic output goes to stderr. The passed in pointer is AddRefed. The pointer will be Released the next time AAFSetDiagnosticOutput is called or when the AAF DLL is unloaded.

This method will succeed if the following are true:

  • The pOutput pointer is valid.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

  • succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

  • pStream arg is NULL.
Parameters:
pOutput[in] New diagnostic output.
STDAPI AAFSetProgressCallback ( IAAFProgress pProgress)

Sets a progress callback, called back during load and save.

Parameters:
pProgress[in] Pointer to the interface of the progress interface callback.
STDAPI AAFUnload ( )

***********************************************************

Attempts to unload the current AAF dll loaded with a previous call to AAFLoad.


Generated on Wed Jul 4 2012 22:13:26 for AAF COM API by doxygen 1.7.4