Skip to content

Latest commit

 

History

History
48 lines (37 loc) · 1.83 KB

README.md

File metadata and controls

48 lines (37 loc) · 1.83 KB
Raw

VMR.ahk

AutoHotkey wrapper class for Voicemeeter Remote API.

Getting Started

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

A. 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
    Replace myScript.ahk with your script's path

B. 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>

Important

The current version of VMR only supports AHK v2, The AHK v1 version is still available on the v1 branch but will (probably) not receive any updates.

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++
    For more info, check out the documentation and the examples

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>"