IAAFSegment Interface Reference

The IAAFSegment interface is implemented by objects which represent a component that is independent of any other components which may surround it in a sequence. More...

List of all members.

Public Member Functions
HRESULT	SegmentOffsetToTC ([in] aafPosition_t *pOffset,[out] aafTimecode_t *pTimecode)
	Converts the given Segment offset to timecode.
HRESULT	SegmentTCToOffset ([in] aafTimecode_t *pTimecode,[in] aafRational_t *pEditRate,[out] aafFrameOffset_t *pOffset)
	Converts the given Timecode to an Offset.

---

Detailed Description

The IAAFSegment interface is implemented by objects which represent a component that is independent of any other components which may surround it in a sequence.

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.

AAFRESULT_NOT_INITIALIZED

• This object has not yet had Initialize() called on it through this object's primary interface. Note that IAAFSegment is a primary interface for an abstract class, so it is not appropriate for the Initialize() method to exist in this interface. The Initialize() method is available through the concrete object's primary interface. Objects that implement IAAFSegment also implement the following interfaces:

IAAFComponent

• IAAFComponent2
• IAAFObject

Definition at line 24141 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFSegment::SegmentOffsetToTC	(	[in] aafPosition_t *	pOffset,
		[out] aafTimecode_t *	pTimecode
	)

Converts the given Segment offset to timecode.

Succeeds if all of the following are true:

• the pOffset pointer is valid.
• the pTimeCode pointer is valid.

If this method fails the value of pTimecode is left unchanged.

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

• any arg is NULL.

AAFRESULT_TIMECODE_NOT_FOUND

• the given offset is not available in this segment.

Parameters:

pOffset	[in] Pointer to a Segment Offset to be convert to Timecode
pTimecode	[out] The converted timecode to be returned

HRESULT IAAFSegment::SegmentTCToOffset	(	[in] aafTimecode_t *	pTimecode,
		[in] aafRational_t *	pEditRate,
		[out] aafFrameOffset_t *	pOffset
	)

Converts the given Timecode to an Offset.

Succeeds if all of the following are true:

• the pTimeCode pointer is valid.
• the pEditRate pointer is valid
• the pFrameOffset pointer is valid.

If this method fails the value of pOffset is left unchanged.

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

• any arg is NULL.

AAFRESULT_TIMECODE_NOT_FOUND

• the given timecode is not available in this segment.

Parameters:

pTimecode	[in] Pointer to a timecode to be converted to Offset
pEditRate	[in] The edit rate for the given timecode
pOffset	[out] Frame Offset to be returned if found