Reference Script Functions Voicemod

Voicemod script functions

Also on the Cuebot Docs site.

Functions for C# (Cb.Call) and Python (cb.call). See Script functions for how to use them.

voicemod.getCurrentVoice

Asks Voicemod which voice is on right now.

Gives back: id and name of the current voice.

C#

var answer = await Cb.Call("voicemod.getCurrentVoice");

Python

answer = cb.call("voicemod.getCurrentVoice")

voicemod.getSounds

Lists all the sounds on your Voicemod soundboard.

Gives back: A list of sounds. Each has name and fileName.

C#

var answer = await Cb.Call("voicemod.getSounds");

Python

answer = cb.call("voicemod.getSounds")

voicemod.getState

Tells you the last known state of one Voicemod switch. It does not ask Voicemod again.

Value	What to put in
switch	Which switch: "VoiceChanger", "HearMyself", "BackgroundEffects" or "MuteMic".

Gives back: true for on, false for off, or null when Cuebot does not know yet. Fails with an error for any other switch name.

C#

var answer = await Cb.Call("voicemod.getState", new Dictionary<string, object?> { ["switch"] = "VoiceChanger" });

Python

answer = cb.call("voicemod.getState", switch="VoiceChanger")

voicemod.getVoices

Lists all your Voicemod voices.

Gives back: A list of voices. Each has id, name and favorite (true when you starred it).

C#

var answer = await Cb.Call("voicemod.getVoices");

Python

answer = cb.call("voicemod.getVoices")

voicemod.isConnected

Checks whether Cuebot is connected to Voicemod right now.

Gives back: true while connected, otherwise false.

C#

var answer = await Cb.Call("voicemod.isConnected");

Python

answer = cb.call("voicemod.isConnected")

voicemod.playSound

Plays a sound from your Voicemod soundboard. Fails with an error when no sound has that name.

Value	What to put in
sound	The sound's name as Voicemod shows it, like "Air Horn", or its file name.

Gives back: The name of the sound that played.

C#

var answer = await Cb.Call("voicemod.playSound", new { sound = "Air Horn" });

Python

answer = cb.call("voicemod.playSound", sound="Air Horn")

voicemod.randomVoice

Switches Voicemod to a random voice.

Value	What to put in
mode	Optional. Which voices to pick from: "AllVoices", "FreeVoices", "FavoriteVoices" or "CustomVoices". Default "AllVoices".

Gives back: true when done.

C#

var answer = await Cb.Call("voicemod.randomVoice", new { mode = "FavoriteVoices" });

Python

answer = cb.call("voicemod.randomVoice", mode="FavoriteVoices")

voicemod.selectVoice

Switches Voicemod to another voice. Fails with an error when no voice has that name or Voicemod is not connected.

Value	What to put in
voice	The voice's name as Voicemod shows it, like "Robot", or its id.

Gives back: The name of the voice that is now on.

C#

var answer = await Cb.Call("voicemod.selectVoice", new { voice = "Robot" });

Python

answer = cb.call("voicemod.selectVoice", voice="Robot")

voicemod.setBackgroundEffects

Turns Voicemod's background effects (the sounds behind some voices) on or off.

Value	What to put in
state	Optional. "On", "Off" or "Toggle" (switch). Default "Toggle".

Gives back: The new state: true for on, false for off.

C#

var answer = await Cb.Call("voicemod.setBackgroundEffects", new { state = "Off" });

Python

answer = cb.call("voicemod.setBackgroundEffects", state="Off")

voicemod.setCensorBeep

Starts or stops Voicemod's censor beep, the bleep that covers bad words.

Value	What to put in
state	Optional. "On" starts the beep, "Off" stops it. Default "On".

Gives back: true when done.

C#

var answer = await Cb.Call("voicemod.setCensorBeep", new { state = "On" });

Python

answer = cb.call("voicemod.setCensorBeep", state="On")

voicemod.setHearMyself

Turns Voicemod's "Hear myself" on or off. When it is on, you hear your changed voice in your headphones.

Value	What to put in
state	Optional. "On", "Off" or "Toggle" (switch). Default "Toggle".

Gives back: The new state: true for on, false for off.

C#

var answer = await Cb.Call("voicemod.setHearMyself", new { state = "Off" });

Python

answer = cb.call("voicemod.setHearMyself", state="Off")

voicemod.setMute

Mutes or unmutes your microphone in Voicemod.

Value	What to put in
state	Optional. "On" mutes, "Off" unmutes, "Toggle" switches. Default "Toggle".

Gives back: The new state: true when muted, false when not.

C#

var answer = await Cb.Call("voicemod.setMute", new { state = "On" });

Python

answer = cb.call("voicemod.setMute", state="On")

voicemod.setVoiceChanger

Turns the Voicemod voice changer on or off. When it is off, your normal voice is heard.

Value	What to put in
state	Optional. "On", "Off" or "Toggle" (switch). Default "Toggle".

Gives back: The new state: true for on, false for off.

C#

var answer = await Cb.Call("voicemod.setVoiceChanger", new { state = "On" });

Python

answer = cb.call("voicemod.setVoiceChanger", state="On")

voicemod.stopSounds

Stops every Voicemod soundboard sound that is playing.

Gives back: true when done.

C#

var answer = await Cb.Call("voicemod.stopSounds");

Python

answer = cb.call("voicemod.stopSounds")