IAAFTimecode Interface Reference

The IAAFTimecode interface is implemented by objects which store videotape or audio tape timecode information. More...

List of all members.

Public Member Functions
HRESULT	Initialize ([in] aafLength_t length,[in] aafTimecode_t *pTimecode)
	Initializes this object with the given length and timecode values.
HRESULT	GetTimecode ([out] aafTimecode_t *pTimecode)
	Get the timecode fields.
HRESULT	SetTimecode ([in] aafTimecode_t *timecode)
	Set the timecode fields.

---

Detailed Description

The IAAFTimecode interface is implemented by objects which store videotape or audio tape timecode information.

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

IAAFSegment

• IAAFComponent
• IAAFComponent2
• IAAFObject

Definition at line 27882 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFTimecode::GetTimecode

(

[out] aafTimecode_t *

pTimecode

)

Get the timecode fields.

Succeeds if all of the following are true:

• the pTimecode pointer is valid.

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

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

• Initialize() has already been called on this object.

AAFRESULT_NULL_PARAM

• pTimecode arg is NULL.

Parameters:

pTimecode

[out] Timecode (startFrame, drop, fps)

HRESULT IAAFTimecode::Initialize	(	[in] aafLength_t	length,
		[in] aafTimecode_t *	pTimecode
	)

Initializes this object with the given length and timecode values.

Length is specified in units of the edit rate of the containing timeline mob slot.

Succeeds if all of the following are true:

• this object has not yet been initialized.
• the pTimecode 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_ALREADY_INITIALIZED

• Initialize() has already been called on this object.

AAFRESULT_NULL_PARAM

• pTimecode argument is NULL.

Parameters:

length	[in] Length Property Value
pTimecode	[in] Timecode Value (startFrame, drop, fps)

HRESULT IAAFTimecode::SetTimecode

(

[in] aafTimecode_t *

timecode

)

Set the timecode fields.

Succeeds if all of the following are true:

• the pTimecode pointer is valid.

If this method fails no state will be changed.

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

• Initialize() has already been called on this object.

AAFRESULT_NULL_PARAM

• pTimecode arg is NULL.

Parameters:

timecode

[in] Timecode (startFrame, drop, fps)