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

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.
HRESULT	SetChannelIDs ([in] aafUInt32 numberElements,[in] aafUInt32 *pChannelIDs)
	Specify the channels in a slot that are referenced.
HRESULT	GetChannelIDs ([in] aafUInt32 numberElements,[in] aafUInt32 *pChannelIDs)
	Get the channels in a slot that are referenced.
HRESULT	GetChannelIDsSize ([out] aafUInt32 *pSize)
	Returns the size in bytes of the buffer required to hold the array returned by GetChannelIDs().
HRESULT	SetMonoSourceSlotIDs ([in] aafUInt32 numberElements,[in] aafUInt32 *pMonoSourceSlotIDs)
	For reference from a multi-channel MobSlot to multiple mono MobSlots.
HRESULT	GetMonoSourceSlotIDs ([in] aafUInt32 numberElements,[in] aafUInt32 *pMonoSourceSlotIDs)
	Get the mono slot IDs that are referenced by this object.
HRESULT	GetMonoSourceSlotIDsSize ([out] aafUInt32 *pSize)
	Returns the size in bytes of the buffer required to hold the array returned by GetMonoSourceSlotIDs().

Detailed Description

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

Definition at line 50625 of file AAF.idl.

Member Function Documentation

HRESULT IAAFSourceReference2::GetChannelIDs	(	[in] aafUInt32	numberElements,
		[in] aafUInt32 *	pChannelIDs
	)

Get the channels in a slot that are referenced.

Refer to SetChannelIDs for channel IDs description.

Return codes:

AAFRESULT_SUCCESS

succeeded

AAFRESULT_NULL_PARAM

pChannelIDs is null

AAFRESULT_PROP_NOT_PRESENT

the property is not present

AAFRESULT_SMALLBUF

pChannelIDs is too small

Parameters:

numberElements	[in] Number of elements in the pChannelIDs array
pChannelIDs	[in] Array of channel IDs

HRESULT IAAFSourceReference2::GetChannelIDsSize ( [out] aafUInt32 * pSize )

Returns the size in bytes of the buffer required to hold the array returned by GetChannelIDs().

Return codes:

AAFRESULT_SUCCESS

succeeded

AAFRESULT_NULL_PARAM

pSize is null

Parameters:

pSize [out] required buffer size to hold the ChannelIDs array

HRESULT IAAFSourceReference2::GetMonoSourceSlotIDs	(	[in] aafUInt32	numberElements,
		[in] aafUInt32 *	pMonoSourceSlotIDs
	)

Get the mono slot IDs that are referenced by this object.

Refer to SetMonoSourceSlotIDs for a description of pMonoSourceSlotIDs.

Return codes:

AAFRESULT_SUCCESS

succeeded

AAFRESULT_NULL_PARAM

pMonoSourceSlotIDs is null

AAFRESULT_PROP_NOT_PRESENT

the property is not present

AAFRESULT_SMALLBUF

pMonoSourceSlotIDs is too small

Parameters:

numberElements	[in] Number of elements in the pMonoSourceSlotIDs array
pMonoSourceSlotIDs	[in] Array of channel IDs

HRESULT IAAFSourceReference2::GetMonoSourceSlotIDsSize ( [out] aafUInt32 * pSize )

Returns the size in bytes of the buffer required to hold the array returned by GetMonoSourceSlotIDs().

Return codes:

AAFRESULT_SUCCESS

succeeded

AAFRESULT_NULL_PARAM

pSize is null

Parameters:

pSize [out] required buffer size to hold the MonoSourceSlotIDs array

HRESULT IAAFSourceReference2::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 IAAFSourceReference2::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 IAAFSourceReference2::SetChannelIDs	(	[in] aafUInt32	numberElements,
		[in] aafUInt32 *	pChannelIDs
	)

Specify the channels in a slot that are referenced.

The first channel has and ID of 1, the N'th channel has an ID of N. The number of channel IDs shall equal the number of channels being described the bht MobSlot containing the SourceReference, e.g. 1 element for a mono audio slot, 6 elements for a 5.1 multi-channel audio slot.

Return codes:

AAFRESULT_SUCCESS

succeeded

AAFRESULT_NULL_PARAM

pChannelIDs is null

Parameters:

numberElements	[in] Number of elements in the pChannelIDs array
pChannelIDs	[in] Array of channel IDs

HRESULT IAAFSourceReference2::SetMonoSourceSlotIDs	(	[in] aafUInt32	numberElements,
		[in] aafUInt32 *	pMonoSourceSlotIDs
	)

For reference from a multi-channel MobSlot to multiple mono MobSlots.

pMonoSourceSlotIDs identifies the mono slots referenced by this SourceReference object.

Return codes:

AAFRESULT_SUCCESS

succeeded

AAFRESULT_NULL_PARAM

pMonoSourceSlotIDs is null

Parameters:

numberElements	[in] Number of elements in the pMonoSourceSlotIDs array
pMonoSourceSlotIDs	[in] Array of slot IDs

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

Public Member Functions

Detailed Description

Member Function Documentation