Skip to content

phaze-the-dumb/voicemod-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VoiceMod API

Install:

npm i voicemod

Usage:

const { VoiceMod } = require('voicemod');

let vm = new VoiceMod();

vm.init().then(async () => {
  console.log('UserID: ' + vm.user.id)
})

Internal Methods

Note: these are mainly for developer reference purposes, but you can access them through vm.internal.APIMETHOD() if you need to

Methods:

  • getUser(): here
  • getUserLicense(): here
  • getRotatoryVoicesRemainingTime(): here
  • getVoices(): here
  • getCurrentVoice(): here
  • getAllSoundboard(): here
  • getMemes(): here
  • getBitmapMeme( id: MemeID ): here
  • getBitmapVoice( id: VoiceID ): here
  • setVoice( id: VoiceID ): No Return Value
  • selectRandomVoice( mode: RandomVoiceSelectionID ): No Return Value
  • getHearMyselfStatus(): here
  • toggleHearMyVoice(): here
  • getVoiceChangerStatus(): here
  • toggleVoiceChanger(): here
  • getBackgroundEffectStatus(): here
  • toggleBackground(): here
  • getMuteMicStatus(): here
  • toggleMuteMic(): here
  • setBeepSound( enabled: Boolean ): No Return Value
  • playMeme( fileName: MemeName ): No Return Value
  • stopAllMemeSounds(): No Return Value
  • getMuteMemeForMeStatus(): here
  • toggleMuteMemeForMe(): here
  • setCurrentVoiceParameter( paramName: ParameterName, paramValue: ParameterValue ): here

Events:

  • licenseTypeChanged: here
  • getAllSoundboard: here
  • getActiveSoundboardProfile: here
  • getMemes: here
  • voiceLoadedEvent: here
  • toggleHearMyVoice: here
  • toggleVoiceChanger: here
  • toggleBackground: here
  • toggleMuteMic: here
  • toggleMuteMemeForMe: here
  • voiceParameterUpdated: No Mention of it in the API reference but it is mentioned here

Types:

  • MemeID: ID of the meme sound
  • VoiceID: ID of the voice
  • RandomVoiceSelectionID: Can be one of "AllVoices", "FreeVoices", "FavoriteVoices", "CustomVoices"
  • MemeName: Name of the meme
  • ParameterName: Name of the voice parameter
  • ParameterValue: An object containing: value: Number

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published