Teamspeak 3 LUA Functions

Currently available TS3 clientlib functions to be called from Lua:

********** Clientlib **********

*** Common ***
ts3.getClientLibVersion() > version, error
ts3.getClientLibVersionNumber() > versionNumber, error

*** Error handling ***
ts3.getErrorMessage(errorCode) > errorMessage, error

*** Loggin ***
ts3.logMessage(logMessage, severity, channel, logID) > error

*** Preprocessor ***
ts3.getPreProcessorInfoValueFloat(serverConnectionHandlerID, ident) > result, error
ts3.getPreProcessorConfigValue(serverConnectionHandlerID, ident) > result, error
ts3.setPreProcessorConfigValue(serverConnectionHandlerID, ident, value) > error

*** Encoder ***
ts3.getEncodeConfigValue(serverConnectionHandlerID, ident) > result, error

*** Playback ***
ts3.getPlaybackConfigValueAsFloat(serverConnectionHandlerID, ident) > result, error
ts3.setPlaybackConfigValue(serverConnectionHandlerID, ident, value) > error
ts3.setClientVolumeModifier(serverConnectionHandlerID, clientID, value) > error

*** Interaction with the server
ts3.requestClientMove(serverConnectionHandlerID, clientID, newChannelID, password) > error
ts3.requestClientVariables(serverConnectionHandlerID, clientID) > error
ts3.requestClientKickFromChannel(serverConnectionHandlerID, clientID, kickReason) > error
ts3.requestClientKickFromServer(serverConnectionHandlerID, clientID, kickReason) > error
ts3.requestChannelDelete(serverConnectionHandlerID, channelID, force) > error
ts3.requestChannelMove(serverConnectionHandlerID, channelID, newChannelParentID) > error
ts3.requestSendPrivateTextMsg(serverConnectionHandlerID, message, targetClientID) > error
ts3.requestSendChannelTextMsg(serverConnectionHandlerID, message, targetChannelID) > error
ts3.requestSendServerTextMsg(serverConnectionHandlerID, message) > error
ts3.requestConnectionInfo(serverConnectionHandlerID, clientID) > error
ts3.requestChannelSubscribe(serverConnectionHandlerID, channelIDArray) > error
ts3.requestChannelUnsubscribe(serverConnectionHandlerID, channelIDArray) > error
ts3.requestChannelSubscribeAll(serverConnectionHandlerID) > error
ts3.requestChannelUnsubscribeAll(serverConnectionHandlerID) > error
ts3.requestChannelDescription(serverConnectionHandlerID, channelID) > error
ts3.requestMuteClients(serverConnectionHandlerID, clientIDArray) > error
ts3.requestUnmuteClients(serverConnectionHandlerID, clientIDArray) > error

*** Access clientlib information ***
*** Query own client ID ***
ts3.getClientID(serverConnectionHandlerID) > clientID, error

*** Client info ***
ts3.getClientSelfVariableAsInt(serverConnectionHandlerID, flag) > result, error
ts3.getClientSelfVariableAsString(serverConnectionHandlerID, flag) > result, error
ts3.setClientSelfVariableAsInt(serverConnectionHandlerID, flag, value) > error
ts3.setClientSelfVariableAsString(serverConnectionHandlerID, flag, value) > error
ts3.flushClientSelfUpdates(serverConnectionHandlerID) > error
ts3.getClientVariableAsInt(serverConnectionHandlerID, clientID, flag) > result, error
ts3.getClientVariableAsUInt64(serverConnectionHandlerID, clientID, flag) > result, error
ts3.getClientVariableAsString(serverConnectionHandlerID, clientID, flag) > result, error
ts3.getClientList(serverConnectionHandlerID) > clientsList, error
ts3.getChannelOfClient(serverConnectionHandlerID, clientID) > channelID, error

*** Client connection info
ts3.getConnectionStatus(serverConnectionHandlerID) > result, error
ts3.getConnectionVariableAsUInt64(serverConnectionHandlerID, clientID, flag) > result, error
ts3.getConnectionVariableAsDouble(serverConnectionHandlerID, clientID, flag) > result, error
ts3.getConnectionVariableAsString(serverConnectionHandlerID, clientID, flag) > result, error
ts3.cleanUpConnectionInfo(serverConnectionHandlerID, clientID) > error

*** Channel info ***
ts3.getChannelVariableAsInt(serverConnectionHandlerID, channelID, flag) > result, error
ts3.getChannelVariableAsString(serverConnectionHandlerID, channelID, flag) > result, error
ts3.getChannelIDFromChannelNames(serverConnectionHandlerID, channelNames) > channelID, error
ts3.setChannelVariableAsInt(serverConnectionHandlerID, channelID, flag, value) > error
ts3.setChannelVariableAsString(serverConnectionHandlerID, channelID, flag, value) > error
ts3.flushChannelUpdates(serverConnectionHandlerID, channelID) > error
ts3.flushChannelCreation(serverConnectionHandlerID, channelParentID) > error
ts3.getChannelList(serverConnectionHandlerID) > channelList, error
ts3.getChannelClientList(serverConnectionHandlerID, channelID) > clientList, error
ts3.getParentChannelOfChannel(serverConnectionHandlerID, channelID) > parentChannelID, error

*** Server info ***
ts3.getServerConnectionHandlerList() > serverConnectionHandlerIDList, error
ts3.getServerVariableAsInt(serverConnectionHandlerID, flag) > result, error
ts3.getServerVariableAsUInt64(serverConnectionHandlerID, flag) > result, error
ts3.getServerVariableAsString(serverConnectionHandlerID, flag) > result, error
ts3.requestServerVariables(serverConnectionHandlerID) > error

********** Clientlib rare **********

*** Sound ***
ts3.playWaveFile(serverConnectionHandlerID, path) > error

*** Client related ***
ts3.requestClientEditDescription(serverConnectionHandlerID, clientID, clientDescription) > error

*** Interacting with the server - general ***
ts3.requestClientPoke(serverConnectionHandlerID, clientID, message) > error
ts3.requestServerTemporaryPasswordAdd(serverConnectionHandlerID, password, description, duration, targetChannelID, targetChannelPW, returnCode) > error
ts3.requestServerTemporaryPasswordDel(serverConnectionHandlerID, password, returnCode) > error
ts3.requestServerTemporaryPasswordList(serverConnectionHandlerID, returnCode) > error

*** Interacting with the server - banning ***
ts3.banclient(serverConnectionHandlerID, clientID, timeInSeconds, banReason) > error
ts3.banclientdbid(serverConnectionHandlerID, clientDBID, timeInSeconds, banReason) > error
ts3.banadd(serverConnectionHandlerID, ipRegExp, nameRegexp, uniqueIdentity, timeInSeconds, banReason) > error
ts3.bandel(serverConnectionHandlerID, banID) > error
ts3.bandelall(serverConnectionHandlerID) > error
ts3.requestBanList(serverConnectionHandlerID) > error

*** Interacting with the server - complain ***
ts3.requestComplainAdd(serverConnectionHandlerID, targetClientDatabaseID, complainReason) > error
ts3.requestComplainDel(serverConnectionHandlerID, targetClientDatabaseID, fromClientDatabaseID) > error
ts3.requestComplainDelAll(serverConnectionHandlerID, targetClientDatabaseID) > error
ts3.requestComplainList(serverConnectionHandlerID, targetClientDatabaseID) > error

********** Client functions **********

ts3.getAppPath() > appPath
ts3.getResourcesPath() > resourcesPath
ts3.getConfigPath() > configPath
ts3.getPluginPath() > pluginPath
ts3.getCurrentServerConnectionHandlerID() > serverConnectionHandlerID
ts3.printMessage(serverConnectionHandlerID, message, pluginMessageTargetMode)
ts3.printMessageToCurrentTab(message)
ts3.urlsToBB(textWithURLs) > bbCodeText
ts3.sendPluginCommand(serverConnectionHandlerID, command, targetMode, targetIDsArray) > error
ts3.getDirectories(path) > result
ts3.setPluginMenuEnabled(menuID, enabled)
ts3.getClientDisplayName(serverConnectionHandlerID, clientID) > displayName, error
ts3.getPermissionIDByName(serverConnectionHandlerID, permissionName) > permissionID, error
ts3.getClientNeededPermission(serverConnectionHandlerID, permissionName) > result, error
ts3.guiConnect(connectTab, serverLabel, serverAddress, serverPassword, nickname, channel, channelPassword, captureProfile, playbackProfile, hotkeyProfile, soundProfile, userIdentity, oneTimeKey, phoneticName) > scHandlerID, error
ts3.createBookmark(bookmarkuuid, serverLabel, serverAddress, serverPassword, nickname, channel, channelPassword, captureProfile, playbackProfile, hotkeyProfile, soundProfile, userIdentity, oneTimeKey, phoneticName) > error