The IAAFMobSlot interface is implemented by objects which represent a Segment of essence in a Mob. More...

Public Member Functions
HRESULT	GetSegment ([out, retval] IAAFSegment **ppResult)
	This method will get the segment for this mob slot and place an interface for it into the **ppResult argument.
HRESULT	SetName ([in, string] aafCharacter_constptr pName)
	Sets the Mob Slot Name string property.
HRESULT	GetName ([out, string, size_is(bufSize)] aafCharacter *pName,[in] aafUInt32 bufSize)
	Gets the Mob Slot Name string property.
HRESULT	GetNameBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetName().
HRESULT	GetPhysicalNum ([out, retval] aafUInt32 *pResult)
	Returns information about the physical output channel associated with the Slot.
HRESULT	GetDataDef ([out, retval] IAAFDataDef **ppResult)
	This method will return the Data Definition object associated with the segment in this Mob Slot.
HRESULT	GetSlotID ([out, retval] aafSlotID_t *pResult)
	This method will return the slot id of this mob slot.
HRESULT	SetSegment ([in] IAAFSegment *pSegment)
	This method will set the segment for this mob slot.
HRESULT	SetPhysicalNum ([in] aafUInt32 number)
	This function sets the physical slot number of the specified slot.
HRESULT	SetSlotID ([in] aafSlotID_t value)
	This method will set the slot id of this mob slot.

Detailed Description

The IAAFMobSlot interface is implemented by objects which represent a Segment of essence in a Mob.

IAAFMobSlot-implementing objects contan a Segment, which can be a timeline, static, or event Segment.

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.

Types required by this module:

aafBool aafRational_t AAFSegment aafPosition_t aafSlotID_t aafUInt32 AAFDataDef

Objects that implement IAAFMobSlot also implement the following interfaces:

IAAFObject

Definition at line 14979 of file AAF.idl.

Member Function Documentation

HRESULT IAAFMobSlot::GetDataDef ( [out, retval] IAAFDataDef ** ppResult )

This method will return the Data Definition object associated with the segment in this Mob Slot.

Common DataDefinitions are kAAFDataDef_Picture, kAAFDataDef_Sound, kAAFDataDef_Timecode, and kAAFDataDef_Edgecode.

Succeeds if all of the following are true:

the ppResult pointer is valid.

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

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

ppResult arg is NULL.

Parameters:

ppResult [out,retval] Data Definition AUID

HRESULT IAAFMobSlot::GetName	(	[out, string, size_is(bufSize)] aafCharacter *	pName,
		[in] aafUInt32	bufSize
	)

Gets the Mob Slot Name string property.

Writes the Name property, with a trailing null character, into the pName buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the Name property has not yet been set, a zero-length string will be written (that is, only the trailing null character).

Caller may call GetNameBufLen() to determine the required buffer size.

If this method fails nothing will be written to pName.

Succeeds if:

The pName pointer is valid.
bufSize indicates that the buffer is large enough to hold Name.

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

pName arg is NULL.

AAFRESULT_SMALL_BUF

bufSize indicates that the allocated buffer is not large enough to hold Name.

Parameters:

pName	[out, string, size_is(bufSize)] buffer into which Name is to be written
bufSize	[in] size of *pName buffer in bytes

HRESULT IAAFMobSlot::GetNameBufLen ( [out] aafUInt32 * pBufSize )

Returns size of buffer (in bytes) required for GetName().

Succeeds if:

The pBufSize 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_NULL_PARAM

pBufSize arg is NULL.

Parameters:

pBufSize [out] size of required buffer, in bytes

HRESULT IAAFMobSlot::GetPhysicalNum ( [out, retval] aafUInt32 * pResult )

Returns information about the physical output channel associated with the Slot.

This function returns the physical slot number of the specified slot. The physical slot number identifies the physical slot associated with the media. For File Source Mobs that describe stereo audio media, the left channel should have a PhysicalSlot of 1 and the right channel should have a Physical-Slot of 2.

The function returns an error if the object specified in the slot parameter is not a slot.

Succeeds if all of the following are true:

the pDatadef pointer is valid.
the object in the slot parameter is a slot.

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

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

pDatadef arg is NULL.

AAFRESULT_SLOT_NOT_FOUND

object specified is not a slot.

Parameters:

pResult [out,retval] The physical slot number property value

HRESULT IAAFMobSlot::GetSegment ( [out, retval] IAAFSegment ** ppResult )

This method will get the segment for this mob slot and place an interface for it into the **ppResult argument.

If a segment exists, the result will be AddRef()ed. If not, the result will be NULL.

Succeeds if all of the following are true:

the pResult pointer is valid.

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

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

pResult arg is NULL.

Parameters:

ppResult [out,retval] Segment property value

HRESULT IAAFMobSlot::GetSlotID ( [out, retval] aafSlotID_t * pResult )

This method will return the slot id of this mob slot.

Succeeds if all of the following are true:

the pResult pointer is valid.

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

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

pResult arg is NULL.

Parameters:

pResult [out,retval] Slot id of the Mob Slot

HRESULT IAAFMobSlot::SetName ( [in, string] aafCharacter_constptr pName )

Sets the Mob Slot Name string property.

Set the Name property to the value specified in pName. A copy is made of the data so the caller retains ownership of the *pName buffer and is responsible for de-allocating it. There is no pre-set limit to the length of the name, other than available system memory or disk space.

Succeeds if all of the following are true:

the pName pointer is valid.

If this method fails the Name property will not 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.)

AAFRESULT_NULL_PARAM

pName arg is NULL.

Parameters:

pName [in, string] buffer from which Name is to be read

HRESULT IAAFMobSlot::SetPhysicalNum ( [in] aafUInt32 number )

This function sets the physical slot number of the specified slot.

The physical slot number identifies the physical slot associated with the media. For File Source Mobs that describe stereo audio media, the left channel should have a PhysicalSlot of 1 and the right channel should have a Physical-Slot of 2.

The function returns an error if the Mob Slot passed in is not a slot.

Succeeds if all of the following are true:

the Mob Slot passed in is a slot.

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.

AAFRESULT_SLOT_NOT_FOUND

object specified is not a slot.

Parameters:

number [in] The physical slot number property value

HRESULT IAAFMobSlot::SetSegment ( [in] IAAFSegment * pSegment )

This method will set the segment for this mob slot.

If a segment already exists for this mob slot, it will be discarded.

Always succeeds.

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.)

Parameters:

pSegment [in] Segment property value

HRESULT IAAFMobSlot::SetSlotID ( [in] aafSlotID_t value )

This method will set the slot id of this mob slot.

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:

value [in] Slot id of the Mob Slot

Public Member Functions

Detailed Description

Member Function Documentation