Bink SDK 1.5v

# BinkSetSoundOnOff

The function BinkSetSoundOnOff tells Bink not to decompress the audio and release any audio resources.

    S32 BinkSetSoundOnOff(
      HBINK bink,
      S32 on_off
    );

#### In Parameters

bink
  Specifies the Bink handle.
on_off
  Specifies the whether the sound track should be processed (non-zero), or whether Bink skip decompressing the audio.

#### Returns

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

#### Discussion

This function allows you to shut off the audio playback of a Bink file. This is useful if you want to stop all sound completely, or if you need to release the digital sound resource handles to play a wave or AVI file. Note that this function is not a mute function! If you want to mute the audio, call BinkSetVolume with zero for the volume level. If you know that you are never going to play the audio, then don't use this function and instead call BinkSetSoundTrack with zero for both parameters before opening the Bink file with the BINKSNDTRACK flag. This function is a toggle, so you call it once with zero to turn off the sound, and then you call it again with a non-zero value to start the audio playback again. This function returns non-zero if the audio is on, and zero if the audio is turned off.

Group: Bink API
Related Functions: BinkSetSoundTrack, BinkSetVideoOnOff, BinkSetVolume
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.