Get Live

Monitor

Toggle audio monitoring

put/v1/monitor

Enables 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/json
  • enabledbooleanRequired

    Whether to enable audio monitoring

Responses

200Monitor setting updated
  • okbooleanRequired
  • enabledbooleanRequired

    The saved monitoring setting

  • monitorDevicestring or null

    The device you hear yourself on, or null when monitoring is off

  • statusEngineStatus

    The voice changer status after an action

    5 child fields
    • statestringRequired

      Current state of the voice changer

      One ofidlestartingrunningstoppingerror
    • messagestringRequired
    • startedAtinteger or null

      When the current run started, in milliseconds since the Unix epoch

    • updatedAtinteger

      When this status was set, in milliseconds since the Unix epoch

    • latencyMsinteger or null

      How 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 null

    Why the running engine could not switch; null when ok is true

400Invalid request body, or the running engine could not switch monitoring
  • errorstringRequired

    Error message

401Invalid or missing API key
  • errorstringRequired

    Error message