IAAFEssenceContainer Interface Reference

This interface is used to access essence data in an external data file. More...

List of all members.

Public Member Functions
HRESULT	CreateEssenceStream ([in, string] aafCharacter_constptr pName,[in] aafMobID_constptr pMobID,[out, retval] IAAFEssenceStream **ppEssenceStream)
	Attempt to create an essence stream in the container for reading and writing.
HRESULT	CreateEssenceStreamWriteOnly ([in, string] aafCharacter_constptr pPath,[in] aafMobID_constptr pMobID,[out, retval] IAAFEssenceStream **ppEssenceStream)
	Attempt to create an essence stream in the container for writing.
HRESULT	OpenEssenceStreamReadOnly ([in, string] aafCharacter_constptr pFilePath,[in] aafMobID_constptr pMobID,[out, retval] IAAFEssenceStream **ppEssenceStream)
	Attempt to open an essence stream for reading.
HRESULT	OpenEssenceStreamAppend ([in, string] aafCharacter_constptr pFilePath,[in] aafMobID_constptr pMobID,[out, retval] IAAFEssenceStream **ppEssenceStream)
	Attempt to open an essence stream for appending.

---

Detailed Description

This interface is used to access essence data in an external data file.

In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values:

AAFRESULT_NOMEMORY

• insufficient system memory is available to perform the operation.

Definition at line 2914 of file AAFPlugin.idl.

---

Member Function Documentation

HRESULT IAAFEssenceContainer::CreateEssenceStream	(	[in, string] aafCharacter_constptr	pName,
		[in] aafMobID_constptr	pMobID,
		[out, retval] IAAFEssenceStream **	ppEssenceStream
	)

Attempt to create an essence stream in the container for reading and writing.

Returns one of the following:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• both pName and pMobID cannot be NULL.

AAFRESULT_ILLEGAL_VALUE

• pName or pMobID (or both) are invalid

AAFRESULT_FILE_EXISTS

• the given path and or mobID already points to an existing stream within the container.

Parameters:

pName	[in, string] String key to identify the new essence within container
pMobID	[in] Optional mobID identifying the essence
ppEssenceStream	[out, retval] address of local variable to contain the essence stream pointer.

HRESULT IAAFEssenceContainer::CreateEssenceStreamWriteOnly	(	[in, string] aafCharacter_constptr	pPath,
		[in] aafMobID_constptr	pMobID,
		[out, retval] IAAFEssenceStream **	ppEssenceStream
	)

Attempt to create an essence stream in the container for writing.

Returns one of the following:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• both pName and pMobID cannot be NULL.

AAFRESULT_ILLEGAL_VALUE

• pName or pMobID (or both) are invalid

AAFRESULT_FILE_EXISTS

• the given path and or mobID already points to an existing stream within the container.

Parameters:

pPath	[in, string] String key to identify the new essence within container
pMobID	[in] Optional mobID identifying the essence
ppEssenceStream	[out, retval] address of local variable to contain the essence stream pointer.

HRESULT IAAFEssenceContainer::OpenEssenceStreamAppend	(	[in, string] aafCharacter_constptr	pFilePath,
		[in] aafMobID_constptr	pMobID,
		[out, retval] IAAFEssenceStream **	ppEssenceStream
	)

Attempt to open an essence stream for appending.

Returns one of the following:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• both pName and pMobID cannot be NULL.

AAFRESULT_ILLEGAL_VALUE

• pName or pMobID (or both) are invalid

AAFRESULT_MEDIA_NOT_FOUND

• the given path does not point to an existing stream within the container.

AAFRESULT_NOT_WRITEABLE

• stream is read-only, cannot be opened for writing.

Parameters:

pFilePath	[in, string] String key to identify the existing essence within container
pMobID	[in] Optional mobID identifying the essence
ppEssenceStream	[out, retval] address of local variable to contain the essence stream pointer.

HRESULT IAAFEssenceContainer::OpenEssenceStreamReadOnly	(	[in, string] aafCharacter_constptr	pFilePath,
		[in] aafMobID_constptr	pMobID,
		[out, retval] IAAFEssenceStream **	ppEssenceStream
	)

Attempt to open an essence stream for reading.

Returns one of the following:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• both pName and pMobID cannot be NULL.

AAFRESULT_ILLEGAL_VALUE

• pName or pMobID (or both) are invalid

AAFRESULT_MEDIA_NOT_FOUND

• the given path does not point to an existing stream within the container.

AAFRESULT_NOT_READABLE

• stream is write-only, cannot be opened for reading.

Parameters:

pFilePath	[in, string] String key to identify the existing essence within container
pMobID	[in] Optional mobID identifying the essence
ppEssenceStream	[out, retval] address of local variable to contain the essence stream pointer.