This interface is used with an object which converts between film frame rates and videotape frame rates by describing the mapping between them. More...

Public Member Functions
HRESULT	GetInputSegment ([out] IAAFSegment **ppInputSegment)
	Places the input Segment object in this pulldown into the ppInputSegment argument.
HRESULT	SetInputSegment ([in] IAAFSegment *pInputSegment)
	Sets the input segment .
HRESULT	GetPulldownKind ([out] aafPulldownKind_t *pPulldownKind)
	Returns the pulldownKind property of this pulldown through the pPulldownKind argument.
HRESULT	SetPulldownKind ([in] aafPulldownKind_t pulldownKind)
	Sets the pulldown kind field of this pulldown object.
HRESULT	GetPulldownDirection ([out] aafPulldownDir_t *pPulldownDirection)
	Returns the pulldownDirection field of this pulldown through the pPulldownDirection argument.
HRESULT	SetPulldownDirection ([in] aafPulldownDir_t pulldownDirection)
	Sets the pulldown direction field of this pulldown object.
HRESULT	GetPhaseFrame ([out] aafPhaseFrame_t *pPhaseFrame)
	Returns the phaseFrame field of this pulldown through the pPhaseFrame argument.
HRESULT	SetPhaseFrame ([in] aafPhaseFrame_t phaseFrame)
	Sets the phase frame field of this pulldown object.

Detailed Description

This interface is used with an object which converts between film frame rates and videotape frame rates by describing the mapping between them.

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

IAAFSegment

Definition at line 22506 of file AAF.idl.

Member Function Documentation

HRESULT IAAFPulldown::GetInputSegment ( [out] IAAFSegment ** ppInputSegment )

Places the input Segment object in this pulldown into the ppInputSegment argument.

If none exists yet, NULL is placed into the *ppInputSegment argument.

The returned segment object, if it exists, is AddRef()ed before it is returned.

Succeeds if all of the following are true:

the ppInputSegment pointer is valid.
A valid segment exists.

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

ppInputSegment is null.

Parameters:

ppInputSegment [out] Returns the input Segment object

HRESULT IAAFPulldown::GetPhaseFrame ( [out] aafPhaseFrame_t * pPhaseFrame )

Returns the phaseFrame field of this pulldown through the pPhaseFrame argument.

The phase frame field specifies the phase within the repeating pattern used to map between the two edit rates. A value of zero specifies that the pulldown object starts at the begining of the pattern.

Succeeds if all of the following are true:

the pPhaseFrame 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

pPhaseFrame is null.

Parameters:

pPhaseFrame [out] Returns the input Segment object

HRESULT IAAFPulldown::GetPulldownDirection ( [out] aafPulldownDir_t * pPulldownDirection )

Returns the pulldownDirection field of this pulldown through the pPulldownDirection argument.

The valid pulldown directions are: kVideoToFilmSpeed -- The input segment is at videoSpeed, and the pulldown object is on a mob slot at film edit rate. kFilmToVideoSpeed -- The input segment is at film edit rate.

The value kVideoToFilmSpeed is used when connecting 24fps file mobs to tape mobs.

The value kFilmToVideoSpeed is used when connecting tape mobs to film mobs.

Succeeds if all of the following are true:

the pPulldownDirection 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

pPulldownDirection is null.

Parameters:

pPulldownDirection [out] Returns the input Segment object

HRESULT IAAFPulldown::GetPulldownKind ( [out] aafPulldownKind_t * pPulldownKind )

Returns the pulldownKind property of this pulldown through the pPulldownKind argument.

The pulldown kinds include kThreeTwoPD, kPalPD, kOneToOneNTSC, kOneToOnePAL, and kVideoTapNTSC.

Succeeds if all of the following are true:

the pPulldownKind 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

pPulldownKind is null.

Parameters:

pPulldownKind [out] Returns the pulldownKind property

HRESULT IAAFPulldown::SetInputSegment ( [in] IAAFSegment * pInputSegment )

Sets the input segment .

Succeeds if all of the following are true:

the pInputSegment 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

pInputSegment is null.

Parameters:

pInputSegment [in] A Segment object

HRESULT IAAFPulldown::SetPhaseFrame ( [in] aafPhaseFrame_t phaseFrame )

Sets the phase frame field of this pulldown object.

The phase frame field specifies the phase within the repeating pattern used to map between the two edit rates. A value of zero specifies that the pulldown object starts at the begining of the pattern.

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

pInputSegment is null.

Parameters:

phaseFrame [in] A Segment object

HRESULT IAAFPulldown::SetPulldownDirection ( [in] aafPulldownDir_t pulldownDirection )

Sets the pulldown direction field of this pulldown object.

The valid pulldown directions are: kVideoToFilmSpeed -- The input segment is at videoSpeed, and the pulldown object is on a mob slot at film edit rate. kFilmToVideoSpeed -- The input segment is at film edit rate.

The value kVideoToFilmSpeed is used when connecting 24fps file mobs to tape mobs.

The value kFilmToVideoSpeed is used when connecting tape mobs to film mobs.

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

pInputSegment is null.

Parameters:

pulldownDirection [in] A Segment object

HRESULT IAAFPulldown::SetPulldownKind ( [in] aafPulldownKind_t pulldownKind )

Sets the pulldown kind field of this pulldown object.

The pulldown kinds include kThreeTwoPD, kPalPD, kOneToOneNTSC, kOneToOnePAL, and kVideoTapNTSC.

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

pInputSegment is null.

Parameters:

pulldownKind [in] A Segment object

Public Member Functions

Detailed Description

Member Function Documentation