The IAAFAES3PCMDescriptor2 interface is implemented by objects which describe video essence formatted with one luminance component and two color-difference components. More...

Public Member Functions
HRESULT	Initialize ()
	Initializes a newly allocated, IAAFAES3PCMDescriptor-supporting object.
HRESULT	GetEmphasis ([out] aafEmphasisType_t *pEmphasisType)
	Gets the Emphasis type property.
HRESULT	SetEmphasis ([in] aafEmphasisType_t EmphasisType)
	Gets the Emphasis type property.
HRESULT	GetBlockStartOffset ([out] aafUInt16 *pBlockStartOffset)
	Gets the BlockStartOffset.
HRESULT	SetBlockStartOffset ([in] aafUInt16 BlockStartOffset)
	Sets the BlockStartOffset.
HRESULT	GetAuxBitsMode ([out] aafAuxBitsModeType_t *pAuxBitsMode)
	Gets the AuxBitsMode.
HRESULT	SetAuxBitsMode ([in] aafAuxBitsModeType_t AuxBitsMode)
	Sets the AuxBitsMode.
HRESULT	GetChannelStatusModeAt ([in] aafUInt32 index,[out] aafChannelStatusModeType_t *pChannelStatusMode)
	Gets the ChannelStatusMode for the channel referenced by the index.
HRESULT	SetChannelStatusModeAt ([in] aafUInt32 index,[in] aafChannelStatusModeType_t ChannelStatusMode)
	Sets the ChannelStatusMode for the channel referenced by the index.
HRESULT	GetFixedChannelStatusDataAt ([in] aafUInt32 index,[in] aafUInt32 sizeOfBuffer,[out] aafUInt8 *pFixedChannelStatusData)
	Gets the FixedChannelStatusData for the channel referenced by the index.
HRESULT	SetFixedChannelStatusDataAt ([in] aafUInt32 index,[in] aafUInt32 sizeOfBuffer,[in] aafUInt8 *pFixedChannelStatusData)
	Sets the FixedChannelStatusData for the channel referenced by the index.
HRESULT	GetUserDataModeAt ([in] aafUInt32 index,[out] aafUserDataModeType_t *pUserDataMode)
	Gets the UserDataMode for the channel referenced by the index.
HRESULT	SetUserDataModeAt ([in] aafUInt32 index,[in] aafUserDataModeType_t UserDataMode)
	Sets the UserDataMode for the channel referenced by the index.
HRESULT	GetFixedUserDataAt ([in] aafUInt32 index,[in] aafUInt32 sizeOfBuffer,[out] aafUInt8 *pFixedUserData)
	Gets the FixedUserData for the channel referenced by the index.
HRESULT	SetFixedUserDataAt ([in] aafUInt32 index,[in] aafUInt32 sizeOfBuffer,[in] aafUInt8 *pFixedUserData)
	Sets the FixedUserData for the channel referenced by the index.

Detailed Description

The IAAFAES3PCMDescriptor2 interface is implemented by objects which describe video essence formatted with one luminance component and two color-difference components.

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

IAAFPCMDescriptor

Definition at line 39511 of file AAF.idl.

Member Function Documentation

HRESULT IAAFAES3PCMDescriptor2::GetAuxBitsMode ( [out] aafAuxBitsModeType_t * pAuxBitsMode )

Gets the AuxBitsMode.

Succeeds if all of the following are true:

pAuxBitsMode is a valid pointer.

If this method fails, *pAuxBitsMode will not be changed.

This method will return the following codes:

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

pAuxBitsMode arg is NULL.

Parameters:

pAuxBitsMode [out] Address to store the AuxBitsMode.

HRESULT IAAFAES3PCMDescriptor2::GetBlockStartOffset ( [out] aafUInt16 * pBlockStartOffset )

Gets the BlockStartOffset.

Succeeds if all of the following are true:

pBlockStartOffset is a valid pointer.

If this method fails, *pBlockStartOffset will not be changed.

This method will return the following codes:

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

pBlockStartOffset arg is NULL.

Parameters:

pBlockStartOffset [out] Address to store the BlockStartOffset.

HRESULT IAAFAES3PCMDescriptor2::GetChannelStatusModeAt	(	[in] aafUInt32	index,
		[out] aafChannelStatusModeType_t *	pChannelStatusMode
	)

Gets the ChannelStatusMode for the channel referenced by the index.

Succeeds if all of the following are true:

pChannelStatusMode is a valid pointer
index is a valid index with the array of channels

this method will return the following codes

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

pChannelStatusMode arg is NULL

AAFRESULT_BADINDEX

index is not a valid index
Parameters:

index [in] Index of the channel desired.

pChannelStatusMode [out] Address to store ChannelStatusMode for the index given.

HRESULT IAAFAES3PCMDescriptor2::GetEmphasis ( [out] aafEmphasisType_t * pEmphasisType )

Gets the Emphasis type property.

Succeeds if all of the following are true:

pEmphasisType is a valid pointer.

If this method fails, *pEmphasisType will not be changed.

This method will return the following codes:

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

pEmphasisType arg is NULL.

Parameters:

pEmphasisType [out] Address to store the emphasis type.

HRESULT IAAFAES3PCMDescriptor2::GetFixedChannelStatusDataAt	(	[in] aafUInt32	index,
		[in] aafUInt32	sizeOfBuffer,
		[out] aafUInt8 *	pFixedChannelStatusData
	)

Gets the FixedChannelStatusData for the channel referenced by the index.

each channel's status is a 24 byte array that gets copied into the the address pointed to by pFixedChannelStatusData. Succeeds if all of the following are true:

pFixedChannelStatusData is a valid pointer
index is a valid index with the array of channels
sizeOfBuffer must be 24

this method will return the following codes

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

pFixedChannelStatusData arg is NULL

AAFRESULT_BADINDEX

index is not a valid index

AAFRESULT_WRONG_SIZE

buffer size is not correct

Parameters:

index	[in] Index of the channel desired.
sizeOfBuffer	[in] Size of pFixedChannelStatusData buffer in bytes.
pFixedChannelStatusData	[out] Address to store FixedChannelStatusData for the index given.

HRESULT IAAFAES3PCMDescriptor2::GetFixedUserDataAt	(	[in] aafUInt32	index,
		[in] aafUInt32	sizeOfBuffer,
		[out] aafUInt8 *	pFixedUserData
	)

Gets the FixedUserData for the channel referenced by the index.

each channel's status is a 24 byte array that gets copied into the the address pointed to by pFixedUserData. Succeeds if all of the following are true:

pFixedUserData is a valid pointer
index is a valid index with the array of channels
sizeOfBuffer must be 24

this method will return the following codes

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

pFixedUserData arg is NULL

AAFRESULT_BADINDEX

index is not a valid index

AAFRESULT_WRONG_SIZE

buffer size is not correct
Parameters:

index [in] Index of the channel desired.

sizeOfBuffer [in] Size of pFixedUserData buffer in bytes.

pFixedUserData [out] Address to store FixedUserData for the index given.

HRESULT IAAFAES3PCMDescriptor2::GetUserDataModeAt	(	[in] aafUInt32	index,
		[out] aafUserDataModeType_t *	pUserDataMode
	)

Gets the UserDataMode for the channel referenced by the index.

Succeeds if all of the following are true:

pUserDataMode is a valid pointer
index is a valid index with the array of channels

this method will return the following codes

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

pUserDataMode arg is NULL

AAFRESULT_BADINDEX

index is not a valid index
Parameters:

index [in] Index of the channel desired.

pUserDataMode [out] Address to store UserDataMode for the index given.

HRESULT IAAFAES3PCMDescriptor2::Initialize ( )

Initializes a newly allocated, IAAFAES3PCMDescriptor-supporting object.

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

Succeeds if:

Initialize() has not yet been called on this object.

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_ALREADY_INITIALIZED

Initialize() has already been called on this object.

HRESULT IAAFAES3PCMDescriptor2::SetAuxBitsMode ( [in] aafAuxBitsModeType_t AuxBitsMode )

Sets the AuxBitsMode.

Succeeds if all of the following are true:

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NOT_INITIALIZED

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

Parameters:

AuxBitsMode [in] Sets the AuxBitsMode.

HRESULT IAAFAES3PCMDescriptor2::SetBlockStartOffset ( [in] aafUInt16 BlockStartOffset )

Sets the BlockStartOffset.

Succeeds if all of the following are true:

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NOT_INITIALIZED

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

Parameters:

BlockStartOffset [in] Sets the BlockStartOffset.

HRESULT IAAFAES3PCMDescriptor2::SetChannelStatusModeAt	(	[in] aafUInt32	index,
		[in] aafChannelStatusModeType_t	ChannelStatusMode
	)

Sets the ChannelStatusMode for the channel referenced by the index.

Succeeds if all of the following are true:

index is a valid index with the array of channels

this method will return the following codes

AAFRESULT_SUCCESS

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

AAFRESULT_NOT_INITIALIZED

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

AAFRESULT_BADINDEX

index is not a valid index
Parameters:

index [in] Index of the channel desired.

ChannelStatusMode [in] Set ChannelStatusMode for the index given.

HRESULT IAAFAES3PCMDescriptor2::SetEmphasis ( [in] aafEmphasisType_t EmphasisType )

Gets the Emphasis type property.

Succeeds if all of the following are true:

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NOT_INITIALIZED

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

Parameters:

EmphasisType [in] Sets the Emphasis type property.

HRESULT IAAFAES3PCMDescriptor2::SetFixedChannelStatusDataAt	(	[in] aafUInt32	index,
		[in] aafUInt32	sizeOfBuffer,
		[in] aafUInt8 *	pFixedChannelStatusData
	)

Sets the FixedChannelStatusData for the channel referenced by the index.

each channel's status is a 24 byte array that gets copied from the the address pointed to by pFixedChannelStatusData . Succeeds if all of the following are true:

pFixedChannelStatusData is a valid pointer
index is a valid index with the array of channels
sizeOfBuffer must be 24

this method will return the following codes

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

pFixedChannelStatusData arg is NULL

AAFRESULT_BADINDEX

index is not a valid index

AAFRESULT_WRONG_SIZE

buffer size is not correct
Parameters:

index [in] Index of the channel desired.

sizeOfBuffer [in] Size of pFixedChannelStatusData buffer in bytes.

pFixedChannelStatusData [in] Set FixedChannelStatusData for the index given.

HRESULT IAAFAES3PCMDescriptor2::SetFixedUserDataAt	(	[in] aafUInt32	index,
		[in] aafUInt32	sizeOfBuffer,
		[in] aafUInt8 *	pFixedUserData
	)

Sets the FixedUserData for the channel referenced by the index.

each channel's status is a 24 byte array that gets copied from the the address pointed to by pFixedUserData . Succeeds if all of the following are true:

pFixedUserData is a valid pointer
index is a valid index with the array of channels
sizeOfBuffer must be 24

this method will return the following codes

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

pFixedUserData arg is NULL

AAFRESULT_BADINDEX

index is not a valid index

AAFRESULT_WRONG_SIZE

buffer size is not correct
Parameters:

index [in] Index of the channel desired.

sizeOfBuffer [in] Size of pFixedUserData buffer in bytes.

pFixedUserData [in] Set FixedUserData for the index given.

HRESULT IAAFAES3PCMDescriptor2::SetUserDataModeAt	(	[in] aafUInt32	index,
		[in] aafUserDataModeType_t	UserDataMode
	)

Sets the UserDataMode for the channel referenced by the index.

Succeeds if all of the following are true:

index is a valid index with the array of channels

this method will return the following codes

AAFRESULT_SUCCESS

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

AAFRESULT_NOT_INITIALIZED

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

AAFRESULT_BADINDEX

index is not a valid index
Parameters:

index [in] Index of the channel desired.

UserDataMode [in] Set UserDataMode for the index given.

index	[in] Index of the channel desired.
pChannelStatusMode	[out] Address to store ChannelStatusMode for the index given.

index	[in] Index of the channel desired.
pUserDataMode	[out] Address to store UserDataMode for the index given.

index	[in] Index of the channel desired.
ChannelStatusMode	[in] Set ChannelStatusMode for the index given.

index	[in] Index of the channel desired.
UserDataMode	[in] Set UserDataMode for the index given.

Public Member Functions

Detailed Description

Member Function Documentation