Bink SDK 1.5v

# BinkSetVideoOnOff

The function BinkSetVideoOnOff tells Bink not to decompress the video frames when BinkDoFrame is called.

    S32 BinkSetVideoOnOff(
      HBINK bink,
      S32 on_off
    );

#### In Parameters

bink
  Specifies the Bink handle.
on_off
  Specifies the whether the video should be decompressed (non-zero), or whether just the audio should be decompressed (zero).

#### Returns

Returns whether the video is currently on (non-zero) or off (zero).

#### Discussion

This function allows you to shut off the video decompression of a playing Bink file. This is useful when you want to only play the audio track of a Bink file and don't care about decompressing the video track. This function is a toggle, so you call it once with a zero to turn off the video, and then you call it again with a non-zero value to start the video playback again. This function returns non-zero if the video is on, and a zero if the video is turned off.

Group: Bink API
Related Functions: BinkSetSoundOnOff
Related Basic Types: HBINK, S32

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