IAAFSearchSource Interface Reference

The IAAFSearchSource interface is used to return source information for some mob slots. More...

List of all members.

Public Member Functions
HRESULT	SearchSource ([in] aafSlotID_t slotID,[in] aafPosition_t offset,[in] aafMobKind_t mobKind,[in] aafMediaCriteria_t *pMediaCrit,[in] aafOperationChoice_t *pOperationChoice,[out] IAAFFindSourceInfo **ppSourceInfo)
	This function returns the source information for a slot in a Master Mob or Source Mob.

---

Detailed Description

The IAAFSearchSource interface is used to return source information for some mob slots.

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 IAAFSearchSource is not a primary interface for a concrete 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.

Definition at line 50529 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFSearchSource::SearchSource	(	[in] aafSlotID_t	slotID,
		[in] aafPosition_t	offset,
		[in] aafMobKind_t	mobKind,
		[in] aafMediaCriteria_t *	pMediaCrit,
		[in] aafOperationChoice_t *	pOperationChoice,
		[out] IAAFFindSourceInfo **	ppSourceInfo
	)

This function returns the source information for a slot in a Master Mob or Source Mob.

It follows the Source Clip references in the specified slot until it encounters the kind of Mob specified in the mobKind parameter. This function cannot be used on a Composition Mob and is not intended to be called iteratively; use the MobOpenSearch, MobGetNextSource, MobGetThisSource, and MobCloseSearch functions for those purposes.

The returned component and find source info are AddRef()ed before they are returned.

Succeeds if all of the following are true:

• ppSourceInfo is non-NULL
• a Mob of the requested kind is found

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

• ppCpnt is null.

OM_ERR_INVALID_MOBTYPE

• The enumerator is out of range (bad cast, or writing toolkit newer than reader)

OM_ERR_TRAVERSAL_NOT_POSS

• Can not find a mob of the given kind.

Parameters:

slotID	[in] Slot ID
offset	[in] Offset
mobKind	[in] Mob Kind
pMediaCrit	[in] Media Criteria
pOperationChoice	[in] Operation Choice
ppSourceInfo	[out] Source Information