Difference between revisions of "DoBeep function"

From StealthBot Wiki Backup
Jump to: navigation, search
(Created page with 'The DoBeep function is provided by the Script Support Class to StealthBot to expose the Beep() API function to scripting. ==Development== The DoBeep function was add…')
 
m (1 revision imported)
 
(No difference)

Latest revision as of 08:20, 1 December 2017

The DoBeep function is provided by the Script Support Class to StealthBot to expose the Beep() API function to scripting.

Development

The DoBeep function was added in version 2.4.

Documentation

'// DOBEEP
'// Executes a call to the Beep() API function
Public Function DoBeep(ByVal lFreq As Long, ByVal lDuration As Long) As Long

    DoBeep = Beep(lFreq, lDuration)

End Function

Summary

This function calls the API function Beep in order to delete the URL cache for the specified URL. Call this to make a sound come out of your system speakers. The sound normally does not come from your normal speakers and is not affected by volume controls (it may be very loud). This function call is synchronous so long beeps will freeze up the bot until their completion.

Syntax

DoBeep Frequency, Duration

Arguments

  • lFreq is the frequency of the beep in hertz. This value must be between 37 and 32767.
  • lDuration is the length of the beep in milliseconds. Long beeps will freeze up the bot until their completion.

Examples

  • Beep at 440 Hertz (musical fourth octave A) for a half-second.
  • DoBeep 440, 500
    
  • Beep in a loop, increasing quickly (thanks Jack).
  • For F = 50 To 5000 Step 25
        DoBeep F, 1
    Next
    

See also