AAFA Developer Support

Main Page | Class List | File List | Class Members | File Members

IAAFSegment Interface Reference

List of all members.

Detailed Description

Objects that implement IAAFSegment also implement the following interfaces: - IAAFComponent - IAAFComponent2 - IAAFObject.

Definition at line 18792 of file AAF.idl.

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.


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


Generated on Thu Feb 17 09:34:21 2005 for AAF COM API by doxygen 1.4.1