IAAFCompositionMob2 Interface Reference

List of all members.

---

Detailed Description

Objects that implement IAAFCompositionMob2 also implement the following interfaces: - IAAFMob - IAAFMob2 - IAAFObject.

Definition at line 36210 of file AAF.idl.

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.
HRESULT	SetRendering ([in, ref] aafMobID_constref mobID)
	This method will return the following codes: AAFRESULT_SUCCESS - succeeded.
HRESULT	GetRendering ([out] aafMobID_t *pMobID)
	Succeeds if all of the following are true: - the pMobID pointer is valid.

---

Member Function Documentation

HRESULT IAAFCompositionMob2::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 IAAFCompositionMob2::GetRendering (  [out] aafMobID_t *  pMobID  )

Succeeds if all of the following are true: - the pMobID pointer is valid. If this method fails nothing will be written to *pMobID. 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 pMobID arg is NULL. Parameters: pMobID  [out] Rendering MobID

HRESULT IAAFCompositionMob2::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 IAAFCompositionMob2::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

HRESULT IAAFCompositionMob2::SetRendering (  [in, ref] aafMobID_constref  mobID  )

This method will return the following codes: AAFRESULT_SUCCESS - succeeded. (This is the only code indicating success.) Parameters: mobID  [in, ref] Rendering MobID

---