Lines back to top
- 0 : Destination - Undefined - 1 : Destination - Digital - 2 : Destination - Line - 3 : Destination - Monitor - 4 :Destination - Speakers - 5 :Destination - Headphones - 6 :Destination - Telephone - 7 :Destination - Wave-in - 8 :Destination - Voice-in - 9 :Source - Undefined	- 10 :Source - Digital - 11 :Source - Line - 12 :Source - Microphone - 13 :Source - Synthesizer - 14 :Source - Compact disc - 15 :Source - Telephone - 16 :Source - PC speaker - 17 :Source - Wave out - 18 :Source - Auxiliary - 19 :Source - Analog

SetBackgroundColor back to top
Description	Sets the color of the plugin background.
Usage	**This example changes the background color to blue. Color$ = '0,0,255' PluginSet("PlugIn","Color$") PluginRun("PlugIn","SetBackgroundColor")
Comment	The default background is black. You can define a custom background color with this function. The color is a RGB color, that means that it is defined by three values ranging from 0 to 255. The values have to be seperated by a comma in the string. Note that defining a background color erases the background picture. You can define a backround picture with the SetBackgroundPicture function.
Load variables	String : Your color (format : 'x,x,x' )	Integer : N/A
Return variables	String : N/A	Integer : N/A

SetBackgroundPicture back to top
Description	Sets the picture of the plugin background.
Usage	path$ = '<Embedded>\MyPicture.jpg' PluginSet("PlugIn","path$") PluginRun("PlugIn","SetBackgroundPicture")
Comment	The default background is a black solid color. You can define a custom background picture with this function. The accepted filetypes are *.bmp, *.jpg, *.wmf and the common MMB placeholders are supported (<Src Dir>, <Windows>, <System>, <Embedded>). The background picture is automatically stretched to fill the plugin window. You can define a background color with the SetBackgroundColor function.
Load variables	String : The path to your background picture.	Integer : N/A
Return variables	String : N/A	Integer : N/A

SetBarColor back to top
Description	Sets the color of the VU bar.
Usage	**This example changes the bar color to green. Color$ = '0,255,0' PluginSet("PlugIn","Color$") PluginRun("PlugIn","SetBarColor")
Comment	The default bar color is red. You can define a custom bar color with this function. The color is a RGB color, that means that it is defined by three values ranging from 0 to 255. The values have to be seperated by a comma in the string. Note that defining a bar color erases the bar picture. You can define a bar picture with the SetBarPicture function, and mix the bar picture to the bar color with the SetBarOpacity function.
Load variables	String : Your color (format : 'x,x,x' )	Integer : N/A
Return variables	String : N/A	Integer : N/A

SetBarPicture back to top
Description	Sets the picture of the VU bar.
Usage	path$ = '<Embedded>\MyPicture.jpg' PluginSet("PlugIn","path$") PluginRun("PlugIn","SetBarPicture")
Comment	The default bar is a red solid color. You can define a custom bar picture with this function. The accepted filetypes are *.bmp, *.jpg, *.wmf and the common MMB placeholders are supported (<Src Dir>, <Windows>, <System>, <Embedded>). You can define a bar color with the SetBarColor function and mix the bar picture to the bar color with the SetBarOpacity function..
Load variables	String : The path to your background picture.	Integer : N/A
Return variables	String : N/A	Integer : N/A

SetBarOpacity back to top
Description	Sets the mixing amount of bar color and bar bitmap.
Usage	opacity = 50 PluginSet("PlugIn","opacity") PluginRun("PlugIn","SetBarOpacity")
Comment	The opacity of the bitmap is defined by an integer value. 255 means opaque (only the bitmap is visible), and 0 is totally transparent (only the bar color is visible). You can define a bar picture with the SetBarPicture function, and a bar color with the SetBarColor function.
Load variables	String : N/A	Integer : the mixing amount
Return variables	String : N/A	Integer : N/A

StartVU back to top
Description	Starts the VU with current line.
Usage	PluginRun("PlugIn","StartVU")
Comment	The default line is the last autodetected line, so if you are not sure that this is the one you want you have to check the auctual line with the GetActualLine command first or specify the line with the SetLine function. You can stop the VU with the StopVU function.
Load variables	String : N/A	Integer : N/A
Return variables	String : N/A	Integer : N/A

StopVU back to top
Description	Stops the VU.
Usage	PluginRun("PlugIn","StopVU")
Comment	The VU is stopped and the VU-bar is automatically reset to 0 (invisible). You can start the VU again with the StartVU function.
Load variables	String : N/A	Integer : N/A
Return variables	String : N/A	Integer : N/A

VerticalBar back to top
Description	Sets the VU orientation to vertical
Usage	PluginRun("PlugIn","VerticalBar")
Comment	In vertical mode, the minimum is at the bottom of the plugin window and the maximum at the top of the plugin window. Vertical is default. You can set the VU orientation to horizontal with the HorizontalBar function.
Load variables	String : N/A	Integer : N/A
Return variables	String : N/A	Integer : N/A

HorizontalBar back to top
Description	Sets the VU orientation to horizontal.
Usage	PluginRun("PlugIn","HorizontalBar")
Comment	In horizontal mode, the minimum is at the left of the plugin window and the maximum at the right of the plugin window. Vertical is default. You can set the VU orientation to vertical with the VerticalBar function.
Load variables	String : N/A	Integer : N/A
Return variables	String : N/A	Integer : N/A

SetRightChannel back to top
Description	Configures the VU channel to right.
Usage	PluginRun("PlugIn","SetRightChannel")
Comment	The left channel is default You can set the VU channel to right with the SetLeftChannel function.
Load variables	String : N/A	Integer : N/A
Return variables	String : N/A	Integer : N/A

SetLeftChannel back to top
Description	Configures the VU channel to left.
Usage	PluginRun("PlugIn","SetLeftChannel")
Comment	The left channel is default You can set the VU channel to right with the SetRightChannel function.
Load variables	String : N/A	Integer : N/A
Return variables	String : N/A	Integer : N/A

SetSampleLength back to top
Description	Sets the mixing amount of bar color and bar bitmap.
Usage	Samples = 200 PluginSet("PlugIn","Samples") PluginRun("PlugIn","SetSampleLength")
Comment	Sets the interval in milliseconds for sampling of the sound. Default is 10ms, minimum is 1. Try to set the value to 200ms to see the result : the bar redraws itself a lot too slow. If you have problems with very big VU's and bitmaps, try to set it to a higher value than 10. You can define a bar picture with the SetBarPicture function, and a bar color with the SetBarColor function.
Load variables	String : N/A	Integer : the sample length
Return variables	String : N/A	Integer : N/A

StretchBar back to top
Description	Sets the VU bar setting to stretch mode.
Usage	PluginRun("PlugIn","StretchBar")
Comment	In StretchMode, the bitmap is stretched to fill the VU bar. That means, the entire bitmap is always visible (except on 0% sound intensity) and deformed to fit in the VU bar. The default is crop mode. You can change this setting to crop mode with the CropBar function.
Load variables	String : N/A	Integer : N/A
Return variables	String : N/A	Integer : N/A

CropBar back to top
Description	Sets the VU bar setting to crop mode.
Usage	PluginRun("PlugIn","CropBar")
Comment	In CropMode, the bitmap is cropped to fill the VU-bar. That means that the entire bitmap is only visible on 100% sound intensity. This is default. The way the bitmap is cropped is defined by the CropHigh and CropLow functions. You can change this setting to stretch mode with the StretchBar function.
Load variables	String : N/A	Integer : N/A
Return variables	String : N/A	Integer : N/A

CropHigh back to top
Description	If CropBar is set, the bitmap is cropped with the CropHighMode.
Usage	PluginRun("PlugIn","CropHigh")
Comment	In CropHighMode, the bitmap is cropped to on the maximum (upper/right) side of the VU. The picture doesn't move. The other setting is the CropLow functions. You can also change the setting to stretch mode with the StretchBar function.
Load variables	String : N/A	Integer : N/A
Return variables	String : N/A	Integer : N/A

CropLow back to top
Description	If CropBar is set, the bitmap is cropped with the CropLowMode.
Usage	PluginRun("PlugIn","CropLow")
Comment	In CropLowMode, the bitmap is cropped to on the minimum (lower/left) side of the VU. The picture does move. The other setting is the CropHigh function. You can also change the setting to stretch mode with the StretchBar function.
Load variables	String : N/A	Integer : N/A
Return variables	String : N/A	Integer : N/A

SetLine back to top
Description	Sets the current line for VU monitoring.
Usage	**Sets the wave-out line Line = 17 PluginSet("PlugIn","Line") PluginRun("PlugIn","SetLine")
Comment	Sets the current line. To know if a line is supported, use the IsLineSupported funcion and the GetAutoDetectedLines function to get all the supported lines.
Load variables	String : N/A	Integer : the line index
Return variables	String : N/A	Integer : N/A

GetAutoDetectedLines back to top
Description	Returns the lines supported by your soundcard's mixer device.
Usage	PluginRun("PlugIn","GetAutoDetectedLines") PluginGet("PlugIn","Lines$") Message("These are the lines supported by your soundcard : ","Lines$") PluginGet("PlugIn","Line17supported") if (Line17supported = 1) then Message("You can monitor the Wave-out line with the VUmeter plugin on your system.","") end if (Line17supported = 0) then Message("You can not monitor the Wave-out line with the VUmeter plugin on your system !!!","") end
Comment	Returns all the lines that can be monitored by the VU. On startup, the plugin detects all lines that can monitor the VU-level, and there can be more than appear in the windows mixer ( Sndvol32.exe), for example, the SB16 supports 3 lines (Wave-out, wave-in and voice-in). As the wave-out line will be the most commonly used, this function returns 1 in the integer variable if line 17 (wave-out) is supported. To test if a specific line is supported, you can use the IsLineSupported function.
Load variables	String : N/A	Integer : N/A
Return variables	String : A string with the supported line indexes, seperated by commas.	Integer : 1 if line 17 (wave-out) is supported, 0 if not

IsLineSupported back to top
Description	Tests if a specific line is supported.
Usage	** this example tests if the CD-out line (14) is supported MyLine = 14 PluginSet("PlugIn","MyLine") PluginRun("PlugIn","IsLineSupported") PluginGet("PlugIn","Result") if (Result = 1) then Message("You can monitor the CD-out line with the VUmeter plugin on your system.","") end if (Result = 0) then Message("You can not monitor the CD-out line with the VUmeter plugin on your system !!!","") end
Comment	Returns 1 if the line is supported and 0 if not. To get all the supported lines use the GetAutoDetectedLines function.
Load variables	String : N/A	Integer : N/A
Return variables	String : N/A	Integer : 1 if the line is supported, 0 if not

SetUserName back to top
Description	Sets the username for registration of the plugin.
Usage	UserName$ = 'Smith' PluginSet("PlugIn","UserName$") PluginRun("PlugIn","SetUserName") ** --> you have to run the RegisterKey function next.
Comment	You have to register the plugin with this function and the RegisterKey function in your startscript. You have to set the username exactly as provided in your confirmation e-mail with this function first, before setting the register key with the RegisterKey function. You don't have to be a registred user if you don't use this plugin in a commercial application. See our legal stuff section for more information about free/shareware licenses.
Load variables	String : your username	Integer :N/A
Return variables	String : N/A	Integer : N/A

RegisterKey back to top
Description	Sets the register key for registration of the plugin and registers.
Usage	** --> you have to use the SetUserName function first Key$ = 'HDKEPM36DD91' PluginSet("PlugIn","Key$") PluginRun("PlugIn","RegisterKey") PluginGet("PlugIn","Succes") Message("Registering :","Succes")
Comment	You have to register the plugin with the SetUserName and this function in your startscript. You have to set SetUserName function first, before setting the register key. The register key has to be exactly as in your confirmation e-mail. You don't have to be a registred user if you don't use this plugin in a commercial application. See our legal stuff section for more information about free/shareware licenses.
Load variables	String : Your register key	Integer :N/A
Return variables	String : N/A	Integer : 1 if succes, 0 if failed

GetActualLine back to top
Description	Returns the current line settings to MMB.
Usage	PluginRun("PlugIn","GetActualLine") PluginGet("PlugIn","Line$") PluginGet("PlugIn","Line")
Comment	The string variable returns the internal name of the line, and the integer variable returns the line index (from 0 to 19). You can get the driver's name for the line with the GetActualLineName function and the soundcard name with the GetActualDevice function.
Load variables	String : N/A	Integer : N/A
Return variables	String : the line name	Integer : the line index

GetActualLineName back to top
Description	Gets the actual line setting of the VU with the driver's definition of the line.
Usage	PluginRun("PlugIn","GetActualLineName") PluginGet("PlugIn","Line$") PluginGet("PlugIn","Line")
Comment	The string variable returns the soundcard's name for the line, and the integer variable returns the line index (from 0 to 19). Basically the same function as GetActualLine, the difference is that the returned string value contains the name that the soundcard driver defined for that line. For example with the French drivers of a SB16, the ID 17 corresponds to 'Son', and the GetActualLine function returns 'Wave-out'. You can get the internal name for the line with the GetActualLine function and the soundcard name with the GetActualDevice function.
Load variables	String : N/A	Integer : N/A
Return variables	String : the line name	Integer : the line index

GetActualDevice back to top
Description	Returns the device name to MMB.
Usage	PluginRun("PlugIn","GetActualDevice") PluginGet("PlugIn","Device$")
Comment	Gives you the name of the current device (string variable); You can get the driver's name for the line with the GetActualLineName function and the internal name with the GetActualLine function.
Load variables	String : N/A	Integer : N/A
Return variables	String : the device name	Integer : N/A