In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values: 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	CountDescribedSlotIDs ([out, retval] aafUInt32 *pCount)
	Gets the total number of described slot IDs present in the list of described slot IDs referenced by this DescriptiveClip.
HRESULT	GetDescribedSlotIDs ([in] aafUInt32 maxDescribedSlotIDCount,[out, size_is(maxDescribedSlotIDCount)] aafUInt32 *pDescribedSlotIDs)
	Gets all the described slot IDs in the list of described slot IDs referenced by this DescriptiveClip.
HRESULT	IsDescribedSlotIDPresent ([in] aafUInt32 DescribedSlotID,[out, retval] aafBoolean_t *pIsPresent)
	Determines if the given described slot ID is present in the list of described slot IDs referenced by this DescriptiveClip.
HRESULT	AddDescribedSlotID ([in] aafUInt32 DescribedSlotID)
	Appends the given described slot ID to the list of described slot IDs referenced by this DescriptiveClip.
HRESULT	RemoveDescribedSlotID ([in] aafUInt32 DescribedSlotID)
	Removes the given described slot ID from the list of described slot IDs referenced by this DescriptiveClip.

Detailed Description

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

Definition at line 5601 of file AAF.idl.

Member Function Documentation

HRESULT IAAFDescriptiveClip::AddDescribedSlotID ( [in] aafUInt32 DescribedSlotID )

Appends the given described slot ID to the list of described slot IDs referenced by this DescriptiveClip.

Succeeds if all of the following are true:

the given described slot ID is not already contained in the list of described slot IDs referenced by this DescriptiveClip.

If this method fails, the property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_INVALID_PARAM

The given described slot ID is already contained in the list of described slot IDs referenced by this DescriptiveClip.

Parameters:

DescribedSlotID [in] described slot ID to add.

HRESULT IAAFDescriptiveClip::CountDescribedSlotIDs ( [out, retval] aafUInt32 * pCount )

Gets the total number of described slot IDs present in the list of described slot IDs referenced by this DescriptiveClip.

Succeeds if all of the following are true:

the pCount pointer is valid;
the DescribedSlotIDs property is present.

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

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

pCount arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

the DescribedSlotIDs property is not present.

Parameters:

pCount [out, retval] Number of described slot IDs

HRESULT IAAFDescriptiveClip::GetDescribedSlotIDs	(	[in] aafUInt32	maxDescribedSlotIDCount,
		[out, size_is(maxDescribedSlotIDCount)] aafUInt32 *	pDescribedSlotIDs
	)

Gets all the described slot IDs in the list of described slot IDs referenced by this DescriptiveClip.

The values are written to the array specified by pDescribedSlotIDs, which is of size maxDescribedSlotIDCount. The required size may be found by calling CountDescribedSlotIDs().

Succeeds if all of the following are true:

pDescribedSlotIDs is a valid pointer;
maxDescribedSlotIDCount indicates the array is large enough to hold the data;
the DescribedSlotIDs property is present.

If this method fails, the property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pDescribedSlotIDs is NULL.

AAFRESULT_SMALLBUF

maxDescribedSlotIDCount indicates that the array is too small to hold all the referenced described slot IDs.

AAFRESULT_PROP_NOT_PRESENT

the DescribedSlotIDs property is not present.

Parameters:

maxDescribedSlotIDCount	[in] The size of the given pDescribedSlotIDs buffer
pDescribedSlotIDs	[out, size_is(maxDescribedSlotIDCount)] Array to hold the described slot IDs

HRESULT IAAFDescriptiveClip::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 IAAFDescriptiveClip::IsDescribedSlotIDPresent	(	[in] aafUInt32	DescribedSlotID,
		[out, retval] aafBoolean_t *	pIsPresent
	)

Determines if the given described slot ID is present in the list of described slot IDs referenced by this DescriptiveClip.

Succeeds if all of the following are true:

the pIsPresent pointer is valid;
the DescribedSlotIDs property is present.

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

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

pIsPresent arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

the DescribedSlotIDs property is not present.

Parameters:

DescribedSlotID	[in] described slot ID whose presence is to be queried
pIsPresent	[out,retval] True if DescribedSlotID is present

HRESULT IAAFDescriptiveClip::RemoveDescribedSlotID ( [in] aafUInt32 DescribedSlotID )

Removes the given described slot ID from the list of described slot IDs referenced by this DescriptiveClip.

If the removed ID was the last ID in the list, the list is removed from this DescriptiveClip (the property is removed).

Succeeds if all of the following are true:

the DescribedSlotIDs property is present;
the given described slot ID is present in the list of described slot IDs referenced by this DescriptiveClip.

If this method fails, the property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_PROP_NOT_PRESENT

property not present.

AAFRESULT_INVALID_PARAM

The given described slot ID is not present in the list of described slot IDs referenced by this DescriptiveClip.

Parameters:

DescribedSlotID [in] described slot ID to remove.

Public Member Functions

Detailed Description

Member Function Documentation