SGCompressFrameComplete
The SGCompressFrameComplete function provides the default behavior for your compress-complete function.
pascal ComponentResult SGCompressFrameComplete (SGChannel c,
short bufferNum,
Boolean *done,
SGCompressInfo *ci);
c
- Specifies the reference that identifies the channel for this operation.
The sequence grabber component provides this value to your compress-complete function.
bufferNum
- Identifies the buffer. The sequence grabber component provides this value to your compress-complete function.
done
- Contains a pointer to a Boolean value. The
SGCompressFrameComplete function sets this Boolean
value to indicate whether the frame has been completely
compressed. The function sets the Boolean value to true
if the compression is complete; it sets the Boolean value to
false if the operation is incomplete. The sequence grabber
component provides this pointer to your compress-complete function.
ci
- Contains a pointer to a compression information structure (defined by the
SGCompressInfo data type). If the compression is complete, the function completely formats this structure with information that is appropriate to the frame just compressed. See "The Compression Information Structure" beginning on page 5-20 for a description of this structure. The sequence grabber component provides this pointer to your compress-complete function.
SPECIAL CONSIDERATIONS
You should call the SGCompressFrameComplete function only from your compress-complete function. If you call it at any other time, results are unpredictable.
RESULT CODES
| cantDoThatInCurrentMode | -9402 | Request invalid in current mode |
Image Compression Manager errors
SEE ALSO
See "Application-Defined Functions," which begins on page 5-107, for information about compress-complete functions.
