mluTCFramesBetween(3dm)                                mluTCFramesBetween(3dm)


NAME
     mluTCFramesBetween - Digital Media timecode mathematics

SYNOPSIS
     #include <dmedia/mlutimecode.h>

     MLstatus mluTCFramesBetween
         ( int *result,
           const MLUtimecode *a,
           const MLUtimecode *b )


TYPES
     MLUtimecode     A structure containing a representation of SMPTE time
                     code on which certain mathematical and utility functions
                     can be performed.  Can be used with:  mluTCAddTC(3dm),
                     mluTCAddFrames(3dm), mluTCToString(3dm),
                     mluTCFromSeconds(3dm), mluTCToSeconds(3dm),
                     mluTCFromString(3dm), mluTCFramesPerDay(3dm), and


ARGUMENTS
     result          The result of calculating the difference (b-a), measured
                     in frames.


     a, b            The two operands of the differencing operation.


DESCRIPTION
     dmFramesBetween is used to determine the number of frames between two
     timecodes.  It returns (b - a), as measured in frames.  The result of the
     difference operation may be negative; this is not an error condition.

     Note that the operands a and b must have the same tc_type as each other.


RETURN VALUE
     If a MLUtimecode operand (a or b) contains an illegal timecode value
     (e.g., a negative entry, invalid frame number, etc.), these functions
     will return ML_STATUS_INVALID_ARGUMENT, and the contents of result will
     be undefined.

     If the tc_type's of a and b do not match, mluTCFramesBetween will return
     ML_STATUS_INVALID_ARGUMENT, and the contents of result will be undefined.

     mluTCFramesBetween returns ML_STATUS_NO_ERROR upon successful completion
     of the subtraction operation.


Copyright SGI 2000    CONFIDENTIAL DRAFT                                Page 1


SEE ALSO
     mluTCFromString(3dm), mluTCFromString(3dm), mluTCToSeconds(3dm).


     Copyright (c) 2000 Silicon Graphics, Inc.  All Rights Reserved.


Copyright SGI 2000    CONFIDENTIAL DRAFT                                Page 2