SetSoundFrequency()

Syntax

SetSoundFrequency(#Sound, Frequency [, Channel])

Set the new frequency, in real-time, for the sound. The new frequency value is saved for the sound, so it's not needed to call it every time.

Parameters

#Sound	The sound to use.
Frequency	The sound new frequency (in Hz) to set. Valid values are from 1000 Hz to 100000 Hz.
Channel (optional)	The channel to use. It's the value returned by PlaySound() when using the #PB_Sound_MultiChannel flag. If #PB_All is specified, all the channels of the sound are affected.

Return value

None.

Example

  If InitSound()           ; Initialize Sound system
    UseOGGSoundDecoder()   ; Use ogg files
    
    ; Loads a sound from a file
    If LoadSound(0, #PB_Compiler_Home +"Examples/3D/Data/Siren.ogg")
      ; The sound is playing
      PlaySound(0, #PB_Sound_Loop, 20)
      
      MessageRequester("Info", "The average frequency is " + Str(GetSoundFrequency(0))+" Hz")
      PauseSound(0)
      
      SetSoundFrequency(0, 16000)
      
      ResumeSound(0)
      
      MessageRequester("Info", "The average frequency is " + Str(GetSoundFrequency(0))+" Hz")
      
      FreeSound(0) ; The sound is freed
      End
    EndIf
  Else
    Debug "Warning! The sound environment couldn't be initialized. So no sound commands can be used..."
  EndIf

See Also

GetSoundFrequency()

Supported OS

Windows