In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values: More...

Public Member Functions
HRESULT	GetEssenceElementKey ([in] IAAFPropertyValue pStreamPropertyValue,[out] aafUID_t pEssenceElementKey)
	This method returns essence element key associated with the specified stream.
HRESULT	SetEssenceElementKey ([in] IAAFPropertyValue *pStreamPropertyValue,[in, ref] aafUID_constref key)
	Set the essence element key on the specified stream.

Detailed Description

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.

Definition at line 46797 of file AAF.idl.

Member Function Documentation

HRESULT IAAFKLVStreamParameters::GetEssenceElementKey	(	[in] IAAFPropertyValue *	pStreamPropertyValue,
		[out] aafUID_t *	pEssenceElementKey
	)

This method returns essence element key associated with the specified stream.

Succeeds if all of the following are true:

pStreamPropertyValue is a valid pointer.
pEssenceElementKey is a valid pointer.
the specified stream supports essence element keys.

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

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_NOT_INITIALIZED

This object has not yet had Initialize() called on it.

AAFRESULT_NULL_PARAM

either pStreamPropertyValue or pEssenceElementKey arg is NULL.

AAFRESULT_INVALID_PARAM

the specified stream does not support essence element keys.

Parameters:

pStreamPropertyValue	[in] stream property value
pEssenceElementKey	[out] Essence element key.

HRESULT IAAFKLVStreamParameters::SetEssenceElementKey	(	[in] IAAFPropertyValue *	pStreamPropertyValue,
		[in, ref] aafUID_constref	key
	)

Set the essence element key on the specified stream.