The IAAFControlPoint interface is implemented by objects that store an individual point value of a parameter whose value changes during the operation group. More...

Public Member Functions
HRESULT	Initialize ([in] IAAFVaryingValue *pVaryingValue,[in] aafRational_constref time,[in] aafUInt32 valueSize,[in, size_is(valueSize)] aafDataBuffer_t pValue)
	Initializes a new control point object to be.
HRESULT	GetTime ([out, retval] aafRational_t *pTime)
	Returns the position of the control point within an operation group, expressed as a rational running from 0 to 1.
HRESULT	GetEditHint ([out, retval] aafEditHint_t *pEditHint)
	Returns the edit hint of the control point, which describes how to alter the position if the AAFOperationGroup is made longer or shorter.
HRESULT	GetValueBufLen ([out] aafUInt32 *pLen)
	Returns the length of buffer required for the GetValue() method.
HRESULT	GetValue ([in] aafUInt32 valueSize,[out, size_is(valueSize), length_is(bytesRead)] aafDataBuffer_t pValue,[out] aafUInt32 bytesRead)
	Writes the value into the pValue buffer.
HRESULT	SetTime ([in] aafRational_t pTime)
	Sets the position of the control point within an operation group, expressed as a rational running from 0 to 1.
HRESULT	SetEditHint ([in] aafEditHint_t editHint)
	Sets the control point Edit hint value, which describes how to alter the position if the AAFOperationGroup is made longer or shorter.
HRESULT	GetTypeDefinition ([out, retval] IAAFTypeDef **ppTypeDef)
	Places the type definition of the dataval inside this parameter into the ppTypeDef argument.
HRESULT	SetValue ([in] aafUInt32 valueSize,[in, size_is(valueSize)] aafDataBuffer_t pValue)
	The data value is set from a buffer of size valueSize and type.

Detailed Description

The IAAFControlPoint interface is implemented by objects that store an individual point value of a parameter whose value changes during the operation group.

IAAFControlPoints must be added to an object which implements IAAFVaryingValue, which is then added to the IAAFOperationGroup.

For parameters which are constant in value during the operation group, use IAAFConstantValue.

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

IAAFObject

Definition at line 4756 of file AAF.idl.

Member Function Documentation

HRESULT IAAFControlPoint::GetEditHint ( [out, retval] aafEditHint_t * pEditHint )

Returns the edit hint of the control point, which describes how to alter the position if the AAFOperationGroup is made longer or shorter.

Succeeds if all of the following are true:

the pEditHint pointer is valid.

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

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_PROP_NOT_PRESENT

This property does not exist in the file.

AAFRESULT_NULL_PARAM

pEditHint arg is NULL.

Parameters:

pEditHint [out,retval] Pointer to an aafEditHint_t

HRESULT IAAFControlPoint::GetTime ( [out, retval] aafRational_t * pTime )

Returns the position of the control point within an operation group, expressed as a rational running from 0 to 1.

Succeeds if all of the following are true:

the pTime pointer is valid.

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

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_PROP_NOT_PRESENT

This property does not exist in the file.

AAFRESULT_NULL_PARAM

pTime arg is NULL.

Parameters:

pTime [out,retval] Pointer to an aafRational_t

HRESULT IAAFControlPoint::GetTypeDefinition ( [out, retval] IAAFTypeDef ** ppTypeDef )

Places the type definition of the dataval inside this parameter into the ppTypeDef 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_NOT_INITIALIZED

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

AAFRESULT_NULL_PARAM

ppTypeDef is null.

Parameters:

ppTypeDef [out,retval] Type Definition of the dataval inside of this object

HRESULT IAAFControlPoint::GetValue	(	[in] aafUInt32	valueSize,
		[out, size_is(valueSize), length_is(*bytesRead)] aafDataBuffer_t	pValue,
		[out] aafUInt32 *	bytesRead
	)

Writes the value into the pValue buffer.

The buffer is allocated by the caller, and the size of the buffer is given by valueSize.

Caller may call GetValueBufLen() to determine the required buffer size.

Succeeds if all of the following are true:

the pValue pointer is valid.
valueSize indicates the buffer is large enough to hold the name.

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

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

pValue arg is NULL.

AAFRESULT_SMALLBUF

valueSize indicates the buffer is too small to hold the value.

Parameters:

valueSize	[in] Size of preallocated buffer
pValue	[out, size_is(valueSize),length_is(*bytesRead)] Preallocated buffer to hold value
bytesRead	[out] Number of actual bytes read

HRESULT IAAFControlPoint::GetValueBufLen ( [out] aafUInt32 * pLen )

Returns the length of buffer required for the GetValue() method.

The value is placed into the location specified by pLen.

Succeeds if all of the following are true:

the pLen pointer is valid.

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

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

pLen arg is NULL.

Parameters:

pLen	[out] Pointer to an variable used to return the length

HRESULT IAAFControlPoint::Initialize	(	[in] IAAFVaryingValue *	pVaryingValue,
		[in] aafRational_constref	time,
		[in] aafUInt32	valueSize,
		[in, size_is(valueSize)] aafDataBuffer_t	pValue
	)

Initializes a new control point object to be.

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.
pVaryingValue is a valid pointer.
time is a valid rational.
pValue is a valid pointer

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

This object has already had Initialize() called on it.

AAFRESULT_NULL_PARAM

pName or pValue arg is NULL.

Parameters:

pVaryingValue	[in] A varying value (this determines the type of this control point through the parameter definition)
time	[in] Control Point time
valueSize	[in] Size of preallocated buffer
pValue	[in, size_is(valueSize)] buffer containing value

HRESULT IAAFControlPoint::SetEditHint ( [in] aafEditHint_t editHint )

Sets the control point Edit hint value, which describes how to alter the position if the AAFOperationGroup is made longer or shorter.

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.

Parameters:

editHint [in] Control Point Edit hint

HRESULT IAAFControlPoint::SetTime ( [in] aafRational_t pTime )

Sets the position of the control point within an operation group, expressed as a rational running from 0 to 1.

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.

Parameters:

pTime [in] Control Point time

HRESULT IAAFControlPoint::SetValue	(	[in] aafUInt32	valueSize,
		[in, size_is(valueSize)] aafDataBuffer_t	pValue
	)

The data value is set from a buffer of size valueSize and type.

Succeeds if all of the following are true:

pTypeDef is valid and registered with the object's dictionary.
the pValue pointer is valid.

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

ppTypeDef is null.

Parameters:

valueSize	[in] Size of preallocated buffer
pValue	[in, size_is(valueSize)] buffer containing value

Public Member Functions

Detailed Description

Member Function Documentation