The IAAFSourceClip interface is implemented by objects that reference the content data and identify the source of the content data. More...

Public Member Functions
HRESULT	Initialize ([in] IAAFDataDef *pDataDef,[in] aafLength_constref length,[in] aafSourceRef_t sourceRef)
	This method initializes a source clip object with the given properties.
HRESULT	GetFade ([out] aafLength_t pFadeInLen,[out] aafFadeType_t pFadeInType,[out] aafBoolean_t pFadeInPresent,[out] aafLength_t pFadeOutLen,[out] aafFadeType_t pFadeOutType,[out] aafBoolean_t pFadeOutPresent)
	This function returns the optional fade information from a source clip.
HRESULT	ResolveRef ([out] IAAFMob **ppMob)
	Given a source clip object, this function returns a pointer to the mob that it references.
HRESULT	GetSourceReference ([out] aafSourceRef_t *pSourceRef)
	This function returns the source reference of this source clip.
HRESULT	SetFade ([in] aafInt32 fadeInLen,[in] aafFadeType_t fadeInType,[in] aafInt32 fadeOutLen,[in] aafFadeType_t fadeOutType)
	This function sets the optional fade properties on this source clip object.
HRESULT	SetSourceReference ([in] aafSourceRef_t sourceRef)
	This function sets the source reference of this source clip.

Detailed Description

The IAAFSourceClip interface is implemented by objects that reference the content data and identify the source of the content data.

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 IAAFSourceClip also implement the following interfaces:

Definition at line 25457 of file AAF.idl.

Member Function Documentation

HRESULT IAAFSourceClip::GetFade	(	[out] aafLength_t *	pFadeInLen,
		[out] aafFadeType_t *	pFadeInType,
		[out] aafBoolean_t *	pFadeInPresent,
		[out] aafLength_t *	pFadeOutLen,
		[out] aafFadeType_t *	pFadeOutType,
		[out] aafBoolean_t *	pFadeOutPresent
	)

This function returns the optional fade information from a source clip.

This function only applies to audio source clips. Length units are specified by the containing mob slot's edit rate.

Succeeds if all of the following are true:

This object has already been Initialize()d.
the all argument pointers are valid.

If this method fails nothing will be written to any of the locations specified by the arguments.

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

any argument is NULL.

Parameters:

pFadeInLen	[out] Fade In Length
pFadeInType	[out] Fade In Type
pFadeInPresent	[out] Fade In Type
pFadeOutLen	[out] Fade Out Length
pFadeOutType	[out] Fade Out Type
pFadeOutPresent	[out] Fade In Type

HRESULT IAAFSourceClip::GetSourceReference ( [out] aafSourceRef_t * pSourceRef )

This function returns the source reference of this source clip.

Note: the 3 properties of a source Clip that make up the "source reference" are sourceID, sourceTrackID, and startTime.

Succeeds if all of the following are true:

This object has already been Initialize()d.
the pSourceRef pointer is valid.

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

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

pSourceRef arg is NULL.

Parameters:

pSourceRef [out] Source Reference

HRESULT IAAFSourceClip::Initialize	(	[in] IAAFDataDef *	pDataDef,
		[in] aafLength_constref	length,
		[in] aafSourceRef_t	sourceRef
	)

This method initializes a source clip object with the given properties.

Only required properties are set. Optional properties are added with separate functions.

Succeds if:

This object has not already been Initialize()d.

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

pDataDef argument is NULL.

Parameters:

pDataDef	[in] Data Definition object
length	[in] Length property value
sourceRef	[in] Source Reference

HRESULT IAAFSourceClip::ResolveRef ( [out] IAAFMob ** ppMob )

Given a source clip object, this function returns a pointer to the mob that it references.

The returned mob is AddRef()ed before it is returned.

Succeeds if all of the following are true:

This object has already been Initialize()d.
the ppMob pointer is valid.

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

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

ppMob arg is NULL.

AAFRESULT_MOB_NOT_FOUND

this mob does not exist.

Parameters:

ppMob [out] Referenced mob

HRESULT IAAFSourceClip::SetFade	(	[in] aafInt32	fadeInLen,
		[in] aafFadeType_t	fadeInType,
		[in] aafInt32	fadeOutLen,
		[in] aafFadeType_t	fadeOutType
	)

This function sets the optional fade properties on this source clip object.

The fade properties only apply to a source clip of data definition (or convertible to a data definition) of type Sound. All arguments should be specified. Length units are specified by the containing mob slot's edit rate.

Succeeds if all of the following are true:

This object has already been Initialize()d.

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.

Parameters:

fadeInLen	[in] Fade In Length
fadeInType	[in] Fade In Type
fadeOutLen	[in] Fade Out Length
fadeOutType	[in] Fade Out Type

HRESULT IAAFSourceClip::SetSourceReference ( [in] aafSourceRef_t sourceRef )

This function sets the source reference of this source clip.

Note: the 3 properties of a source Clip that make up the "source reference" are sourceID, sourceTrackID, and startTime.

Succeeds if all of the following are true:

This object has already been Initialize()d.

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.

Parameters:

sourceRef [in] Source Reference

Public Member Functions

Detailed Description

Member Function Documentation