IAAFSourceReference Interface Reference

The IAAFSourceReference interface is implemented by objects that represent the essence or other data described by a MobSlot in a Mob. More...

List of all members.

Public Member Functions
HRESULT	GetSourceID ([retval][out] aafMobID_t *pSourceID)
	Gets the SourceID and places it into the pSourceID argument.
HRESULT	SetSourceID ([in] aafMobID_constref sourceID)
	Sets the SourceID using the sourceID argument.
HRESULT	GetSourceMobSlotID ([retval][out] aafSlotID_t *pMobSlotID)
	Gets the Mob Slot ID and places it into the pMobSlotID argument.
HRESULT	SetSourceMobSlotID ([in] aafSlotID_t mobSlotID)
	Sets the mob slot ID using the mobSlotID argument.

---

Detailed Description

The IAAFSourceReference interface is implemented by objects that represent the essence or other data described by a MobSlot in a 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 IAAFSourceReference 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 IAAFSourceReference also implement the following interfaces:

IAAFSourceReference2

• IAAFSegment
• IAAFComponent
• IAAFComponent2
• IAAFObject

Definition at line 26251 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFSourceReference::GetSourceID

(

[out] aafMobID_t *

pSourceID

)

Gets the SourceID and places it into the pSourceID argument.

Succeeds if all of the following are true:

• the pSourceID pointer is valid.

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

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

• pSourceID arg is NULL.

Parameters:

pSourceID

[retval][out] Place to put source ID

HRESULT IAAFSourceReference::GetSourceMobSlotID

(

[out] aafSlotID_t *

pMobSlotID

)

Gets the Mob Slot ID and places it into the pMobSlotID argument.

Succeeds if all of the following are true:

• the pMobSlotID pointer is valid.

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

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

• pMobSlotID arg is NULL.

Parameters:

pMobSlotID

[retval][out] Place to put source mob slot ID

HRESULT IAAFSourceReference::SetSourceID

(

[in] aafMobID_constref

sourceID

)

Sets the SourceID using the sourceID argument.

Always succeeds.

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.)

Parameters:

sourceID

[in] Source ID to set

HRESULT IAAFSourceReference::SetSourceMobSlotID

(

[in] aafSlotID_t

mobSlotID

)

Sets the mob slot ID using the mobSlotID argument.

Succeeds if all of the following are true:

• (preconditions here)

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.)

(other error codes here.)

Parameters:

mobSlotID

[in] Source Mob ID to set