Bink SDK 1.5v

# BinkDoFrame

The function BinkDoFrame decompresses the next frame of video.

    S32 BinkDoFrame(
      HBINK bink
    );

#### In Parameters

bink
  Specifies the Bink handle.

#### Returns

Returns one if the frame was skipped, or zero otherwise.

#### Discussion

This function does the actual decompression of the next Bink frame. Bink decompresses the compressed Bink frame into the three internal YUV memory buffers, so you must then copy the data out of the internal buffers with the BinkCopyToBuffer function. If the audio is falling behind the video, this function may skip decompressing the video frame. You can determine how many frames have been skipped by examining the SkippedFrames field of the Bink summary structure (see the BinkGetSummary function for details). If you specified the BINKNOSKIP flag in BinkOpen, then BinkDoFrame will never skip a frame. You should call BinkNextFrame before calling this function again. This function returns one if the frame was skipped, or zero otherwise. If you specified the BINKNOSKIP flag in BinkOpen, then this function returns a non-zero value if the frame should have been skipped.

Group: Bink API
Related Sections: Bink Video Playback, Open and Close
Related Functions: BinkCopyToBuffer, BinkCopyToBufferRect, BinkDoFrame, BinkGetRects, BinkGetSummary, BinkNextFrame, BinkOpen, BinkWait
Related Basic Types: BINK_OPEN_FLAGS, HBINK, S32

For technical support, e-mail Bink1@radgametools.com
© Copyright 1994-2003 RAD Game Tools, Inc. All Rights Reserved.