Control
Start the voice changer
/v1/startStarts the voice changer using the currently configured audio devices and voice model. If it is already running, this is a no-op that returns the current status.
Responses
200Voice changer started successfully
okbooleanRequiredstatusEngineStatusThe 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.
statestringOnly when Start is refused because no voice is selected
One ofidlestartingrunningstoppingerrorerrorstring or nullWhy the action failed; null or absent when
okistrue
400Failed to start, e.g. no voice selected yet or the engine could not start
okbooleanRequiredstatusEngineStatusThe 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.
statestringOnly when Start is refused because no voice is selected
One ofidlestartingrunningstoppingerrorerrorstring or nullWhy the action failed; null or absent when
okistrue
401Invalid or missing API key
errorstringRequiredError message