IAAFCompositionMob Interface Reference

IAAFCompositionMob is DEPRECATED, please use IAAFCompositionMob2. More...

List of all members.

Public Member Functions
HRESULT	Initialize ([in, string] aafCharacter_constptr pName)
	Initializes this object with the given name.
HRESULT	GetDefaultFade ([out] aafDefaultFade_t *pResult)
	Get the default fade for this composition.
HRESULT	SetDefaultFade ([in] aafLength_t fadeLength,[in] aafFadeType_t fadeType,[in] aafRational_t fadeEditUnit)
	Adds the default crossfade properties to the Mob.

---

Detailed Description

IAAFCompositionMob is DEPRECATED, please use IAAFCompositionMob2.

The IAAFCompositionMob 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.

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. Objects that implement IAAFCompositionMob also implement the following interfaces:

IAAFCompositionMob2

• IAAFMob
• IAAFMob2
• IAAFObject

Definition at line 3944 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFCompositionMob::GetDefaultFade

(

[out] aafDefaultFade_t *

pResult

)

Get the default fade for this composition.

If there is no default fade, this function returns with no error, but the VALID field of the structure is false. This allows you to pass this struct to SourceClip::GetFade() in all cases.

Succeeds if all of the following are true:

• this object has already been initialized.
• the pResult 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_NOT_INITIALIZED

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

AAFRESULT_NULL_PARAM

• pResult argument is NULL.

Parameters:

pResult

[out] a default fade struct

HRESULT IAAFCompositionMob::Initialize

(

[in, string] aafCharacter_constptr

pName

)

Initializes this object with the given name.

Succeeds if all of the following are true:

• this object has not yet been initialized.
• the pName 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_ALREADY_INITIALIZED

• Initialize() has already been called on this object.

AAFRESULT_NULL_PARAM

• pName argument is NULL.

Parameters:

pName

[in, string] Mob name [optional]

HRESULT IAAFCompositionMob::SetDefaultFade	(	[in] aafLength_t	fadeLength,
		[in] aafFadeType_t	fadeType,
		[in] aafRational_t	fadeEditUnit
	)

Adds the default crossfade properties to the Mob.

Succeeds if all of the following are true:

• this object has already been initialized.

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_NOT_INITIALIZED

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

AAFRESULT_BAD_TYPE

• invalid fadeType.

AAFRESULT_BAD_LENGTH

• invalid fadeLength.

Parameters:

fadeLength	[in] Default fade length
fadeType	[in] default fade type
fadeEditUnit	[in] default fade edit unit