IAAFDescriptiveMarker Interface Reference

The IAAFDescriptiveMarker interface is implemented by objects which represent a descriptive metadata associated with a point in time. More...

List of all members.

Public Member Functions
HRESULT	Initialize ()
	Initializes a newly allocated, IAAFDescriptiveFrame object.
HRESULT	SetDescribedSlotIDs ([in] aafUInt32 numberElements,[in] aafUInt32 *pDescribedSlotIDs)
	Specifies the slot IDs in the Mob to which the DescriptiveFramework refers.
HRESULT	GetDescribedSlotIDs ([in] aafUInt32 numberElements,[in] aafUInt32 *pDescribedSlotIDs)
	Get the described slot IDs that are referenced by this object.
HRESULT	GetDescribedSlotIDsSize ([out] aafUInt32 *numberElements)
	Get the number of slot IDs stored by this DescriptiveMarker.
HRESULT	SetDescriptiveFramework ([in] IAAFDescriptiveFramework *pDescriptiveFramework)
	Sets the DescriptiveFramework that describes this DescriptiveMarker.
HRESULT	GetDescriptiveFramework ([out, retval] IAAFDescriptiveFramework **ppDescriptiveFramework)
	Gets the DescriptiveFramework that describes this DescriptiveMarker.

---

Detailed Description

The IAAFDescriptiveMarker interface is implemented by objects which represent a descriptive metadata associated with a point in time.

A DescriptiveMarker may contain a DescriptiveFramework object that specifies the metadata.

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

• IAAFCommentMarker
• IAAFEvent
• IAAFSegment
• IAAFComponent
• IAAFComponent2
• IAAFObject

Definition at line 5895 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFDescriptiveMarker::GetDescribedSlotIDs	(	[in] aafUInt32	numberElements,
		[in] aafUInt32 *	pDescribedSlotIDs
	)

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

Refer to SetDescribedSlotIDs for a description of pDescribedSlotIDs.

Return codes:

AAFRESULT_SUCCESS

• succeeded

AAFRESULT_NULL_PARAM

• pDescribedSlotIDs is null

AAFRESULT_PROP_NOT_PRESENT

• the property is not present

AAFRESULT_SMALLBUF

• pDescribedSlotIDs is too small

This interface is not currently implemented.

Parameters:

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

HRESULT IAAFDescriptiveMarker::GetDescribedSlotIDsSize

(

[out] aafUInt32 *

numberElements

)

Get the number of slot IDs stored by this DescriptiveMarker.

Return codes:

AAFRESULT_SUCCESS

• succeeded

AAFRESULT_NULL_PARAM

• pDescribedSlotIDs is null

Parameters:

numberElements

[out] Number of elements in the pDescribedSlotIDs array

HRESULT IAAFDescriptiveMarker::GetDescriptiveFramework

(

[out, retval] IAAFDescriptiveFramework **

ppDescriptiveFramework

)

Gets the DescriptiveFramework that describes this DescriptiveMarker.

Return codes:

AAFRESULT_SUCCESS

• succeeded

AAFRESULT_NULL_PARAM

• ppDescriptorFramework is null

Parameters:

ppDescriptiveFramework

[out,retval] DescriptorFramework object to return

HRESULT IAAFDescriptiveMarker::Initialize

(

)

Initializes a newly allocated, IAAFDescriptiveFrame object.

This method must be called after allocation, and before any other method can be called.

Return codes:

AAFRESULT_SUCCESS

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

AAFRESULT_ALREADY_INITIALIZED

• Initialize() has already been called on this object.

HRESULT IAAFDescriptiveMarker::SetDescribedSlotIDs	(	[in] aafUInt32	numberElements,
		[in] aafUInt32 *	pDescribedSlotIDs
	)

Specifies the slot IDs in the Mob to which the DescriptiveFramework refers.

Return codes:

AAFRESULT_SUCCESS

• succeeded

AAFRESULT_NULL_PARAM

• pMonoSourceSlotIDs is null

This interface is not currently implemented.

Parameters:

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

HRESULT IAAFDescriptiveMarker::SetDescriptiveFramework

(

[in] IAAFDescriptiveFramework *

pDescriptiveFramework

)

Sets the DescriptiveFramework that describes this DescriptiveMarker.

Return codes:

AAFRESULT_SUCCESS

• succeeded

AAFRESULT_NULL_PARAM

• pDescriptorFramework is null

Parameters:

pDescriptiveFramework

[in] DescriptorFramework object to set