Main Page | Class List | File List | Class Members | File Members

IAAFContentStorage Interface Reference

Detailed Description

Objects that implement IAAFContentStorage also implement the following interfaces: - IAAFObject.

Definition at line 2023 of file AAF.idl.

Public Member Functions

HRESULT LookupMob ([in, ref] aafMobID_constref mobID,[out, retval] IAAFMob **ppMob)

Looks up the Mob that matches the given mob id and puts it into the ppMob argument.

HRESULT CountMobs ([in] aafMobKind_t mobKind,[out, retval] aafNumSlots_t *pResult)

Writes the number of matches for the given mob kind into the pNumMobs argument.

HRESULT GetMobs ([in] aafSearchCrit_t *pSearchCriteria,[out, retval] IEnumAAFMobs **ppEnum)

Places an enumerator for mobs that apply to the criteria into the ppEnum argument.

HRESULT AddMob ([in] IAAFMob *pMob)

Appends the given mob to the header.

HRESULT RemoveMob ([in] IAAFMob *pMob)

/// Removes the given mob from the header.

HRESULT CountEssenceData ([out, retval] aafUInt32 *pResult)

Writes the total number of essence data into the *pNumEssenceData argument.

HRESULT IsEssenceDataPresent ([in, ref] aafMobID_constref fileMobID,[in] aafFileFormat_t fmt,[out, retval] aafBoolean_t *pResult)

/// Succeeds if all of the following are true: - the pResult pointer is valid.

HRESULT EnumEssenceData ([out, retval] IEnumAAFEssenceData **ppEnum)

Places an enumerator for essence that applies to the criteria into the *ppEnum argument.

HRESULT AddEssenceData ([in] IAAFEssenceData *pEssenceData)

Appends the given essence data object to the header.

HRESULT RemoveEssenceData ([in] IAAFEssenceData *pEssenceData)

/// Removes the given EssenceData from the header.

HRESULT LookupEssenceData ([in, ref] aafMobID_constref mobID,[out, retval] IAAFEssenceData **ppEssenceData)

Looks up the EssenceData that matches the given mob id and puts it into the ppEssenceData argument.

Member Function Documentation

HRESULT IAAFContentStorage::AddEssenceData ( [in] IAAFEssenceData * pEssenceData )

Appends the given essence data object to the header.
Succeeds if all of the following are true:

the pEssenceData 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_DUPLICATE_MOBID

The given mob has already been added. The validation is done by comparing mobIDs, which should be unique.

AAFRESULT_NULL_PARAM

pEssenceData is null.

Parameters:

pEssenceData [in] Essence data object to append

HRESULT IAAFContentStorage::AddMob ( [in] IAAFMob * pMob )

Appends the given mob to the header.
If the given mob is already contained this method will do nothing and will return success.
Succeeds if all of the following are true:

the pMob pointer is valid.
the given mob is not already part of this collection.

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

pMob is null.

AAFRESULT_DUPLICATE_MOBID

the given mob is already contained.

Parameters:

pMob [in] Mob to add

HRESULT IAAFContentStorage::CountEssenceData ( [out, retval] aafUInt32 * pResult )

Writes the total number of essence data into the *pNumEssenceData argument.
Succeeds if all of the following are true:

the pNumEssenceData pointer is valid.

If this method fails nothing will be written to pNumEssenceData.
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

pNumEssenceData is null.

Parameters:

pResult [out, retval] Total number of essence data

HRESULT IAAFContentStorage::CountMobs ( [in] aafMobKind_t mobKind,

[out, retval] aafNumSlots_t * pResult

)

Writes the number of matches for the given mob kind into the pNumMobs argument.
Succeeds if all of the following are true:

the pNumMobs pointer is valid.

If this method fails nothing will be written to *pNumMobs.
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

pNumMobs is null.

Parameters:

mobKind [in] The mob kind to count

pResult [out, retval] Total number of mobs of kind mobKind

HRESULT IAAFContentStorage::EnumEssenceData ( [out, retval] IEnumAAFEssenceData ** ppEnum )

Places an enumerator for essence that applies to the criteria into the *ppEnum argument.
The returned enumerator is AddRef()ed before it is returned.
Succeeds if all of the following are true:

the pMediaCriteria pointer is valid.
the ppEnum pointer is valid.

If this method fails nothing will be written to *ppEnum.
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

either pMediaCriteria or ppEnum is null.

Parameters:

ppEnum [out,retval] Essence Enumeration

HRESULT IAAFContentStorage::GetMobs ( [in] aafSearchCrit_t * pSearchCriteria,

[out, retval] IEnumAAFMobs ** ppEnum

)

Places an enumerator for mobs that apply to the criteria into the ppEnum argument.
If pSearchCriteria is null, all mobs are returned. The searchTag field of pSearchCriteria, and exactly ONE of the fields in the union (tags.mobID, tags.name, etc. ) must be set. Only one search criterion may be specified. The returned enumerator is AddRef()ed before it is returned.
Succeeds if all of the following are true:

the ppEnum pointer is valid.

If this method fails nothing will be written to *ppEnum.
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

ppEnum is null.

Parameters:

pSearchCriteria [in] Search Criteria for enumeration

ppEnum [out, retval] Mob Enumeration

HRESULT IAAFContentStorage::IsEssenceDataPresent ( [in, ref] aafMobID_constref fileMobID,

[in] aafFileFormat_t fmt,

[out, retval] aafBoolean_t * pResult

)

/// Succeeds if all of the following are true: - the pResult 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

pResult is null.

Parameters:

fileMobID [in, ref] A Unique File Mob ID

fmt [in] The Essence File Format

pResult [out,retval] True if the essence is found

HRESULT IAAFContentStorage::LookupEssenceData ( [in, ref] aafMobID_constref mobID,

[out, retval] IAAFEssenceData ** ppEssenceData

)

Looks up the EssenceData that matches the given mob id and puts it into the ppEssenceData argument.
The returned EssenceData interface is AddRef()ed before it is returned.
Succeeds if all of the following are true:

the ppEssenceData pointer is valid.

If this method fails nothing will be written to *ppEssenceData.
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

ppEssenceData is null

AAFRESULT_MOB_NOT_FOUND

the requested EssenceData wasn't found.

Parameters:

mobID [in, ref] The Mob ID

ppEssenceData [out,retval] Matching EssenceData

HRESULT IAAFContentStorage::LookupMob ( [in, ref] aafMobID_constref mobID,

[out, retval] IAAFMob ** ppMob

)

Looks up the Mob that matches the given mob id and puts it into the ppMob argument.
The returned mob interface is AddRef()ed before it is returned.
Succeeds if all of the following are true:

the ppMob pointer is valid.

If this method fails nothing will be written to *ppMob.
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

ppMob is null

AAFRESULT_MOB_NOT_FOUND

the requested mob wasn't found.

Parameters:

mobID [in, ref] The Mob ID

ppMob [out,retval] Matching Mob

HRESULT IAAFContentStorage::RemoveEssenceData ( [in] IAAFEssenceData * pEssenceData )

/// Removes the given EssenceData from the header.
Succeeds if all of the following are true:

the pEssenceData pointer is valid.
the given EssenceData is currently in the collection.

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

pEssenceData is null.

AAFRESULT_ESSENCE_NOT_FOUND

the given EssenceData is not already contained.

Parameters:

pEssenceData [in] EssenceData to remove

HRESULT IAAFContentStorage::RemoveMob ( [in] IAAFMob * pMob )

/// Removes the given mob from the header.
Succeeds if all of the following are true:

the pMob pointer is valid.
the given mob is currently in the collection.

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

pMob is null.

AAFRESULT_MOB_NOT_FOUND

the given mob is not already contained.

Parameters:

pMob [in] Mob to remove

Generated on Thu Feb 17 09:34:14 2005 for AAF COM API by

1.4.1


Public Member Functions
HRESULT	LookupMob ([in, ref] aafMobID_constref mobID,[out, retval] IAAFMob **ppMob)
	Looks up the Mob that matches the given mob id and puts it into the ppMob argument.
HRESULT	CountMobs ([in] aafMobKind_t mobKind,[out, retval] aafNumSlots_t *pResult)
	Writes the number of matches for the given mob kind into the pNumMobs argument.
HRESULT	GetMobs ([in] aafSearchCrit_t pSearchCriteria,[out, retval] IEnumAAFMobs *ppEnum)
	Places an enumerator for mobs that apply to the criteria into the ppEnum argument.
HRESULT	AddMob ([in] IAAFMob *pMob)
	Appends the given mob to the header.
HRESULT	RemoveMob ([in] IAAFMob *pMob)
	/// Removes the given mob from the header.
HRESULT	CountEssenceData ([out, retval] aafUInt32 *pResult)
	Writes the total number of essence data into the *pNumEssenceData argument.
HRESULT	IsEssenceDataPresent ([in, ref] aafMobID_constref fileMobID,[in] aafFileFormat_t fmt,[out, retval] aafBoolean_t *pResult)
	/// Succeeds if all of the following are true: - the pResult pointer is valid.
HRESULT	EnumEssenceData ([out, retval] IEnumAAFEssenceData **ppEnum)
	Places an enumerator for essence that applies to the criteria into the *ppEnum argument.
HRESULT	AddEssenceData ([in] IAAFEssenceData *pEssenceData)
	Appends the given essence data object to the header.
HRESULT	RemoveEssenceData ([in] IAAFEssenceData *pEssenceData)
	/// Removes the given EssenceData from the header.
HRESULT	LookupEssenceData ([in, ref] aafMobID_constref mobID,[out, retval] IAAFEssenceData **ppEssenceData)
	Looks up the EssenceData that matches the given mob id and puts it into the ppEssenceData argument.