Get Live

Control

Stop the voice changer

post/v1/stop

Stops the voice changer. If it is already stopped, returns the current status.

Responses

200Voice changer stopped successfully
  • okbooleanRequired
  • 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.

  • statestring

    Only when Start is refused because no voice is selected

    One ofidlestartingrunningstoppingerror
  • errorstring or null

    Why the action failed; null or absent when ok is true

400Failed to stop
  • okbooleanRequired
  • 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.

  • statestring

    Only when Start is refused because no voice is selected

    One ofidlestartingrunningstoppingerror
  • errorstring or null

    Why the action failed; null or absent when ok is true

401Invalid or missing API key
  • errorstringRequired

    Error message