to_running_time

Description:

public uint64 to_running_time (Format format, uint64 position)

Translate position to the total running time using the currently configured segment.

Position is a value between this start and stop time.

This function is typically used by elements that need to synchronize to the global clock in a pipeline. The running time is a constantly increasing value starting from 0. When init is called, this value will reset to 0.

This function returns -1 if the position is outside of this start and stop.

Parameters:

this	a Segment structure.
format	the format of the segment.
position	the position in the segment

Returns:

the position as the total running time or -1 when an invalid position was given.