Main Page | Class List | File List | Class Members | File Members

IAAFEssenceDescriptor Interface Reference

Detailed Description

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.

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.

AAFRESULT_NOT_INITIALIZED

This object has not yet had Initialize() called on it through this object's primary interface. Note that IAAFEssenceDescriptor is a primary interface for an abstract class, so it is not appropriate for the Initialize() method to exist in this interface. The Initialize() method is available through the concrete object's primary interface.

Objects that implement IAAFEssenceDescriptor also implement the following interfaces:

IAAFObject

Definition at line 6774 of file AAF.idl.

Public Member Functions

HRESULT CountLocators ([out] aafUInt32 *pResult)

Return the number of locators attached to this essence descriptor.

HRESULT AppendLocator ([in] IAAFLocator *pLocator)

Append another locator to this essence descriptor.

HRESULT PrependLocator ([in] IAAFLocator *pLocator)

Prepend another locator to this essence descriptor.

HRESULT InsertLocatorAt ([in] aafUInt32 index,[in] IAAFLocator *pLocator)

Inserts the given locator at the given index.

HRESULT GetLocatorAt ([in] aafUInt32 index,[out, retval] IAAFLocator **ppLocator)

Retrieves the locator at the given index.

HRESULT RemoveLocatorAt ([in] aafUInt32 index)

Removes the locator at the given index.

HRESULT GetLocators ([out] IEnumAAFLocators **ppEnum)

Returns an enumerator to the locators.

Member Function Documentation

HRESULT IAAFEssenceDescriptor::AppendLocator ( [in] IAAFLocator * pLocator )

Append another locator to this essence descriptor.
Use this function to add a locator to be scanned last when searching for the essence (a secondary location for the essence).
Succeeds if all of the following are true:

the pLocator pointer is valid.

If this method fails no state will be changed.
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

pLocator is null.

Parameters:

pLocator [in] Locator to append

HRESULT IAAFEssenceDescriptor::CountLocators ( [out] aafUInt32 * pResult )

Return the number of locators attached to this essence descriptor.
The number of locators may be zero if the essence is in the current file.
Succeeds if all of the following are true:

the pCount pointer is valid.

If this method fails nothing is written to *pCount.
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

pCount is null.

Parameters:

pResult [out] Returns the number of locators

HRESULT IAAFEssenceDescriptor::GetLocatorAt ( [in] aafUInt32 index,

[out, retval] IAAFLocator ** ppLocator

)

Retrieves the locator at the given index.
Succeeds if all of the following are true:

the pLocator pointer is valid.
index is less than the value returned by CountLocators().

If this method fails no state will be changed.
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

pLocator is null.

AAFRESULT_BADINDEX

index is greater than or equal to the value returned by CountLocators().

Parameters:

index [in] index of locator to retrieve

ppLocator [out, retval] returned locator

HRESULT IAAFEssenceDescriptor::GetLocators ( [out] IEnumAAFLocators ** ppEnum )

Returns an enumerator to the locators.
The number of locators may be zero if the essence is in the current file.
Succeeds if all of the following are true:

the ppEnum pointer is valid.

If this method fails nothing will be written to *ppEnum.
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

ppEnum is null.

Parameters:

ppEnum [out] An enumerator to the locators on this essence descriptor

HRESULT IAAFEssenceDescriptor::InsertLocatorAt ( [in] aafUInt32 index,

[in] IAAFLocator * pLocator

)

Inserts the given locator at the given index.
Locators already existing at the given and higher indices will be moved to the next higher index to accommodate.
Succeeds if all of the following are true:

the pLocator pointer is valid.
index is less than or equal to the value returned by CountLocators().

If this method fails no state will be changed.
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

pLocator is null.

AAFRESULT_BADINDEX

index is greater than the value returned by CountLocators().

Parameters:

index [in] index at which locator is to be inserted

pLocator [in] Locator to append

HRESULT IAAFEssenceDescriptor::PrependLocator ( [in] IAAFLocator * pLocator )

Prepend another locator to this essence descriptor.
Use this function to add a locator to be scanned first when searching for the essence (a new primary location for the essence).
Succeeds if all of the following are true:

the pLocator pointer is valid.

If this method fails no state will be changed.
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

pLocator is null.

Parameters:

pLocator [in] Locator to append

HRESULT IAAFEssenceDescriptor::RemoveLocatorAt ( [in] aafUInt32 index )

Removes the locator at the given index.
Locators already existing at indices higher than the given index will be moved to the next lower index to accommodate.
Succeeds if all of the following are true:

index is less than the value returned by CountLocators().

If this method fails no state will be changed.
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_BADINDEX

index is greater than or equal to the value returned by CountLocators().

Parameters:

index [in] index of locator to remove

Generated on Thu Feb 17 09:34:16 2005 for AAF COM API by

1.4.1


Public Member Functions
HRESULT	CountLocators ([out] aafUInt32 *pResult)
	Return the number of locators attached to this essence descriptor.
HRESULT	AppendLocator ([in] IAAFLocator *pLocator)
	Append another locator to this essence descriptor.
HRESULT	PrependLocator ([in] IAAFLocator *pLocator)
	Prepend another locator to this essence descriptor.
HRESULT	InsertLocatorAt ([in] aafUInt32 index,[in] IAAFLocator *pLocator)
	Inserts the given locator at the given index.
HRESULT	GetLocatorAt ([in] aafUInt32 index,[out, retval] IAAFLocator **ppLocator)
	Retrieves the locator at the given index.
HRESULT	RemoveLocatorAt ([in] aafUInt32 index)
	Removes the locator at the given index.
HRESULT	GetLocators ([out] IEnumAAFLocators **ppEnum)
	Returns an enumerator to the locators.