Quick start

To use VMR.ahk in your script, follow one of the following methods:

ahkpm installation

1. Install and set up ahkpm
2. Run ahkpm install gh:SaifAqqad/VMR.ahk
3. Include VMR in your script by running ahkpm include gh:SaifAqqad/VMR.ahk -f myScript.ahk

Manual Installation

1. Download the latest pre-built version from the dist folder / latest release or follow the build instructions below
2. Include it using #Include VMR.ahk or copy it to a library folder and use #Include <VMR>

!> The current version of VMR only supports AHK v2, the AHK v1 version is still available on the v1 branch, see v1 docs.

Basic usage

• Create an instance of the VMR class and log in to the API:

  voicemeeter := VMR().Login()

• The VMR instance will have two arrays (Bus and Strip), as well as other properties/methods that will allow you to control voicemeeter in AHK

  voicemeeter.Bus[1].mute := true
  voicemeeter.Strip[4].gain++

Build instructions

To build VMR.ahk, either run the vscode task Build VMR or run the build script using ahkpm or manually:

# ahkpm
ahkpm run build
# Manually
Autohotkey.exe ".\Build.ahk" ".\VMR.ahk" "..\dist\VMR.ahk" "<version number>"

_{This documentation is for VMR.ahk, If you need help with the Voicemeeter API check out their documentation}