The IAAFTimelineMobSlot interface is implemented by objects which contain time-varying timeline essence. More...

Public Member Functions
HRESULT	Initialize ()
	Initializes a newly allocated, empty IAAFTimelineMobSlot2-supporting object.
HRESULT	GetEditRate ([out, retval] aafRational_t *pEditRate)
	This method will get the edit rate for this mob slot.
HRESULT	SetEditRate ([in] aafRational_constref editRate)
	This method will get set edit rate for this mob slot.
HRESULT	GetOrigin ([out, retval] aafPosition_t *pOrigin)
	This method will return the origin of this mob slot.
HRESULT	SetOrigin ([in] aafPosition_t origin)
	This method will set the origin of this mob slot.
HRESULT	GetMarkIn ([out, retval] aafPosition_t *result)
	Gets the MarkIn property of this TimelineMobSlot.
HRESULT	SetMarkIn ([in] aafPosition_t value)
	Sets the MarkIn property of this TimelineMobSlot.
HRESULT	GetMarkOut ([out, retval] aafPosition_t *result)
	Gets the MarkOut property of this TimelineMobSlot.
HRESULT	SetMarkOut ([in] aafPosition_t value)
	Sets the MarkOut property of this TimelineMobSlot.
HRESULT	GetUserPos ([out, retval] aafPosition_t *result)
	Gets the UserPos property of this TimelineMobSlot.
HRESULT	SetUserPos ([in] aafPosition_t value)
	Sets the UserPos property of this TimelineMobSlot.

Detailed Description

The IAAFTimelineMobSlot interface is implemented by objects which contain time-varying timeline essence.

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.

Types required by this module:

aafBool aafRational_t aafPosition_t aafTrackID_t Objects that implement IAAFTimelineMobSlot2 also implement the following interfaces:

Definition at line 50972 of file AAF.idl.

Member Function Documentation

HRESULT IAAFTimelineMobSlot2::GetEditRate ( [out, retval] aafRational_t * pEditRate )

This method will get the edit rate for this mob slot.

Succeeds if all of the following are true:

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

pEditRate arg is NULL.

Parameters:

pEditRate [out,retval] Edit rate property value

HRESULT IAAFTimelineMobSlot2::GetMarkIn ( [out, retval] aafPosition_t * result )

Gets the MarkIn property of this TimelineMobSlot.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.
the result pointer is valid.
the property is present.

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

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NOT_INITIALIZED

the object is not initialized.

AAFRESULT_NULL_PARAM

pMarkIn arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

result [out,retval] MarkIn property value

HRESULT IAAFTimelineMobSlot2::GetMarkOut ( [out, retval] aafPosition_t * result )

Gets the MarkOut property of this TimelineMobSlot.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.
the result pointer is valid.
the property is present.

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

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NOT_INITIALIZED

the object is not initialized.

AAFRESULT_NULL_PARAM

pMarkIn arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

result [out,retval] MarkOut property value

HRESULT IAAFTimelineMobSlot2::GetOrigin ( [out, retval] aafPosition_t * pOrigin )

This method will return the origin of this mob slot.

Succeeds if all of the following are true:

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

pOrigin arg is NULL.

Parameters:

pOrigin [out,retval] Origin property value

HRESULT IAAFTimelineMobSlot2::GetUserPos ( [out, retval] aafPosition_t * result )

Gets the UserPos property of this TimelineMobSlot.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.
the result pointer is valid.
the property is present.

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

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NOT_INITIALIZED

the object is not initialized.

AAFRESULT_NULL_PARAM

result arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

result [out,retval] UserPos property value

HRESULT IAAFTimelineMobSlot2::Initialize ( )

Initializes a newly allocated, empty IAAFTimelineMobSlot2-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 IAAFTimelineMobSlot2::SetEditRate ( [in] aafRational_constref editRate )

This method will get set edit rate for this mob slot.

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:

editRate [in] Edit rate property value

HRESULT IAAFTimelineMobSlot2::SetMarkIn ( [in] aafPosition_t value )

Sets the MarkIn property of this TimelineMobSlot.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.

If this method fails the MarkIn property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NOT_INITIALIZED

the object is not initialized.

Parameters:

value [in] MarkIn property value

HRESULT IAAFTimelineMobSlot2::SetMarkOut ( [in] aafPosition_t value )

Sets the MarkOut property of this TimelineMobSlot.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.

If this method fails the MarkOut property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NOT_INITIALIZED

the object is not initialized.

Parameters:

value [in] MarkOut property value

HRESULT IAAFTimelineMobSlot2::SetOrigin ( [in] aafPosition_t origin )

This method will set the origin of this mob slot.

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:

origin [in] Origin property value

HRESULT IAAFTimelineMobSlot2::SetUserPos ( [in] aafPosition_t value )

Sets the UserPos property of this TimelineMobSlot.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.

If this method fails the UserPos property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NOT_INITIALIZED

the object is not initialized.

Parameters:

value [in] UserPos property value

Public Member Functions

Detailed Description

Member Function Documentation