IAAFEssenceGroup Interface Reference

List of all members.

---

Detailed Description

This interface provides access to the IAAFEssenceGroup interface, which contains multiple representations of the same media within a MasterMob.

The IAAFEssenceAccess methods allow specifying parameters such as "best quality", or "lowest frame rate" for and follow the correct path through the EssenceGroup in order to find the media which matches the criteria.

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

• IAAFSegment
• IAAFComponent
• IAAFComponent2
• IAAFObject

Definition at line 9833 of file AAF.idl.

Public Member Functions
HRESULT	SetStillFrame ([in] IAAFSourceClip *pStillFrame)
	This method sets the still frame property on a essence group to be the source clip passed as the stillFrame argument.
HRESULT	GetStillFrame ([out] IAAFSourceClip **ppStillFrame)
	Gets the still frame property on a essence group.
HRESULT	AppendChoice ([in] IAAFSegment *pChoice)
	Append another choice to this AAFEssenceGroup.
HRESULT	PrependChoice ([in] IAAFSegment *pChoice)
	Prepend another choice to this AAFEssenceGroup.
HRESULT	InsertChoiceAt ([in] aafUInt32 index,[in] IAAFSegment *pChoice)
	Insert another choice to this AAFEssenceGroup at the given index.
HRESULT	CountChoices ([out] aafUInt32 *pCount)
	Returns the number of choices attached to this AAFEssenceGroup., excepting the still frame.
HRESULT	GetChoiceAt ([in] aafUInt32 index,[out] IAAFSegment **ppChoice)
	Given an index, returns the corresponding source clip choice.
HRESULT	RemoveChoiceAt ([in] aafUInt32 index)
	Removes the choice at the given index.

---

Member Function Documentation

HRESULT IAAFEssenceGroup::AppendChoice (  [in] IAAFSegment *  pChoice  )

Append another choice to this AAFEssenceGroup. Succeeds if all of the following are true: the pChoice pointer is valid. 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_NULL_PARAM pChoice is null. Parameters: pChoice  [in] Source clip to add as a choice

HRESULT IAAFEssenceGroup::CountChoices (  [out] aafUInt32 *  pCount  )

Returns the number of choices attached to this AAFEssenceGroup., excepting the still frame. Succeeds if all of the following are true: the pCount pointer is valid. If this method fails nothing is 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 is null. Parameters: pCount  [out] The number of representations contained within.

HRESULT IAAFEssenceGroup::GetChoiceAt (  [in] aafUInt32  index, [out] IAAFSegment **  ppChoice )

Given an index, returns the corresponding source clip choice. Succeeds if all of the following are true: the ppChoice pointer is valid. If this method fails nothing will be written to *ppChoice. 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_MISSING_INDEX The given index value is not present. AAFRESULT_NULL_PARAM ppChoice arg is NULL. Parameters: index  [in] The 0-based index into the array ppChoice  [out] The representation at that index

HRESULT IAAFEssenceGroup::GetStillFrame (  [out] IAAFSourceClip **  ppStillFrame  )

Gets the still frame property on a essence group. 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 ppStillFrame is null. AAFRESULT_NOT_INITIALIZED This object has not yet had Initialize() called on it. Parameters: ppStillFrame  [out] Still Frame source clip

HRESULT IAAFEssenceGroup::InsertChoiceAt (  [in] aafUInt32  index, [in] IAAFSegment *  pChoice )

Insert another choice to this AAFEssenceGroup at the given index. Choices already existing at the given and higher indices will be moved up by one index to accommodate. Succeeds if all of the following are true: the pChoice pointer is valid. index is less than or equal to the value returned by CountChoices(). 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_NULL_PARAM pChoice is null. AAFRESULT_BADINDEX index is greater than the value returned by CountChoices(). Parameters: index  [in] place to insert new choice pChoice  [in] Source clip to add as a choice

HRESULT IAAFEssenceGroup::PrependChoice (  [in] IAAFSegment *  pChoice  )

Prepend another choice to this AAFEssenceGroup. Succeeds if all of the following are true: the pChoice pointer is valid. 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_NULL_PARAM pChoice is null. Parameters: pChoice  [in] Source clip to add as a choice

HRESULT IAAFEssenceGroup::RemoveChoiceAt (  [in] aafUInt32  index  )

Removes the choice at the given index. Items already existing at higher indices will be moved down by one index to accommodate. Succeeds if all of the following are true: the ppChoice pointer is valid. index is less than the value returned by CountChoices(). 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_NULL_PARAM ppChoice arg is NULL. AAFRESULT_BADINDEX index is greater than or equal to the value returned by CountChoices(). Parameters: index  [in] The 0-based index into the array

HRESULT IAAFEssenceGroup::SetStillFrame (  [in] IAAFSourceClip *  pStillFrame  )

This method sets the still frame property on a essence group to be the source clip passed as the stillFrame argument. 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 pStillFrame is null. AAFRESULT_NOT_INITIALIZED This object has not yet had Initialize() called on it. Parameters: pStillFrame  [in] Still Frame source clip

---