SGGetTimeRemaining
The SGGetTimeRemaining function allows you to obtain an estimate of the amount of recording time that remains for the current record operation. The sequence
grabber component estimates this value based on the amount of storage remaining and the speed with which the record operation is consuming that space. This estimate improves as the record process continues. If you have limited the record time by calling the SGSetMaximumRecordTime function (see page 5-51 for details), SGGetTimeRemaining does not return a value that is greater than the limit you
have set.
pascal ComponentResult SGGetTimeRemaining (SeqGrabComponent s,
long *ticksLeft);
s
- Specifies the component instance that identifies your connection to the sequence grabber component. You obtain this value from the Component Manager's
OpenDefaultComponent or OpenComponent function.
ticksLeft
- Contains a pointer to a long integer that is to receive a value indicating an estimate of the amount of time remaining for the current record operation. This value is expressed in system ticks.
DESCRIPTION
You can call the SGGetTimeRemaining function only after you have started a record operation.
SPECIAL CONSIDERATIONS
This function may take a relatively long time to execute. You should not call it too frequently--once per second is reasonable.
RESULT CODE
| seqGrabInfoNotAvailable | -9407 | Sequence grabber cannot support request |
