0.1.6 • Published 5 months ago
voicemod v0.1.6
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)
})
Documentation
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()
: heregetUserLicense()
: heregetRotatoryVoicesRemainingTime()
: heregetVoices()
: heregetCurrentVoice()
: heregetAllSoundboard()
: heregetMemes()
: heregetBitmapMeme( id: MemeID )
: heregetBitmapVoice( id: VoiceID )
: heresetVoice( id: VoiceID )
: No Return ValueselectRandomVoice( mode: RandomVoiceSelectionID )
: No Return ValuegetHearMyselfStatus()
: heretoggleHearMyVoice()
: heregetVoiceChangerStatus()
: heretoggleVoiceChanger()
: heregetBackgroundEffectStatus()
: heretoggleBackground()
: heregetMuteMicStatus()
: heretoggleMuteMic()
: heresetBeepSound( enabled: Boolean )
: No Return ValueplayMeme( fileName: MemeName )
: No Return ValuestopAllMemeSounds()
: No Return ValuegetMuteMemeForMeStatus()
: heretoggleMuteMemeForMe()
: heresetCurrentVoiceParameter( paramName: ParameterName, paramValue: ParameterValue )
: here
Events:
licenseTypeChanged
: heregetAllSoundboard
: heregetActiveSoundboardProfile
: heregetMemes
: herevoiceLoadedEvent
: heretoggleHearMyVoice
: heretoggleVoiceChanger
: heretoggleBackground
: heretoggleMuteMic
: heretoggleMuteMemeForMe
: herevoiceParameterUpdated
: 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