Monitor
Toggle audio monitoring
/v1/monitorEnables or disables audio monitoring (hear yourself) and saves the setting. Uses the monitor device chosen in the desktop app. While the voice changer is running the change applies right away, otherwise on the next start.
Request body
application/jsonenabledbooleanRequiredWhether to enable audio monitoring
Responses
200Monitor setting updated
okbooleanRequiredenabledbooleanRequiredThe saved monitoring setting
monitorDevicestring or nullThe device you hear yourself on, or null when monitoring is off
statusEngineStatusThe voice changer status after an action
5 child fields
statestringRequiredCurrent state of the voice changer
One ofidlestartingrunningstoppingerrormessagestringRequiredstartedAtinteger or nullWhen the current run started, in milliseconds since the Unix epoch
updatedAtintegerWhen this status was set, in milliseconds since the Unix epoch
latencyMsinteger or nullHow far the changed voice lags behind your microphone, in milliseconds: the measured end-to-end delay, smoothed and rounded to 10 ms. Null while the voice changer isn't running. Delay your camera by this much (for example with a video delay filter in OBS) to keep it in sync with your voice.
errorstring or nullWhy the running engine could not switch; null when
okistrue
400Invalid request body, or the running engine could not switch monitoring
errorstringRequiredError message
401Invalid or missing API key
errorstringRequiredError message