Voicemeeter
The Voicemeeter Remote interface.
Fields
WindowClass
The window class of the Voicemeeter main window. This is intended to be used with AutoHotkey window functions.
Type: String
Static Methods
Call
Constructs a new Voicemeeter instance. This loads the Voicemeeter Remote DLL and logs in to the server.
Syntax
Vmr := Voicemeeter()
Vmr := Voicemeeter.Call()
Methods
BuildParamString
Builds a string containing a script from a list of strings containing script statements for SetParameters.
Syntax
ParamString := Vmr.BuildParamString(Value1 [, Value2, ..., ValueN])
Parameters
Value: String-
A string containing a script for SetParameters.
Returns: String
A string containing each of the provided scripts.
GetInputDeviceCount
Get the number of input devices available on the system.
Syntax
Value := Vmr.GetInputDeviceCount()
Returns: Integer
The number of input devices.
GetInputDeviceDescriptor
Get an input device descriptor.
Syntax
Value := Vmr.GetInputDeviceDescriptor(Index)
Parameters
Index: Integer-
The zero-based index of the device descriptor.
Returns: Voicemeeter.DeviceDescriptor
The device descriptor for the given index.
GetInputDeviceDescriptors
Get all input device descriptors.
Syntax
Value := Vmr.GetInputDeviceDescriptors()
Returns: Voicemeeter.DeviceDescriptor[]
An array containing all input device descriptors.
GetOutputDeviceCount
Get the number of output devices available on the system.
Syntax
Value := Vmr.GetOutputDeviceCount()
Returns: Integer
The number of output devices.
GetOutputDeviceDescriptor
Get an output device descriptor.
Syntax
Value := Vmr.GetOutputDeviceDescriptor(Index)
Parameters
Index: Integer-
The zero-based index of the device descriptor.
Returns: Voicemeeter.DeviceDescriptor
The device descriptor for the given index.
GetOutputDeviceDescriptors
Get all output device descriptors.
Syntax
Value := Vmr.GetOutputDeviceDescriptors()
Returns: Voicemeeter.DeviceDescriptor[]
An array containing all output device descriptors.
GetParameterFloat
Get a parameter value as a floating point number.
Syntax
Value := Vmr.GetParameterFloat(ParamName)
Parameters
ParamName: String-
The name of the parameter.
Returns: Float
The value of the parameter.
GetParameterString
Get a parameter value as a string.
Syntax
Value := Vmr.GetParameterString(ParamName)
Parameters
ParamName: String-
The name of the parameter.
Returns: String
The value of the parameter.
GetVoicemeeterType
Get the Voicemeeter type.
Syntax
VoicemeeterType := Vmr.GetVoicemeeterType()
Returns: Integer
An integer representing the type of Voicemeeter.
GetVoicemeeterVersion
Get the Voicemeeter version.
Syntax
Version := Vmr.GetVoicemeeterVersion()
Returns: Integer
An integer representing the Voicemeeter version.
HideVoicemeeterWindow
Hide the Voicemeeter window.
Syntax
Vmr.HideVoicemeeterWindow()
IsParametersDirty
Check if parameters have changed. Call this function periodically (typically every 10 or 20ms).
Syntax
ParametersChanged := Vmr.IsParametersDirty()
Returns: Integer
1 (true) if parameters have changed, otherwise 0 (false).
SetParameterFloat
Set a floating point parameter value.
Syntax
Vmr.SetParameterFloat(ParamName, Value)
Parameters
SetParameterString
Set a string parameter value.
Syntax
Vmr.SetParameterString()
Parameters
SetParameters
Set one or several parameters by a script.
Syntax
Vmr.SetParameters()
Parameters
Params: String-
A string containing the script.
ShowVoicemeeterWindow
Show and activate the Voicemeeter window.
Syntax
Vmr.ShowVoicemeeterWindow()
ToggleVoicemeeterWindow
Toggles the Voicemeeter window between shown and hidden. If the window is hidden or inactive, shows and activates the window, otherwise hides the window.
Syntax
Vmr.ToggleVoicemeeterWindow()