Bink SDK 1.5v

# BINKSUMMARY

The structure BINKSUMMARY is a structure used to return playback summary information from BinkGetSummary.

    struct BINKSUMMARY
    {
      U32 Width;
      U32 Height;
      U32 TotalTime;
      U32 FileFrameRate;
      U32 FileFrameRateDiv;
      U32 FrameRate;
      U32 FrameRateDiv;
      U32 TotalOpenTime;
      U32 TotalFrames;
      U32 TotalPlayedFrames;
      U32 SkippedFrames;
      U32 SkippedBlits;
      U32 SoundSkips;
      U32 TotalBlitTime;
      U32 TotalReadTime;
      U32 TotalVideoDecompTime;
      U32 TotalAudioDecompTime;
      U32 TotalIdleReadTime;
      U32 TotalBackReadTime;
      U32 TotalReadSpeed;
      U32 SlowestFrameTime;
      U32 Slowest2FrameTime;
      U32 SlowestFrameNum;
      U32 Slowest2FrameNum;
      U32 AverageDataRate;
      U32 AverageFrameSize;
      U32 HighestMemAmount;
      U32 TotalIOMemory;
      U32 HighestIOUsed;
      U32 Highest1SecRate;
      U32 Highest1SecFrame;
    };

#### Out Members

Width
  Specifies the width of the Bink file.
Height
  Specifies the height of the Bink file.
TotalTime
  Specifies the total playback time (in milliseconds).
FileFrameRate
  Along with FileFrameRateDiv, specifies the original frame rate of the Bink file. The frame rate is calculated by (summary->FileFrameRate/summary->FileFrameRateDiv). The file frame rate is the frame rate of the file before you overrode the frame rate with BinkSetFrameRate.
FileFrameRateDiv
  Specifies the original frame rate divisor of the Bink file.
FrameRate
  Along with FrameRateDiv, specifies the frame rate of the Bink file. The frame rate is calculated by (summary->FrameRate/summary->FrameRateDiv).
FrameRateDiv
  Specifies the frame rate divisor of the Bink file.
TotalOpenTime
  Specifies the time to open and prepare the Bink file for decompression.
TotalFrames
  Specifies the number of frames in the Bink file.
TotalPlayedFrames
  Specifies the number of frames played.
SkippedFrames
  Specifies the number of frames that had to be skipped during playback.
SkippedBlits
  Specifies the number of blitting stages that had to be skipped during playback.
SoundSkips
  Specifies the number of times that the sound dropped out during playback.
TotalBlitTime
  Specifies the time spent blitting (in milliseconds).
TotalReadTime
  Specifies the time spent reading in the foreground (in milliseconds).
TotalVideoDecompTime
  Specifies the time spent decompressing the video (in milliseconds).
TotalAudioDecompTime
  Specifies the time spent decompressing the audio (in milliseconds).
TotalIdleReadTime
  Specifies the time spent reading at idle time (in milliseconds).
TotalBackReadTime
  Specifies the time spent reading in the background thread (in milliseconds).
TotalReadSpeed
  Specifies the device reading IO speed (in bytes/second).
SlowestFrameTime
  Specifies the slowest single frame time (in milliseconds).
Slowest2FrameTime
  Specifies the second-slowest single frame time (in milliseconds).
SlowestFrameNum
  Specifies the slowest single frame number.
Slowest2FrameNum
  Specifies the second-slowest single frame number.
AverageDataRate
  Specifies the average data rate of the movie (in bytes/second).
AverageFrameSize
  Specifies the average size of the frames (in bytes).
HighestMemAmount
  Specifies the highest amount of memory allocated at one time during playback (in bytes).
TotalIOMemory
  Specifies the size of the IO buffer used to read ahead in the Bink file (in bytes).
HighestIOUsed
  Specifies the highest level that the read ahead IO buffer was filled to (in bytes).
Highest1SecRate
  Specifies the highest one second data rate in the Bink file (in bytes/second).
Highest1SecFrame
  Specifies the starting frame of the highest one second data rate in the Bink file.

#### Discussion

The BINKSUMMARY structure is used in the BinkGetSummary function. It returns the playback statistics of a complete playback of a Bink file.

Group: Bink API
Related Functions: BinkGetSummary, BinkSetFrameRate
Related Basic Types: U32

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