Module ts3lib
[hide private]
[frames] | no frames]

Module ts3lib

source code

Functions [hide private]
string
getPluginID()
Returns pyTSon's plugin id
source code
tuple(int, list[int])
acquireCustomPlaybackData(deviceName, samples)
Retrieves playback data from the clientlib
source code
int
activateCaptureDevice(serverConnectionHandlerID)
Activates the capture device on a serverconnection.
source code
int
banadd(serverConnectionHandlerID, ipRegExp, nameRegexp, uniqueIdentity, timeInSeconds, banReason, returnCode)
Adds a new ban.
source code
int
banclient(serverConnectionHandlerID, clientID, timeInSeconds, banReason, returnCode)
Returns: the errorcode
source code
int
banclientdbid(serverConnectionHandlerID, clientDBID, timeInSeconds, banReason, returnCode)
Bans a user defined by his database ID.
source code
int
bandel(serverConnectionHandlerID, banID, returnCode)
Deletes a ban.
source code
int
bandelall(serverConnectionHandlerID, returnCode)
Deletes all bans on a server.
source code
tuple (int, int)
channelPropertyStringToFlag(channelPropertyString)
Converts a channel property name used in strings (eg the serverquery) to the corresponding flag.
source code
int
channelset3DAttributes(serverConnectionHandlerID, clientID, position)
Adjusts a clients position and velocity in 3D space.
source code
int
cleanUpConnectionInfo(serverConnectionHandlerID, clientID)
//FIXME:
source code
int
clientChatClosed(serverConnectionHandlerID, clientUniqueIdentifier, clientID, returnCode)
Sends the client chat closed command to a client the own client is currently chatting with.
source code
int
clientChatComposing(serverConnectionHandlerID, clientID, returnCode)
Sends the client chat composing command to a client the own client is currently chatting with.
source code
tuple (int, int)
clientPropertyStringToFlag(clientPropertyString)
Converts a client property name used in strings (eg the serverquery) to the corresponding flag.
source code
int
closeCaptureDevice(serverConnectionHandlerID)
Closes a capture device on a serverconnection.
source code
int
closePlaybackDevice(serverConnectionHandlerID)
Closes a playback device on a serverconnection.
source code
int
closeWaveFileHandle(serverConnectionHandlerID, waveHandle)
Closes a wavefile sound handle previously returned by playWaveFileHandle.
source code
int
createBookmark(bookmarkuuid, serverLabel, serverAddress, serverPassword, nickname, channel, channelPassword, captureProfile, playbackProfile, hotkeyProfile, soundProfile, uniqueUserId, oneTimeKey, phoneticName)
Creates a new bookmark.
source code
string
createReturnCode(maxLen=128)
Creates a returnCode which can be passed to the other functions and will be passed to the event onServerErrorEvent.
source code
int
destroyServerConnectionHandler(serverConnectionHandlerID)
Destroys a server connection handler.
source code
int
flushChannelCreation(serverConnectionHandlerID, channelParentID, returnCode)
Flushes the channel creation made by the setChannelVariable-functions to the server.
source code
int
flushChannelUpdates(serverConnectionHandlerID, channelID, returnCode)
Flushes the changes made by the setChannelVariable-functions to the server.
source code
int
flushClientSelfUpdates(serverConnectionHandlerID, returnCode)
Flushes the changes made by the setClientSelfVariable-functions to the server.
source code
string
getAppPath(maxLen=256)
Returns the ts3 application path.
source code
tuple (int, string)
getAvatar(serverConnectionHandlerID, clientID, maxLen=256)
Returns the path on the system to the avatar image file of a client.
source code
tuple (int, float)
getAverageTransferSpeed(transferID)
Returns the average transfer speed of a filetransfer.
source code
tuple (int, [tuple (string, int or bool, string or None, [childs])])
getBookmarkList()
Returns the list of bookmarks.
source code
tuple (int, [(string, string)])
getCaptureDeviceList(modeID)
Queries all available capture devices.
source code
tuple (int, [string])
getCaptureModeList()
Queries all available capture modes.
source code
tuple (int, [int]) or tuple(int, None)
getChannelClientList(serverConnectionHandlerID, channelID)
Returns all clients in a specified channel.
source code
tuple (int, string, string)
getChannelConnectInfo(serverConnectionHandlerID, channelID, maxLen)
Returns the channel connect info (path and password) of a channel.
source code
tuple (int, int)
getChannelIDFromChannelNames(serverConnectionHandlerID, channelNameArray)
Returns the ID of a channel defined by its name.
source code
tuple (int, [int])
getChannelList(serverConnectionHandlerID)
Returns all channels on the server.
source code
tuple (int, int)
getChannelOfClient(serverConnectionHandlerID, clientID)
Returns the channel of a client.
source code
tuple (int, int)
getChannelVariableAsInt(serverConnectionHandlerID, channelID, flag)
Returns a channel variable as int value.
source code
tuple (int, int)
getChannelVariableAsString(serverConnectionHandlerID, channelID, flag)
Returns a channel variable as string value.
source code
tuple (int, int)
getChannelVariableAsUInt64(serverConnectionHandlerID, channelID, flag)
Returns a channel variable as unsigned long long int value.
source code
tuple (int, string)
getClientDisplayName(serverConnectionHandlerID, clientID, maxLen=128)
Returns the client display name receiving from the client's contacts settings.
source code
tuple (int, int)
getClientID(serverConnectionHandlerID)
Returns the own client ID on a given serverconnection.
source code
tuple (int, string)
getClientLibVersion()
Returns the clientlib's version as string.
source code
tuple (int, int)
getClientLibVersionNumber()
Returns the clientlib's version number
source code
tuple (int, [int])
getClientList(serverConnectionHandlerID)
Returns all clients in view on the server.
source code
tuple (int, int)
getClientNeededPermission(serverConnectionHandlerID, permissionName)
Returns the value of the client's needed permission.
source code
tuple (int, int)
getClientSelfVariableAsInt(serverConnectionHandlerID, flag)
Returns the value of a given flag of the own client as int value.
source code
tuple (int, string)
getClientSelfVariableAsString(serverConnectionHandlerID, flag)
Returns the value of a given flag of the own client as string.
source code
tuple (int, int)
getClientVariableAsInt(serverConnectionHandlerID, clientID, flag)
Returns the value of a given flag of a client as int value.
source code
tuple (int, string)
getClientVariableAsString(serverConnectionHandlerID, clientID, flag)
Returns the value of a given flag of a client as string value.
source code
tuple (int, int)
getClientVariableAsUInt64(serverConnectionHandlerID, clientID, flag)
Returns the value of a given flag of a client as unsigned long long int value.
source code
string
getConfigPath(maxLen=256)
Returns the ts3 config path.
source code
tuple (int, int)
getConnectionStatus(serverConnectionHandlerID)
Returns the current connection status of a serverconnection.
source code
tuple (int, double)
getConnectionVariableAsDouble(serverConnectionHandlerID, clientID, flag)
Returns a client's connection variable as python floating point variable.
source code
tuple (int, string)
getConnectionVariableAsString(serverConnectionHandlerID, clientID, flag)
Returns a client's connection variable as string variable.
source code
tuple (int, int)
getConnectionVariableAsUInt64(serverConnectionHandlerID, clientID, flag)
Returns a client's connection variable as unsigned long long int variable.
source code
tuple (int, string, int)
getCurrentCaptureDeviceName(serverConnectionHandlerID)
Queries the current playback device's name on a serverconnection.
source code
tuple (int, string)
getCurrentCaptureMode(serverConnectionHandlerID)
Queries the current capture mode on a serverconnection.
source code
tuple (int, string, int)
getCurrentPlaybackDeviceName(serverConnectionHandlerID)
Queries the current playback device's name on a serverconnection.
source code
tuple (int, string)
getCurrentPlayBackMode(serverConnectionHandlerID)
Queries the current playback mode on a serverconnection.
source code
int
getCurrentServerConnectionHandlerID()
Returns the current serverconnection handler.
source code
tuple (int, float)
getCurrentTransferSpeed(transferID)
Returns the current transfer speed of a filetransfer.
source code
tuple (int, (string, string))
getDefaultCaptureDevice(modeID)
Queries the default capture device.
source code
tuple (int, string)
getDefaultCaptureMode()
Queries the default capture mode.
source code
tuple (int, (string, string))
getDefaultPlaybackDevice(modeID)
Queries the default playback device.
source code
tuple (int, string)
getDefaultPlayBackMode()
Queries the default playback mode.
source code
string
getDirectories(path, maxLen=256)
Returns a list of subdirectories of a path as space-separated string.
source code
tuple (int, string)
getEncodeConfigValue(serverConnectionHandlerID, ident)
Queries a speex encoder option.
source code
tuple (int, string)
getErrorMessage(errorCode)
Queries a printable error string for a specific error code.
source code
tuple(int, list[str])
getHotkeyFromKeyword(keywords)
Returns a list of hotkeys by its keywords.
source code
tuple (int, int)
getParentChannelOfChannel(serverConnectionHandlerID, channelID)
Returns the parent channel of another channel.
source code
tuple (int, int)
getPermissionIDByName(serverConnectionHandlerID, permissionName)
Returns the ID of a permission defined by its name.
source code
tuple (int, float)
getPlaybackConfigValueAsFloat(serverConnectionHandlerID, ident)
Queries a playback option.
source code
tuple (int, [(string, string)])
getPlaybackDeviceList(modeID)
Queries all available playback devices.
source code
tuple (int, [string])
getPlaybackModeList()
Queries all available playback modes.
source code
str
getPluginPath(maxLen)
Returns the TeamSpeak 3 client's pluginpath.
source code
tuple (int, string)
getPreProcessorInfoValue(serverConnectionHandlerID, ident)
Querie a sound preprocessor flag and returns it as string.
source code
tuple (int, float)
getPreProcessorInfoValueFloat(serverConnectionHandlerID, ident)
Queries a sound preprocessor flag and returns it as float.
source code
tuple (int, int, [string])
getProfileList(profile)
Returns a list of existing profiles and the default profile's index in list.
source code
string
getResourcesPath(maxLen=256)
Returns the ts3 resources path.
source code
tuple (int, string, int, string)
getServerConnectInfo(serverConnectionHandlerID, maxLen=256)
Returns the connect info (host, port and password) of a serverconnection.
source code
tuple (int, [int])
getServerConnectionHandlerList()
Returns a list of serverconnection handlers.
source code
tuple (int, int)
getServerVariableAsInt(serverConnectionHandlerID, flag)
Returns a server variable as int value.
source code
tuple (int, string)
getServerVariableAsString(serverConnectionHandlerID, flag)
Returns a server variable as string value.
source code
tuple (int, int)
getServerVariableAsUInt64(serverConnectionHandlerID, flag)
Returns a server variable as unsigned long long int value.
source code
int
getServerVersion(serverConnectionHandlerID)
Returns the server version.
source code
tuple (int, string)
getTransferFileName(transferID)
Returns the filename of a filetransfer.
source code
tuple (int, string)
getTransferFilePath(transferID)
Returns the filepath of a filetransfer.
source code
tuple (int, int)
getTransferFileSize(transferID)
Returns the total filesize (in Bytes) of a filetransfer.
source code
tuple (int, int)
getTransferFileSizeDone(transferID)
Returns the already downloaded size (in Bytes) of a filetransfer.
source code
tuple (int, int)
getTransferRunTime(transferID)
Returns the runtime of a filetransfer.
source code
tuple (int, int)
getTransferStatus(transferID)
Returns the status of a filetransfer, whether if it is initialising, active or finished see ts3defines.FileTransferState
source code
tuple (int, int)
guiConnect(connectTab, serverLabel, serverAddress, serverPassword, nickname, channel, channelPassword, captureProfile, playbackProfile, hotkeyProfile, userIdentity, oneTimeKey, phoneticName)
Connects to a server and displays it as tab in the client.
source code
tuple (int, int)
guiConnectBookmark(connectTab, bookmarkuuid)
Connects to a server from a bookmark and displays it as tab in the client.
source code
int
haltTransfer(serverConnectionHandlerID, transferID, deleteUnfinishedFile, returnCode)
Halts a currently running filetransfer.
source code
int
initiateGracefulPlaybackShutdown(serverConnectionHandlerID)
Graceful shutdown the playback device on a serverconnection.
source code
tuple (int, int or bool)
isReceivingWhisper(serverConnectionHandlerID, clientID)
//FIXME:
source code
tuple (int, int or bool)
isTransferSender(transferID)
Returns the upload/download direction of a filetransfer.
source code
tuple (int, int or bool)
isWhispering(serverConnectionHandlerID, clientID)
Returns the status of a client whether he is currently whispering to the own client.
source code
int
logMessage(logMessage, severity, channel, logID)
Logs a string.
source code
int
openCaptureDevice(serverConnectionHandlerID, modeID, captureDevice)
Opens a playback device on a serverconnection.
source code
int
openPlaybackDevice(serverConnectionHandlerID, modeID, playbackDevice)
Opens a playback device on a serverconnection.
source code
int
pauseWaveFileHandle(serverConnectionHandlerID, waveHandle, pause)
Pauses a wavefile sound previously started with playWaveFileHandle.
source code
int
playWaveFile(serverConnectionHandlerID, path)
Plays a wavefile sound on a serverconnection.
source code
tuple (int, int)
playWaveFileHandle(serverConnectionHandlerID, path, loop)
Plays a wavefile sound on a serverconnection and returns a handle to it.
source code
 
printMessage(serverConnectionHandlerID, message, messageTarget)
Prints a message to a specific client chat tab.
source code
 
printMessageToCurrentTab(message)
Prints a message to the currently visible tab.
source code
int
privilegeKeyUse(serverConnectionHandlerID, tokenKey, returnCode)
Uses a privilege key as the current client of the serverconnection.
source code
int
processCustomCaptureData(deviceName, buffer)
Sends captured data from a custom device to the client libg
source code
int
registerCustomDevice(deviceID, deviceDisplayName, capFrequency, capChannels, playFrequency, playChannels)
Registers a custom device, announcing the device ID and name to the Client Lib.
source code
int
requestBanList(serverConnectionHandlerID, returnCode)
Requests the banlist on a server.
source code
int
requestChannelAddPerm(serverConnectionHandlerID, channelID, permissionIDArray, permissionValueArray, returnCode)
Adds a list of permissions to a channel.
source code
int
requestChannelClientAddPerm(serverConnectionHandlerID, channelID, clientDatabaseID, permissionIDArray, permissionValueArray, returnCode)
Adds a list of permissions on a channel to a user.
source code
int
requestChannelClientDelPerm(serverConnectionHandlerID, channelID, clientDatabaseID, permissionIDArray, returnCode)
Deletes a list of permissions of a user in a channel.
source code
int
requestChannelClientPermList(serverConnectionHandlerID, channelID, clientDatabaseID, returnCode)
Requests the list of permissions of a user in a channel.
source code
int
requestChannelDelete(serverConnectionHandlerID, channelID, force, returnCode)
Deletes a channel.
source code
int
requestChannelDelPerm(serverConnectionHandlerID, channelID, permissionIDArray, returnCode)
Deletes a list of permissions from a channel.
source code
int
requestChannelDescription(serverConnectionHandlerID, channelID, returnCode)
Requests the channel description of a channel.
source code
int
requestChannelGroupAdd(serverConnectionHandlerID, groupName, groupType, returnCode)
Adds a channelgroup.
source code
int
requestChannelGroupAddPerm(serverConnectionHandlerID, channelGroupID, continueonerror, permissionIDArray, permissionValueArray, returnCode)
Adds a list of permissions to a channelgroup.
source code
int
requestChannelGroupDel(serverConnectionHandlerID, channelGroupID, force, returnCode)
Deletes a channelgroup.
source code
int
requestChannelGroupDelPerm(serverConnectionHandlerID, channelGroupID, continueOnError, permissionIDArray, returnCode)
Deletes a list of permissions from a channelgroup.
source code
int
requestChannelGroupList(serverConnectionHandlerID, returnCode)
Requests the list of channelgroups.
source code
int
requestChannelGroupPermList(serverConnectionHandlerID, channelGroupID, returnCode)
Requests the list of permissions assigned to a channelgroup.
source code
int
requestChannelMove(serverConnectionHandlerID, channelID, newChannelParentID, newChannelOrder, returnCode)
Moves a channel to a new parent channel.
source code
int
requestChannelPermList(serverConnectionHandlerID, channelID, returnCode)
Requests the list of permissions assigned to a channel.
source code
int
requestChannelSubscribe(serverConnectionHandlerID, channelIDArray, returnCode)
Subscribes to a list of channels to get notifications of the clients in them.
source code
int
requestChannelSubscribeAll(serverConnectionHandlerID, returnCode)
Subscribes to all channels on the server.
source code
int
requestChannelUnsubscribe(serverConnectionHandlerID, channelIDArray, returnCode)
Unsubscribes from a list channels.
source code
int
requestChannelUnsubscribeAll(serverConnectionHandlerID, returnCode)
Unsubscribes from all channels on the server.
source code
int
requestClientAddPerm(serverConnectionHandlerID, clientDatabaseID, permissionIDArray, permissionValueArray, permissionSkipArray, returnCode)
Adds a list of permissions to a user.
source code
int
requestClientDBIDfromUID(serverConnectionHandlerID, clientUniqueIdentifier, returnCode)
Requests the database ID of a client defined by the UID.
source code
int
requestClientDelPerm(serverConnectionHandlerID, clientDatabaseID, permissionIDArray, returnCode)
Deletes a list of permissions from a user.
source code
int
requestClientEditDescription(serverConnectionHandlerID, clientID, clientDescription, returnCode)
Sets the description of a client.
source code
int
requestClientIDs(serverConnectionHandlerID, clientUniqueIdentifier, returnCode)
Requests the client IDs for a given UID.
source code
int
requestClientKickFromChannel(serverConnectionHandlerID, clientID, kickReason, returnCode)
Kicks a client from its current channel to the default one.
source code
int
requestClientKickFromServer(serverConnectionHandlerID, clientID, kickReason, returnCode)
Kicks a client from the server.
source code
int
requestClientMove(serverConnectionHandlerID, clientID, newChannelID, password, returnCode)
Moves a client to a different channel.
source code
int
requestClientNamefromDBID(serverConnectionHandlerID, clientDatabaseID, returnCode)
Requests the name of a client defined by the database ID.
source code
int
requestClientNamefromUID(serverConnectionHandlerID, clientUniqueIdentifier, returnCode)
Requests the name of a client defined by the UID.
source code
int
requestClientPermList(serverConnectionHandlerID, clientDatabaseID, returnCode)
Requests the list of permissions assigned to a user.
source code
int
requestClientPoke(serverConnectionHandlerID, clientID, message, returnCode)
Pokes a client with a given message.
source code
int
requestClientSetIsTalker(serverConnectionHandlerID, clientID, isTalker, returnCode)
Grants or revokes the talker flag of a client.
source code
int
requestClientSetWhisperList(serverConnectionHandlerID, clientID, targetChannelIDArray, targetClientIDArray, returnCode)
Modifies the whisper list of a client.
source code
int
requestClientVariables(serverConnectionHandlerID, clientID, returnCode)
Requests latest data for a given client.
source code
int
requestComplainAdd(serverConnectionHandlerID, targetClientDatabaseID, complainReason, returnCode)
Adds a complain to a user defined by his database ID.
source code
int
requestComplainDel(serverConnectionHandlerID, targetClientDatabaseID, fromClientDatabaseID, returnCode)
Deletes a complain to a user by a different user.
source code
int
requestComplainDelAll(serverConnectionHandlerID, targetClientDatabaseID, returnCode)
Deletes all complains to a user.
source code
int
requestComplainList(serverConnectionHandlerID, targetClientDatabaseID, returnCode)
Requests the list of complains to a user.
source code
int
requestConnectionInfo(serverConnectionHandlerID, clientID, returnCode)
Requests the connection info of a client.
source code
int
requestCreateDirectory(serverConnectionHandlerID, channelID, channelPW, directoryPath, returnCode)
Creates a directory in a channel.
source code
int
requestDeleteFile(serverConnectionHandlerID, channelID, channelPW, files, returnCode)
Deletes a list of files in a channel.
source code
tuple (int, int)
requestFile(serverConnectionHandlerID, channelID, channelPW, file, overwrite, resume, destinationDirectory, returnCode)
Starts a filedownload from the server.
source code
int
requestFileInfo(serverConnectionHandlerID, channelID, channelPW, file, returnCode)
Requests the info to a file in a channel.
source code
int
requestFileList(serverConnectionHandlerID, channelID, channelPW, path, returnCode)
Requests the filelist of a channel.
source code
 
requestHotkeyInputDialog(keyword, isDown, qParentWindow)
Shows the hotkeyinputdialog to set the hotkey for a hotkey keyword.
source code
int
requestInfoUpdate(serverConnectionHandlerID, itemType, itemID)
Requests to update the info data.
source code
int
requestIsTalker(serverConnectionHandlerID, isTalkerRequest, isTalkerRequestMessage, returnCode)
Requests talk power or revokes the talk power request.
source code
int
requestMessageAdd(serverConnectionHandlerID, toClientUID, subject, message, returnCode)
Sends an offline message to another user.
source code
int
requestMessageDel(serverConnectionHandlerID, messageID, returnCode)
Deletes an offline message.
source code
int
requestMessageGet(serverConnectionHandlerID, messageID, returnCode)
Requests an offline message defined by its ID.
source code
int
requestMessageList(serverConnectionHandlerID, returnCode)
Requests the list of offline messages.
source code
int
requestMessageUpdateFlag(serverConnectionHandlerID, messageID, flag, returnCode)
Sets the message read/unread flag of an offline message
source code
int
requestMuteClients(serverConnectionHandlerID, clientIDArray, returnCode)
Mutes a list of clients.
source code
int
requestPermissionList(serverConnectionHandlerID, returnCode)
Requests the list of permissions available on the server.
source code
int
requestPermissionOverview(serverConnectionHandlerID, clientDBID, channelID, returnCode)
Requests the permission overview of a user in a channel.
source code
int
requestRenameFile(serverConnectionHandlerID, fromChannelID, channelPW, toChannelID, toChannelPW, oldFile, newFile, returnCode)
Renames a file or moves it to another channel.
source code
int
requestSendChannelTextMsg(serverConnectionHandlerID, message, targetChannelID, returnCode)
Sends a text message to all clients in a channel.
source code
int
requestSendClientQueryCommand(serverConnectionHandlerID, command, returnCode)
Requests to execute a clientquery command.
source code
int
requestSendPrivateTextMsg(serverConnectionHandlerID, message, targetClientID, returnCode)
Sends a private text message to a client.
source code
int
requestSendServerTextMsg(serverConnectionHandlerID, message, returnCode)
Sends a text message to all clients on the server.
source code
int
requestServerGroupAdd(serverConnectionHandlerID, groupName, groupType, returnCode)
Adds a servergroup.
source code
int
requestServerGroupAddClient(serverConnectionHandlerID, serverGroupID, clientDatabaseID, returnCode)
Adds a user defined by his database ID to a servergroup.
source code
int
requestServerGroupAddPerm(serverConnectionHandlerID, serverGroupID, continueonerror, permissionIDArray, permissionValueArray, permissionNegatedArray, permissionSkipArray, returnCode)
Adds a list of permissions to a servergroup.
source code
int
requestServerGroupClientList(serverConnectionHandlerID, serverGroupID, withNames, returnCode)
Requests the list of clients assigned to a servergroup.
source code
int
requestServerGroupDel(serverConnectionHandlerID, serverGroupID, force, returnCode)
Deletes a servergroup.
source code
int
requestServerGroupDelClient(serverConnectionHandlerID, serverGroupID, clientDatabaseID, returnCode)
Deletes a user defined by his database ID from a servergroup.
source code
int
requestServerGroupDelPerm(serverConnectionHandlerID, serverGroupID, continueOnError, permissionIDArray, returnCode)
Deletes a list of permissions from a servergroup.
source code
int
requestServerGroupList(serverConnectionHandlerID, returnCode)
Requests the list of servergroups.
source code
int
requestServerGroupPermList(serverConnectionHandlerID, serverGroupID, returnCode)
Requests the list of permissions assigned to a servergroup.
source code
int
requestServerGroupsByClientID(serverConnectionHandlerID, clientDatabaseID, returnCode)
Requests all servergroups of a user defined by his database ID.
source code
int
requestServerTemporaryPasswordAdd(serverConnectionHandlerID, password, description, duration, targetChannelID, targetChannelPW, returnCode)
Adds a temporary password to the server.
source code
int
requestServerTemporaryPasswordDel(serverConnectionHandlerID, password, returnCode)
Deletes an existing temporary password.
source code
int
requestServerTemporaryPasswordList(serverConnectionHandlerID, returnCode)
Requests a list of existing temporary passwords.
source code
int
requestServerVariables(serverConnectionHandlerID)
Requests all server variables of a serverconnection.
source code
int
requestSetClientChannelGroup(serverConnectionHandlerID, channelGroupIDArray, channelIDArray, clientDatabaseIDArray, returnCode)
Adds a list of users to a list of channelgroups.
source code
int
requestUnmuteClients(serverConnectionHandlerID, clientIDArray, returnCode)
Unmutes a list of clients.
source code
tuple (int, int)
sendFile(serverConnectionHandlerID, channelID, channelPW, file, overwrite, resume, sourceDirectory, returnCode)
Starts a fileupload to the server.
source code
int
sendPluginCommand(serverConnectionHandlerID, command, targetMode, targetIDs, returnCode)
Sends a plugin command to other users.
source code
tuple (int, int)
serverPropertyStringToFlag(serverPropertyString)
Converts a server property name used in strings (eg the serverquery) to the corresponding flag.
source code
int
set3DWaveAttributes(serverConnectionHandlerID, waveHandle, position)
Positions a wave file that was opened previously with playWaveFileHandle in 3D space.
source code
int
setChannelVariableAsInt(serverConnectionHandlerID, channelID, flag, value)
Sets a channel variable to a new int value.
source code
int
setChannelVariableAsString(serverConnectionHandlerID, channelID, flag, value)
Sets a channel variable to a new string value.
source code
int
setChannelVariableAsUInt64(serverConnectionHandlerID, channelID, flag, value)
Sets a channel variable to a new unsigned long long int value.
source code
int
setClientSelfVariableAsInt(serverConnectionHandlerID, flag, value)
Sets a variable of the own client to a new int value.
source code
int
setClientSelfVariableAsString(serverConnectionHandlerID, flag, value)
Sets a variable of the own client to a new string value.
source code
int
setClientVolumeModifier(serverConnectionHandlerID, clientID, value)
Sets the volume modifier of a client.
source code
int
setPlaybackConfigValue(serverConnectionHandlerID, ident, value)
Sets a playback option.
source code
 
setPluginMenuEnabled(menuID, enabled)
Enables or disables a menuitem.
source code
int
setPreProcessorConfigValue(serverConnectionHandlerID, ident, value)
Sets a sound preprocessor flag.
source code
 
showHotkeySetup()
Opens the hotkey settings in the TeamSpeak 3 client's settings dialog.
source code
tuple (int, int)
spawnNewServerConnectionHandler(port)
Creates a new server connection handler and receive its ID.
source code
int
startConnection(serverConnectionHandlerID, identity, ip, port, nickname, defaultChannelArray, defaultChannelPassword, serverPassword)
Starts a connection to the given server.
source code
int
startVoiceRecording(serverConnectionHandlerID)
Sets the voice recording flag of the own client on a serverconnection.
source code
int
stopConnection(serverConnectionHandlerID, quitMessage)
Stops the connection of a serverconnection.
source code
int
stopVoiceRecording(serverConnectionHandlerID)
Removes the voice recording flag of the own client on a serverconnection
source code
int
systemset3DListenerAttributes(serverConnectionHandlerID, position, forward, up)
Sets the position, velocity and orientation of the own client in 3D space
source code
int
systemset3DSettings(serverConnectionHandlerID, distanceFactor, rolloffScale)
Adjust 3D sound system settings.
source code
int
unregisterCustomDevice(deviceID)
Unregisters a custom device, previously registered with registerCustomDevice.
source code
string
urlsToBB(text, maxLen=256)
Converts an url to the BB-code respresentation.
source code
int
verifyChannelPassword(serverConnectionHandlerID, channelID, channelPassword, returnCode)
Verifies the password to a channel.
source code
int
verifyServerPassword(serverConnectionHandlerID, serverPassword, returnCode)
Verifies the password to a server.
source code
Function Details [hide private]

getPluginID()

source code 

Returns pyTSon's plugin id

Returns: string
the plugin id

acquireCustomPlaybackData(deviceName, samples)

source code 

Retrieves playback data from the clientlib

Parameters:
  • deviceName (string) - the name of the playback device previously registered with registerCustomDevice
  • samples (int) - specifies how long the resultbuffer should be, which is passed to the clientlib
Returns: tuple(int, list[int])
a tuple containing the errorcode and the buffer as list of ints

activateCaptureDevice(serverConnectionHandlerID)

source code 

Activates the capture device on a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: int
the errorcode

banadd(serverConnectionHandlerID, ipRegExp, nameRegexp, uniqueIdentity, timeInSeconds, banReason, returnCode)

source code 

Adds a new ban.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • ipRegExp (string) - regular expression to match IPs, pass an empty string to ignore IPs
  • nameRegexp (string) - regular expression to match client nicknames, pass an empty string to ignore nicknames
  • uniqueIdentity (string) - client UID to ban, pass an empty string to ignore UIDs
  • timeInSeconds (int) - the time, the client should be banned for, pass 0 to add a permanent ban
  • banReason (string) - the reason for the ban
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

banclient(serverConnectionHandlerID, clientID, timeInSeconds, banReason, returnCode)

source code 
Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
  • timeInSeconds (int) - the time, the client should be banned for, pass 0 to add a permanent ban
  • banReason (string) - the reason for the ban
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

banclientdbid(serverConnectionHandlerID, clientDBID, timeInSeconds, banReason, returnCode)

source code 

Bans a user defined by his database ID.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientDBID (int) - the database ID of the user
  • timeInSeconds (int) - the time, the client should be banned for, pass 0 to add a permanent ban
  • banReason (string) - the reason for the ban
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

bandel(serverConnectionHandlerID, banID, returnCode)

source code 

Deletes a ban.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • banID (int) - the ID of the ban
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

bandelall(serverConnectionHandlerID, returnCode)

source code 

Deletes all bans on a server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

channelPropertyStringToFlag(channelPropertyString)

source code 

Converts a channel property name used in strings (eg the serverquery) to the corresponding flag.

Parameters:
  • channelPropertyString (string)
Returns: tuple (int, int)
a tuple, containing the errorcode and the flag (see ts3defines.ChannelProperties and ts3defines.ChannelPropertiesRare)

channelset3DAttributes(serverConnectionHandlerID, clientID, position)

source code 

Adjusts a clients position and velocity in 3D space.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client to adjust
  • position (tuple (float, float, float)) - a tuple defining the position of the clientID
Returns: int
the errorcode

cleanUpConnectionInfo(serverConnectionHandlerID, clientID)

source code 

//FIXME:

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
Returns: int
the errorcode

clientChatClosed(serverConnectionHandlerID, clientUniqueIdentifier, clientID, returnCode)

source code 

Sends the client chat closed command to a client the own client is currently chatting with.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientUniqueIdentifier (string) - the uid of the own chatting client
  • clientID (int) - the ID of the client, the own client is chatting with
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

clientChatComposing(serverConnectionHandlerID, clientID, returnCode)

source code 

Sends the client chat composing command to a client the own client is currently chatting with.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client, the own client is chatting with
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

clientPropertyStringToFlag(clientPropertyString)

source code 

Converts a client property name used in strings (eg the serverquery) to the corresponding flag.

Parameters:
  • clientPropertyString (string)
Returns: tuple (int, int)
a tuple, containing the errorcode and the flag (see ts3defines.ClientProperties and ts3defines.ClientPropertiesRare)

closeCaptureDevice(serverConnectionHandlerID)

source code 

Closes a capture device on a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: int
the errorcode

closePlaybackDevice(serverConnectionHandlerID)

source code 

Closes a playback device on a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: int
the errorcode

closeWaveFileHandle(serverConnectionHandlerID, waveHandle)

source code 

Closes a wavefile sound handle previously returned by playWaveFileHandle.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverConnection the sound was played on
  • waveHandle (int) - the handle returned by playWaveFileHandle
Returns: int
the errorcode

createBookmark(bookmarkuuid, serverLabel, serverAddress, serverPassword, nickname, channel, channelPassword, captureProfile, playbackProfile, hotkeyProfile, soundProfile, uniqueUserId, oneTimeKey, phoneticName)

source code 

Creates a new bookmark.

Parameters:
  • serverLabel (string) - the label of the connection
  • serverAddress (string) - host or ip address
  • serverPassword (string) - password to the server, pass an empty string if the server is not password protected
  • nickname (string) - the user's nickname
  • channel (string) - complete path to the channel to connect to
  • channelPassword (string) - password to the channel, pass an empty string if the channel is not password protected
  • captureProfile (string) - the name of the capture profile to use; pass an empty string to always use the default one
  • playbackProfile (string) - the name of the playback profile to use; pass an empty string to always use the default one
  • hotkeyProfile (string) - the name of the hotkey profile to use; pass an empty string to always use the default one
  • soundProfile (string) - the name of the sound profile to use; pass an empty string to always use the default one
  • uniqueUserId (string) - identity (name) to use; pass an empty string to always use the default one
  • oneTimeKey (string) - privilege key to use on connect
  • phoneticName (string) - phonetic nickname
Returns: int
the errorcode

createReturnCode(maxLen=128)

source code 

Creates a returnCode which can be passed to the other functions and will be passed to the event onServerErrorEvent.

Parameters:
  • maxLen (int) - length of the buffer, passed to the clientlib to store the path to, default value is 256
Returns: string
the created returnCode

destroyServerConnectionHandler(serverConnectionHandlerID)

source code 

Destroys a server connection handler.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: int
the errorcode

flushChannelCreation(serverConnectionHandlerID, channelParentID, returnCode)

source code 

Flushes the channel creation made by the setChannelVariable-functions to the server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelParentID (int) - the ID of the parent channel of the new channel
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

flushChannelUpdates(serverConnectionHandlerID, channelID, returnCode)

source code 

Flushes the changes made by the setChannelVariable-functions to the server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channelID
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

flushClientSelfUpdates(serverConnectionHandlerID, returnCode)

source code 

Flushes the changes made by the setClientSelfVariable-functions to the server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

getAppPath(maxLen=256)

source code 

Returns the ts3 application path.

Parameters:
  • maxLen (int) - length of the buffer, passed to the clientlib to store the path to, default value is 256
Returns: string
the application path

getAvatar(serverConnectionHandlerID, clientID, maxLen=256)

source code 

Returns the path on the system to the avatar image file of a client.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
  • maxLen (int) - length of the buffer, passed to the clientlib to store the path to, default value is 256
Returns: tuple (int, string)
a tuple, containing the errorcode and the path to the avatar

getAverageTransferSpeed(transferID)

source code 

Returns the average transfer speed of a filetransfer.

Parameters:
  • transferID (int) - the ID of the filetransfer
Returns: tuple (int, float)
a tuple, containing the errorcode and the speed

getBookmarkList()

source code 

Returns the list of bookmarks.

Returns: tuple (int, [tuple (string, int or bool, string or None, [childs])])
a tuple, containing the errorcode and a list of tuples (name, isFolder, uid, childs)

getCaptureDeviceList(modeID)

source code 

Queries all available capture devices.

Parameters:
  • modeID (string) - Defines the capture mode to use.
Returns: tuple (int, [(string, string)])
A tuple, containing the errorcode and the list of capture devices as tuple (devicename, deviceid)

getCaptureModeList()

source code 

Queries all available capture modes.

Returns: tuple (int, [string])
A tuple, containing the errorcode and the list of capture modes

getChannelClientList(serverConnectionHandlerID, channelID)

source code 

Returns all clients in a specified channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
Returns: tuple (int, [int]) or tuple(int, None)
a tuple, containing the errorcode and a list of client IDs or None if the call failed

getChannelConnectInfo(serverConnectionHandlerID, channelID, maxLen)

source code 

Returns the channel connect info (path and password) of a channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • maxLen (int) - length of the buffer, passed to the clientlib to store the path to, default value is 256
Returns: tuple (int, string, string)
a tuple, containing the errorcode, the path and the password of a channel

getChannelIDFromChannelNames(serverConnectionHandlerID, channelNameArray)

source code 

Returns the ID of a channel defined by its name.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelNameArray (list [string]) - list of strings, defining the position of the channel (['grandparent', 'parent', 'channel'])
Returns: tuple (int, int)
a tuple, containing the errorcode and the ID of the channel

getChannelList(serverConnectionHandlerID)

source code 

Returns all channels on the server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: tuple (int, [int])
a tuple, containing the errorcode and a list of channel IDs

getChannelOfClient(serverConnectionHandlerID, clientID)

source code 

Returns the channel of a client.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
Returns: tuple (int, int)
a tuple, containing the errorcode and the channel

getChannelVariableAsInt(serverConnectionHandlerID, channelID, flag)

source code 

Returns a channel variable as int value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • flag (int) - the flag to return
Returns: tuple (int, int)
a tuple, containing the errorcode and the value of the flag

getChannelVariableAsString(serverConnectionHandlerID, channelID, flag)

source code 

Returns a channel variable as string value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • flag (int) - the flag to return
Returns: tuple (int, int)
a tuple, containing the errorcode and the value of the flag

getChannelVariableAsUInt64(serverConnectionHandlerID, channelID, flag)

source code 

Returns a channel variable as unsigned long long int value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • flag (int) - the flag to return
Returns: tuple (int, int)
a tuple, containing the errorcode and the value of the flag

getClientDisplayName(serverConnectionHandlerID, clientID, maxLen=128)

source code 

Returns the client display name receiving from the client's contacts settings.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
  • maxLen (int) - length of the buffer, passed to the clientlib to store the path to, default value is 128
Returns: tuple (int, string)
a tuple, containing the errorcode and the display name

getClientID(serverConnectionHandlerID)

source code 

Returns the own client ID on a given serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: tuple (int, int)
a tuple, containing the errorcode and the client ID

getClientLibVersion()

source code 

Returns the clientlib's version as string.

Returns: tuple (int, string)
A tuple, containing the errorcode and the result

getClientLibVersionNumber()

source code 

Returns the clientlib's version number

Returns: tuple (int, int)
A tuple, containing the errorcode and the result

getClientList(serverConnectionHandlerID)

source code 

Returns all clients in view on the server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: tuple (int, [int])
a tuple, containing the errorcode and the list of client IDs

getClientNeededPermission(serverConnectionHandlerID, permissionName)

source code 

Returns the value of the client's needed permission.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • permissionName (string) - name of the permission
Returns: tuple (int, int)
a tuple, containing the errorcode and the value of the permission

getClientSelfVariableAsInt(serverConnectionHandlerID, flag)

source code 

Returns the value of a given flag of the own client as int value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • flag (int) - the flag to return
Returns: tuple (int, int)
a tuple, containing the errorcode and the value of the queried flag

getClientSelfVariableAsString(serverConnectionHandlerID, flag)

source code 

Returns the value of a given flag of the own client as string.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • flag (int) - the flag to return
Returns: tuple (int, string)
a tuple, containing the errorcode and the value of the queried flag

getClientVariableAsInt(serverConnectionHandlerID, clientID, flag)

source code 

Returns the value of a given flag of a client as int value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
  • flag (int) - the flag to return
Returns: tuple (int, int)
a tuple, containing the errorcode and the value of the flag

getClientVariableAsString(serverConnectionHandlerID, clientID, flag)

source code 

Returns the value of a given flag of a client as string value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
  • flag (int) - the flag to return
Returns: tuple (int, string)
a tuple, containing the errorcode and the value of the flag

getClientVariableAsUInt64(serverConnectionHandlerID, clientID, flag)

source code 

Returns the value of a given flag of a client as unsigned long long int value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
  • flag (int) - the flag to return
Returns: tuple (int, int)
a tuple, containing the errorcode and the value of the flag

getConfigPath(maxLen=256)

source code 

Returns the ts3 config path.

Parameters:
  • maxLen (int) - length of the buffer, passed to the clientlib to store the path to, default value is 256
Returns: string
the config path

getConnectionStatus(serverConnectionHandlerID)

source code 

Returns the current connection status of a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: tuple (int, int)
a tuple, containing the errorcode and the connection status

getConnectionVariableAsDouble(serverConnectionHandlerID, clientID, flag)

source code 

Returns a client's connection variable as python floating point variable.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
Returns: tuple (int, double)
a tuple, containing the errorcode and the value of the flag

getConnectionVariableAsString(serverConnectionHandlerID, clientID, flag)

source code 

Returns a client's connection variable as string variable.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
Returns: tuple (int, string)
a tuple, containing the errorcode and the value of the flag

getConnectionVariableAsUInt64(serverConnectionHandlerID, clientID, flag)

source code 

Returns a client's connection variable as unsigned long long int variable.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
Returns: tuple (int, int)
a tuple, containing the errorcode and the value of the flag

getCurrentCaptureDeviceName(serverConnectionHandlerID)

source code 

Queries the current playback device's name on a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - ID of the serverconnection
Returns: tuple (int, string, int)
A tuple, containing the errorcode, the capture device's name and the status, if it's default

getCurrentCaptureMode(serverConnectionHandlerID)

source code 

Queries the current capture mode on a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - ID of the serverconnection
Returns: tuple (int, string)
A tuple, containing the errorcode and the current capture mode

getCurrentPlaybackDeviceName(serverConnectionHandlerID)

source code 

Queries the current playback device's name on a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - ID of the serverconnection
Returns: tuple (int, string, int)
A tuple, containing the errorcode, the playback device's name and the status, if it's default

getCurrentPlayBackMode(serverConnectionHandlerID)

source code 

Queries the current playback mode on a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - ID of the serverconnection
Returns: tuple (int, string)
A tuple, containing the errorcode and the current playback mode

getCurrentServerConnectionHandlerID()

source code 

Returns the current serverconnection handler.

Returns: int
the ID of the current serverconnection handler

getCurrentTransferSpeed(transferID)

source code 

Returns the current transfer speed of a filetransfer.

Parameters:
  • transferID (int) - the ID of the filetransfer
Returns: tuple (int, float)
a tuple, containing the errorcode and the speed

getDefaultCaptureDevice(modeID)

source code 

Queries the default capture device.

Parameters:
  • modeID (string) - Defines the capture mode to use
Returns: tuple (int, (string, string))
A tuple, containing the errorcode and the default capture device as tuple (devicename, deviceid)

getDefaultCaptureMode()

source code 

Queries the default capture mode.

Returns: tuple (int, string)
A tuple, containing the errorcode and the default capture mode

getDefaultPlaybackDevice(modeID)

source code 

Queries the default playback device.

Parameters:
  • modeID (string) - Defines the playback mode to use
Returns: tuple (int, (string, string))
A tuple, containing the errorcode and the default playback device as tuple (devicename, deviceid)

getDefaultPlayBackMode()

source code 

Queries the default playback mode.

Returns: tuple (int, string)
A tuple, containing the errorcode and the default playback mode

getDirectories(path, maxLen=256)

source code 

Returns a list of subdirectories of a path as space-separated string.

Parameters:
  • path (str) - the parent path
  • maxLen (int) - length of the buffer, passed to the clientlib to store the path to, default value is 256
Returns: string
the resulting path

getEncodeConfigValue(serverConnectionHandlerID, ident)

source code 

Queries a speex encoder option.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • ident (string) - the encoder option to be queried
Returns: tuple (int, string)
A tuple, containing the errorcode and the flag's value

getErrorMessage(errorCode)

source code 

Queries a printable error string for a specific error code.

Parameters:
  • errorCode (int) - The error code returned from all Client Lib functions
Returns: tuple (int, string)
A tuple, containing the errorcode and the resulting string

getHotkeyFromKeyword(keywords)

source code 

Returns a list of hotkeys by its keywords.

Parameters:
  • keywords (list[str]) - a list of keywords
Returns: tuple(int, list[str])
a tuple containing the errorcode and the list of hotkeys

getParentChannelOfChannel(serverConnectionHandlerID, channelID)

source code 

Returns the parent channel of another channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
Returns: tuple (int, int)
a tuple, containing the errorcode and the ID of the parent channel

getPermissionIDByName(serverConnectionHandlerID, permissionName)

source code 

Returns the ID of a permission defined by its name.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • permissionName (string) - name of the permission
Returns: tuple (int, int)
a tuple, containing the errorcode and the ID of the permission

getPlaybackConfigValueAsFloat(serverConnectionHandlerID, ident)

source code 

Queries a playback option.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • ident (string) - the playback option to be queried
Returns: tuple (int, float)
A tuple, containing the errorcode and the flag's value

getPlaybackDeviceList(modeID)

source code 

Queries all available playback devices.

Parameters:
  • modeID (string) - Defines the playback mode to use.
Returns: tuple (int, [(string, string)])
A tuple, containing the errorcode and the list of playback devices as tuple (devicename, deviceid)

getPlaybackModeList()

source code 

Queries all available playback modes.

Returns: tuple (int, [string])
A tuple, containing the errorcode and the list of modes

getPluginPath(maxLen)

source code 

Returns the TeamSpeak 3 client's pluginpath.

Parameters:
  • maxLen (int) - the size of the buffer passed to the clientlib. Optional, defaults to 256
Returns: str
the pluginpath

getPreProcessorInfoValue(serverConnectionHandlerID, ident)

source code 

Querie a sound preprocessor flag and returns it as string.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • ident (string) - the flag to be queried
Returns: tuple (int, string)
A tuple, containing the errorcode and the value of the queried flag

getPreProcessorInfoValueFloat(serverConnectionHandlerID, ident)

source code 

Queries a sound preprocessor flag and returns it as float.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • ident (string) - the flag to be queried
Returns: tuple (int, float)
A tuple, containing the errorcode and the value of the queried flag

getProfileList(profile)

source code 

Returns a list of existing profiles and the default profile's index in list.

Parameters:
  • profile (int) - the profile type, see ts3defines.PluginGuiProfile
Returns: tuple (int, int, [string])
a tuple, containing the errorcode, the default profile's index and the profile list

getResourcesPath(maxLen=256)

source code 

Returns the ts3 resources path.

Parameters:
  • maxLen (int) - length of the buffer, passed to the clientlib to store the path to. Optional, defaults to 256
Returns: string
the resources path

getServerConnectInfo(serverConnectionHandlerID, maxLen=256)

source code 

Returns the connect info (host, port and password) of a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • maxLen (int) - length of the buffer, passed to the clientlib to store the path to, default value is 256
Returns: tuple (int, string, int, string)
a tuple, containing the errorcode, the host, the port and the password of the serverconnection

getServerConnectionHandlerList()

source code 

Returns a list of serverconnection handlers.

Returns: tuple (int, [int])
a tuple, containing the errorcode and the list of serverconnection handler IDs

getServerVariableAsInt(serverConnectionHandlerID, flag)

source code 

Returns a server variable as int value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • flag (int) - the flag to return
Returns: tuple (int, int)
a tuple, containing the errorcode and the value of the flag

getServerVariableAsString(serverConnectionHandlerID, flag)

source code 

Returns a server variable as string value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • flag (int) - the flag to return
Returns: tuple (int, string)
a tuple, containing the errorcode and the value of the flag

getServerVariableAsUInt64(serverConnectionHandlerID, flag)

source code 

Returns a server variable as unsigned long long int value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • flag (int) - the flag to return
Returns: tuple (int, int)
a tuple, containing the errorcode and the value of the flag

getServerVersion(serverConnectionHandlerID)

source code 

Returns the server version.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: int
the server version

getTransferFileName(transferID)

source code 

Returns the filename of a filetransfer.

Parameters:
  • transferID (int) - the ID of the filetransfer
Returns: tuple (int, string)
a tuple, containing the errorcode and the filename

getTransferFilePath(transferID)

source code 

Returns the filepath of a filetransfer.

Parameters:
  • transferID (int) - the ID of the filetransfer
Returns: tuple (int, string)
a tuple, containing the errorcode and the filepath

getTransferFileSize(transferID)

source code 

Returns the total filesize (in Bytes) of a filetransfer.

Parameters:
  • transferID (int) - the ID of the filetransfer
Returns: tuple (int, int)
a tuple, containing the errorcode and the filesize

getTransferFileSizeDone(transferID)

source code 

Returns the already downloaded size (in Bytes) of a filetransfer.

Parameters:
  • transferID (int) - the ID of the filetransfer
Returns: tuple (int, int)
a tuple, containing the errorcode and the size

getTransferRunTime(transferID)

source code 

Returns the runtime of a filetransfer.

Parameters:
  • transferID (int) - the ID of the filetransfer
Returns: tuple (int, int)
a tuple, containing the errorcode and the runtime in seconds

getTransferStatus(transferID)

source code 

Returns the status of a filetransfer, whether if it is initialising, active or finished see ts3defines.FileTransferState

Parameters:
  • transferID (int) - the ID of the filetransfer
Returns: tuple (int, int)
a tuple, containing the errorcode and the status

guiConnect(connectTab, serverLabel, serverAddress, serverPassword, nickname, channel, channelPassword, captureProfile, playbackProfile, hotkeyProfile, userIdentity, oneTimeKey, phoneticName)

source code 

Connects to a server and displays it as tab in the client.

Parameters:
  • connectTab (int) - defines, which tab will be used, see ts3defines.PluginConnectTab
  • serverLabel (string) - the label of the connection
  • serverAddress (string) - host or ip address
  • serverPassword (string) - password to the server, pass an empty string if the server is not password protected
  • nickname (string) - the user's nickname
  • channel (string) - complete path to the channel to connect to
  • channelPassword (string) - password to the channel, pass an empty string if the channel is not password protected
  • captureProfile (string) - the name of the capture profile to use
  • playbackProfile (string) - the name of the playback profile to use
  • hotkeyProfile (string) - the name of the hotkey profile to use
  • userIdentity (string) - identity to use
  • oneTimeKey (string) - privilege key to use on connect
  • phoneticName (string) - phonetic nickname
Returns: tuple (int, int)
a tuple, containing the errorcode and the ID of the created serverconnection handler

guiConnectBookmark(connectTab, bookmarkuuid)

source code 

Connects to a server from a bookmark and displays it as tab in the client.

Parameters:
  • connectTab (int) - defines, which tab will be used, see ts3defines.PluginConnectTab
  • bookmarkuuid (string) - UID of the bookmark
Returns: tuple (int, int)
a tuple, containing the errorcode and the ID of the created serverconnection handler

haltTransfer(serverConnectionHandlerID, transferID, deleteUnfinishedFile, returnCode)

source code 

Halts a currently running filetransfer.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • transferID (int) - the ID of the filetransfer
  • deleteUnfinishedFile (int or bool) - if set to 1 (or True) and the file is not yet finished, it will be deleted; to prevent, pass 0 (or False)
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

initiateGracefulPlaybackShutdown(serverConnectionHandlerID)

source code 

Graceful shutdown the playback device on a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: int
the errorcode

isReceivingWhisper(serverConnectionHandlerID, clientID)

source code 

//FIXME:

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
Returns: tuple (int, int or bool)
a tuple, containing the errorcode and the status

isTransferSender(transferID)

source code 

Returns the upload/download direction of a filetransfer.

Parameters:
  • transferID (int) - the ID of the filetransfer
Returns: tuple (int, int or bool)
a tuple, containing the errorcode and 1 if it's an upload or 0 if it's a download

isWhispering(serverConnectionHandlerID, clientID)

source code 

Returns the status of a client whether he is currently whispering to the own client.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: tuple (int, int or bool)
a tuple, containing the errorcode and the status

logMessage(logMessage, severity, channel, logID)

source code 

Logs a string.

Parameters:
  • logMessage (string) - Text which should be logged
  • severity (int) - The level of the message, warning or error. Defined by the class LogLevel
  • channel (string) - Custom text to categorize the message channel
  • logID (int) - ID of the serverconnection to identify the current server connection when using multiple connections, 0 if unused
Returns: int
The errorcode

openCaptureDevice(serverConnectionHandlerID, modeID, captureDevice)

source code 

Opens a playback device on a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - ID of the serverconnection on which the capture device should be initialized on
  • modeID (string) - the playback mode to use
  • captureDevice (string) - the id of the capture device
Returns: int
the errorcode

openPlaybackDevice(serverConnectionHandlerID, modeID, playbackDevice)

source code 

Opens a playback device on a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - ID of the serverconnection on which the playback device should be initialized on
  • modeID (string) - the playback mode to use
  • playbackDevice (string) - the id of the playback device
Returns: int
the errorcode

pauseWaveFileHandle(serverConnectionHandlerID, waveHandle, pause)

source code 

Pauses a wavefile sound previously started with playWaveFileHandle.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverConnection the sound is played on
  • waveHandle (int) - the handle returned by playWaveFileHandle
  • pause (int or bool) - if set to 1 (or True), the sound will pause, 0 (or False) will unpause the sound
Returns: int
the errorcode

playWaveFile(serverConnectionHandlerID, path)

source code 

Plays a wavefile sound on a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • path (string) - the path to the wavefile on the system
Returns: int
the errorcode

playWaveFileHandle(serverConnectionHandlerID, path, loop)

source code 

Plays a wavefile sound on a serverconnection and returns a handle to it.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection on which the sound will be played on
  • path (string) - the path to the wavefile on the system
  • loop (int or bool) - if set to 1 (or True), the sound will loop
Returns: tuple (int, int)
A tuple, containing the errorcode and the handle, with which the sound can be paused and unpaused

printMessage(serverConnectionHandlerID, message, messageTarget)

source code 

Prints a message to a specific client chat tab.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • message (string) - the message to print
  • messageTarget (int) - the target to send the message, see ts3defines.PluginMessageTarget

printMessageToCurrentTab(message)

source code 

Prints a message to the currently visible tab.

Parameters:
  • message (string) - the message to send

privilegeKeyUse(serverConnectionHandlerID, tokenKey, returnCode)

source code 

Uses a privilege key as the current client of the serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • tokenKey (string) - the token
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

processCustomCaptureData(deviceName, buffer)

source code 

Sends captured data from a custom device to the client libg

Parameters:
  • deviceName (string) - the name of the device capturing the data, previously registered with registerCustomDevice
  • buffer (list [int]) - a list containing the buffered data
Returns: int
the errorcode

registerCustomDevice(deviceID, deviceDisplayName, capFrequency, capChannels, playFrequency, playChannels)

source code 

Registers a custom device, announcing the device ID and name to the Client Lib.

Parameters:
  • deviceID (string) - ID string of the custom device, under which the device can be later accessed
  • deviceDisplayName (string) - Displayed name of the custom device. Freely choose a name which identifies your device
  • capFrequency (int) - Frequency of the capture device
  • capChannels (int) - Number of channels of the capture device. This value depends on if the used codec is a mono or stereo CodecEncryptionMode
  • playFrequency (int) - Frequency of the playback deviceDisplayName
  • playChannels (int) - Number of channels of the playback device
Returns: int
the errorcode

requestBanList(serverConnectionHandlerID, returnCode)

source code 

Requests the banlist on a server. The event onBanListEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelAddPerm(serverConnectionHandlerID, channelID, permissionIDArray, permissionValueArray, returnCode)

source code 

Adds a list of permissions to a channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • permissionIDArray (list [int]) - a list of permission IDs
  • permissionValueArray (list [int]) - list of permission values, in order of the permissions in permissionIDArray
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelClientAddPerm(serverConnectionHandlerID, channelID, clientDatabaseID, permissionIDArray, permissionValueArray, returnCode)

source code 

Adds a list of permissions on a channel to a user.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • clientDatabaseID (int) - the database ID of the user
  • permissionIDArray (list [int]) - a list of permission IDs
  • permissionValueArray (list [int]) - list of permission values, in order of the permissions in permissionIDArray
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelClientDelPerm(serverConnectionHandlerID, channelID, clientDatabaseID, permissionIDArray, returnCode)

source code 

Deletes a list of permissions of a user in a channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • clientDatabaseID (int) - the database ID of the user
  • permissionIDArray (list [int]) - a list of permission IDs
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelClientPermList(serverConnectionHandlerID, channelID, clientDatabaseID, returnCode)

source code 

Requests the list of permissions of a user in a channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • clientDatabaseID (int) - the database ID of the user
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelDelete(serverConnectionHandlerID, channelID, force, returnCode)

source code 

Deletes a channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel to delete
  • force (int or bool) - if set to 1 (or True), the channel will be deleted even when it is not empty
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelDelPerm(serverConnectionHandlerID, channelID, permissionIDArray, returnCode)

source code 

Deletes a list of permissions from a channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • permissionIDArray (list [int]) - a list of permission IDs
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelDescription(serverConnectionHandlerID, channelID, returnCode)

source code 

Requests the channel description of a channel. Afterwards, getChannelVariableAsString can return it.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelGroupAdd(serverConnectionHandlerID, groupName, groupType, returnCode)

source code 

Adds a channelgroup.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • groupName (string) - the name of the channelgroup to create
  • groupType (int) - type of the channelgroup, see ts3defines.GroupType
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelGroupAddPerm(serverConnectionHandlerID, channelGroupID, continueonerror, permissionIDArray, permissionValueArray, returnCode)

source code 

Adds a list of permissions to a channelgroup.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelGroupID (int) - the ID of the channelgroup
  • continueonerror (bool) - if set to True, if an error with a permission occurs, the other permissions will even though be handled
  • permissionIDArray (list [int]) - a list of permission IDs
  • permissionValueArray (list [int]) - list of permission values, in order of the permissions in permissionIDArray
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelGroupDel(serverConnectionHandlerID, channelGroupID, force, returnCode)

source code 

Deletes a channelgroup.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelGroupID (int) - the ID of the channelgroup
  • force (int or bool) - if set to 1 (or True), even if there are users assigned to this channelgroup, it will be deleted
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelGroupDelPerm(serverConnectionHandlerID, channelGroupID, continueOnError, permissionIDArray, returnCode)

source code 

Deletes a list of permissions from a channelgroup.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelGroupID (int) - the ID of the channelgroup
  • continueOnError (int or bool) - if set to 1 (or True), if an error with a permission occurs, the other permissions will even though be handled
  • permissionIDArray (list [int]) - a list of permission IDs
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelGroupList(serverConnectionHandlerID, returnCode)

source code 

Requests the list of channelgroups. The events onChannelGroupListEvent and onChannelGroupListEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelGroupPermList(serverConnectionHandlerID, channelGroupID, returnCode)

source code 

Requests the list of permissions assigned to a channelgroup. The events onChannelGroupPermListEvent and onChannelGroupPermListFinishedEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelGroupID (int) - the ID of the channelGroupID
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelMove(serverConnectionHandlerID, channelID, newChannelParentID, newChannelOrder, returnCode)

source code 

Moves a channel to a new parent channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel to move
  • newChannelParentID (int) - the ID of the new parent channel
  • newChannelOrder (int) - Channel order defining where the channel should be sorted under the new parent. Pass 0 to sort the channel right after the parent
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelPermList(serverConnectionHandlerID, channelID, returnCode)

source code 

Requests the list of permissions assigned to a channel. The events onChannelPermListEvent and onChannelPermListFinishedEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelSubscribe(serverConnectionHandlerID, channelIDArray, returnCode)

source code 

Subscribes to a list of channels to get notifications of the clients in them.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelIDArray (list [int]) - a list of channel IDs
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelSubscribeAll(serverConnectionHandlerID, returnCode)

source code 

Subscribes to all channels on the server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelUnsubscribe(serverConnectionHandlerID, channelIDArray, returnCode)

source code 

Unsubscribes from a list channels.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelIDArray (list [int]) - a list of channel IDs
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestChannelUnsubscribeAll(serverConnectionHandlerID, returnCode)

source code 

Unsubscribes from all channels on the server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestClientAddPerm(serverConnectionHandlerID, clientDatabaseID, permissionIDArray, permissionValueArray, permissionSkipArray, returnCode)

source code 

Adds a list of permissions to a user.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientDatabaseID (int) - the database ID of the user
  • permissionIDArray (list [int]) - a list of permission IDs
  • permissionValueArray (list [int]) - list of permission values, in order of the permissions in permissionIDArray
  • permissionSkipArray (list [int]) - list of permission skip values, in order of the permissions in permissionIDArray
Returns: int
the errorcode

requestClientDBIDfromUID(serverConnectionHandlerID, clientUniqueIdentifier, returnCode)

source code 

Requests the database ID of a client defined by the UID. The event onClientDBIDfromUIDEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientUniqueIdentifier (string) - the UID of the client
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestClientDelPerm(serverConnectionHandlerID, clientDatabaseID, permissionIDArray, returnCode)

source code 

Deletes a list of permissions from a user.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientDatabaseID (int) - the database ID of the user
  • permissionIDArray (list [int]) - a list of permission IDs
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestClientEditDescription(serverConnectionHandlerID, clientID, clientDescription, returnCode)

source code 

Sets the description of a client.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
  • clientDescription (string) - the description to set
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestClientIDs(serverConnectionHandlerID, clientUniqueIdentifier, returnCode)

source code 

Requests the client IDs for a given UID. Will trigger the event onClientIDsEvent.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientUniqueIdentifier (string) - the UID of the client
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestClientKickFromChannel(serverConnectionHandlerID, clientID, kickReason, returnCode)

source code 

Kicks a client from its current channel to the default one.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client to kick
  • kickReason (string) - the reason for the kick
Returns: int
the errorcode

requestClientKickFromServer(serverConnectionHandlerID, clientID, kickReason, returnCode)

source code 

Kicks a client from the server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client to kick
  • kickReason (string) - the reason for the kick
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestClientMove(serverConnectionHandlerID, clientID, newChannelID, password, returnCode)

source code 

Moves a client to a different channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client to be moved
  • newChannelID (int) - the ID of the channel moving the client to
  • password (string) - password of the channel, leave empty if channel is not password protected
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestClientNamefromDBID(serverConnectionHandlerID, clientDatabaseID, returnCode)

source code 

Requests the name of a client defined by the database ID. The event onClientNamefromDBIDEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientDatabaseID (int) - the database ID of the client
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestClientNamefromUID(serverConnectionHandlerID, clientUniqueIdentifier, returnCode)

source code 

Requests the name of a client defined by the UID. The event onClientNamefromUIDEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientUniqueIdentifier (string) - the UID of the client
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestClientPermList(serverConnectionHandlerID, clientDatabaseID, returnCode)

source code 

Requests the list of permissions assigned to a user. The events

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientDatabaseID (int) - the database ID of the user
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestClientPoke(serverConnectionHandlerID, clientID, message, returnCode)

source code 

Pokes a client with a given message.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
  • message (string) - the message
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestClientSetIsTalker(serverConnectionHandlerID, clientID, isTalker, returnCode)

source code 

Grants or revokes the talker flag of a client.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
  • isTalker (int or bool) - if set to 1 (or True) grants talker flag, if 0 (or False) revokes talker flag
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestClientSetWhisperList(serverConnectionHandlerID, clientID, targetChannelIDArray, targetClientIDArray, returnCode)

source code 

Modifies the whisper list of a client.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client whose whisperlist is modified. If set to 0, the own whisper list is modified
  • targetChannelIDArray (list [int]) - a list of channel IDs the client will whisper to. Pass None to clear it
  • targetClientIDArray (list [int]) - a list of client IDs the client will whisper to. Pass None to clear it
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestClientVariables(serverConnectionHandlerID, clientID, returnCode)

source code 

Requests latest data for a given client. The event onUpdateClientEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestComplainAdd(serverConnectionHandlerID, targetClientDatabaseID, complainReason, returnCode)

source code 

Adds a complain to a user defined by his database ID.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • targetClientDatabaseID (int) - the database ID of the user
  • complainReason (string) - the reason for the complain
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestComplainDel(serverConnectionHandlerID, targetClientDatabaseID, fromClientDatabaseID, returnCode)

source code 

Deletes a complain to a user by a different user.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • targetClientDatabaseID (int) - the database ID of the complained user
  • fromClientDatabaseID (int) - the database ID of the complaining user
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestComplainDelAll(serverConnectionHandlerID, targetClientDatabaseID, returnCode)

source code 

Deletes all complains to a user.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • targetClientDatabaseID (int) - the database ID of the user
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestComplainList(serverConnectionHandlerID, targetClientDatabaseID, returnCode)

source code 

Requests the list of complains to a user. The event onComplainListEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • targetClientDatabaseID (int) - the database ID of the user
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestConnectionInfo(serverConnectionHandlerID, clientID, returnCode)

source code 

Requests the connection info of a client. The event onConnectionInfoEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the ID of the client
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestCreateDirectory(serverConnectionHandlerID, channelID, channelPW, directoryPath, returnCode)

source code 

Creates a directory in a channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • channelPW (string) - the password of the channel, pass an empty string if channel is not password protected
  • directoryPath (string) - the complete path of the to be created directory
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestDeleteFile(serverConnectionHandlerID, channelID, channelPW, files, returnCode)

source code 

Deletes a list of files in a channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • channelPW (string) - the password of the channel, pass an empty string if channel is not password protected
  • files (list [string]) - a list of complete pathes of the file to delete
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestFile(serverConnectionHandlerID, channelID, channelPW, file, overwrite, resume, destinationDirectory, returnCode)

source code 

Starts a filedownload from the server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel in which the file is placed in
  • channelPW (string) - the password of the channel, pass an empty string if the channel is not password protected
  • file (string) - the complete path to the file in the channel
  • overwrite (int or bool) - if set to 1 (or True) and a file with that name already exists will be overwritten
  • resume (int or bool) - if set to 1 (or True), a previously started filetransfer can be resumed
  • destinationDirectory (strin) - the path to the directory, where the downloaded fill will be placed in
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: tuple (int, int)
a tuple, containing the errorcode and the ID of the filetransfer

requestFileInfo(serverConnectionHandlerID, channelID, channelPW, file, returnCode)

source code 

Requests the info to a file in a channel. The event onFileInfoEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • channelPW (string) - the password of the channel, pass an empty string if the channel is not password protected
  • file (string) - the complete path to the file
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestFileList(serverConnectionHandlerID, channelID, channelPW, path, returnCode)

source code 

Requests the filelist of a channel. The events onFileListEvent and onFileListFinishedEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • channelPW (string) - the password of the channel, pass an empty string if the channel is not password protected
  • path (string) - the path of the directory to be listed, pass '/' for the root path
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestHotkeyInputDialog(keyword, isDown, qParentWindow)

source code 

Shows the hotkeyinputdialog to set the hotkey for a hotkey keyword. When finished ts3plugin.onHotkeyRecordedEvent will be called with the recorded hotkey.

Parameters:
  • keyword (str) - the global keyword (see PluginHost.globalHotkeyKeyword)
  • isDown (bool) - if True, the hotkey will be triggered on keypress, on keyrelease otherwise
  • qParentWindow (QWidget) - the window on which the dialog is shown modal to, optional

requestInfoUpdate(serverConnectionHandlerID, itemType, itemID)

source code 

Requests to update the info data.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • itemType (int) - specifies, which info data update is requested, see ts3defines.PluginItemType
  • itemID (int) - the ID of the item to update (only usefull if itemType != ts3defines.PluginItemType.PLUGIN_MENU_TYPE_GLOBAL)
Returns: int
the errorcode

requestIsTalker(serverConnectionHandlerID, isTalkerRequest, isTalkerRequestMessage, returnCode)

source code 

Requests talk power or revokes the talk power request.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • isTalkerRequest (int or bool) - if set to 1 (or True) requests talk power, if 0 (or False) revokes the talk power request
  • isTalkerRequestMessage (string) - the message of the request
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestMessageAdd(serverConnectionHandlerID, toClientUID, subject, message, returnCode)

source code 

Sends an offline message to another user.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • toClientUID (string) - the UID of the user
  • subject (string) - the subject of the message
  • message (string) - the message
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestMessageDel(serverConnectionHandlerID, messageID, returnCode)

source code 

Deletes an offline message.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • messageID (int) - the ID of the message
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestMessageGet(serverConnectionHandlerID, messageID, returnCode)

source code 

Requests an offline message defined by its ID. The event onMessageGetEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • messageID (int) - the ID of the message
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestMessageList(serverConnectionHandlerID, returnCode)

source code 

Requests the list of offline messages. The event onMessageListEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestMessageUpdateFlag(serverConnectionHandlerID, messageID, flag, returnCode)

source code 

Sets the message read/unread flag of an offline message

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • messageID (int) - the ID of the message
  • flag () - set to 0 to set message as unread, set to 1 to set message as read
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestMuteClients(serverConnectionHandlerID, clientIDArray, returnCode)

source code 

Mutes a list of clients.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientIDArray (list [int]) - a list of client IDs
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestPermissionList(serverConnectionHandlerID, returnCode)

source code 

Requests the list of permissions available on the server. The events onPermissionListEvent and onPermissionListFinishedEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestPermissionOverview(serverConnectionHandlerID, clientDBID, channelID, returnCode)

source code 

Requests the permission overview of a user in a channel. The events onPermissionOverviewEvent and onPermissionOverviewFinishedEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientDBID (int) - the database ID of the user
  • channelID (int) - the ID of the channel
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestRenameFile(serverConnectionHandlerID, fromChannelID, channelPW, toChannelID, toChannelPW, oldFile, newFile, returnCode)

source code 

Renames a file or moves it to another channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • fromChannelID (int) - the ID of the channel, the file is currently placed in
  • channelPW (string) - the password of the channel, the file is currently placed in, pass an empty string if channel is not password protected
  • toChannelID (int) - the ID of the channel, the file should be placed in after, pass 0, if just renaming, not moving
  • toChannelPW (string) - the password of the channel, to which the file should move to, pass an empty string if channel is not password protected; this is ignored, if just renaming, not moving
  • oldFile (string) - the complete path to the file
  • newFile (string) - the complete path to the new filename
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestSendChannelTextMsg(serverConnectionHandlerID, message, targetChannelID, returnCode)

source code 

Sends a text message to all clients in a channel.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • message (string) - the message to send
  • targetChannelID (int) - the ID of the channel
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestSendClientQueryCommand(serverConnectionHandlerID, command, returnCode)

source code 

Requests to execute a clientquery command.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • command (string) - the command to execute
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestSendPrivateTextMsg(serverConnectionHandlerID, message, targetClientID, returnCode)

source code 

Sends a private text message to a client.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • message (string) - the message to send
  • targetClientID (int) - the ID of the client to send the message to
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestSendServerTextMsg(serverConnectionHandlerID, message, returnCode)

source code 

Sends a text message to all clients on the server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • message (string) - the message to send
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerGroupAdd(serverConnectionHandlerID, groupName, groupType, returnCode)

source code 

Adds a servergroup.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • groupName (string) - the name of the group to create
  • groupType (int) - type of the servergroup, see ts3defines.GroupType
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerGroupAddClient(serverConnectionHandlerID, serverGroupID, clientDatabaseID, returnCode)

source code 

Adds a user defined by his database ID to a servergroup.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • serverGroupID (int) - the ID of the servergroup
  • clientDatabaseID (int) - the database ID of the user
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerGroupAddPerm(serverConnectionHandlerID, serverGroupID, continueonerror, permissionIDArray, permissionValueArray, permissionNegatedArray, permissionSkipArray, returnCode)

source code 

Adds a list of permissions to a servergroup.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • serverGroupID (int) - the ID of the servergroup
  • continueonerror (int or bool) - if set to 1 (or True), if an error with a permission occurs, the other permissions will even though be handled
  • permissionIDArray (list [int]) - list of permission IDs
  • permissionValueArray (list [int]) - list of permission values, in order of the permissions in permissionIDArray
  • permissionNegatedArray (list [int]) - list of permission negated values, in order of the permissions in permissionIDArray
  • permissionSkipArray (list [int]) - list of permission skip values, in order of the permissions in permissionIDArray
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerGroupClientList(serverConnectionHandlerID, serverGroupID, withNames, returnCode)

source code 

Requests the list of clients assigned to a servergroup. The event onServerGroupClientListEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • serverGroupID (int) - the ID of the servergroup
  • withNames (int or bool) - if set to 1 (or True), the event will contain the nick and uid of the user instead of empty strings
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerGroupDel(serverConnectionHandlerID, serverGroupID, force, returnCode)

source code 

Deletes a servergroup.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • serverGroupID (int) - the ID of the servergroup
  • force (int or bool) - if set to 1 (or True), even if there are users assigned to this servergroup, it will be deleted
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerGroupDelClient(serverConnectionHandlerID, serverGroupID, clientDatabaseID, returnCode)

source code 

Deletes a user defined by his database ID from a servergroup.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • serverGroupID (int) - the ID of the servergroup
  • clientDatabaseID (int) - the database ID of the user
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerGroupDelPerm(serverConnectionHandlerID, serverGroupID, continueOnError, permissionIDArray, returnCode)

source code 

Deletes a list of permissions from a servergroup.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • serverGroupID (int) - the ID of the servergroup
  • continueOnError (int or bool) - if set to 1 (or True), if an error with a permission occurs, the other permissions will even though be handled
  • permissionIDArray (list [int]) - list of permission IDs
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerGroupList(serverConnectionHandlerID, returnCode)

source code 

Requests the list of servergroups. The events onServerGroupListEvent and onServerGroupListFinishedEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerGroupPermList(serverConnectionHandlerID, serverGroupID, returnCode)

source code 

Requests the list of permissions assigned to a servergroup. The events onServerGroupPermListEvent and onServerGroupPermListFinishedEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • serverGroupID (int) - the ID of the servergroup
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerGroupsByClientID(serverConnectionHandlerID, clientDatabaseID, returnCode)

source code 

Requests all servergroups of a user defined by his database ID. The event onServerGroupByClientIDEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientDatabaseID (int) - the database ID of the user
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerTemporaryPasswordAdd(serverConnectionHandlerID, password, description, duration, targetChannelID, targetChannelPW, returnCode)

source code 

Adds a temporary password to the server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • password (string) - the temporary password
  • description (string) - the description of the temporary password
  • duration (int) - the duration in seconds
  • targetChannelID (int) - the ID of the channel to which the accessing clients will join by default
  • targetChannelPW (string) - the password of the targetChannel, pass an empty string, if the channel is not password protected
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerTemporaryPasswordDel(serverConnectionHandlerID, password, returnCode)

source code 

Deletes an existing temporary password.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • password (string) - the password to delete
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerTemporaryPasswordList(serverConnectionHandlerID, returnCode)

source code 

Requests a list of existing temporary passwords. The event onServerTemporaryPasswordListEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestServerVariables(serverConnectionHandlerID)

source code 

Requests all server variables of a serverconnection. The event onServerUpdatedEvent will be triggered.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: int
the errorcode

requestSetClientChannelGroup(serverConnectionHandlerID, channelGroupIDArray, channelIDArray, clientDatabaseIDArray, returnCode)

source code 

Adds a list of users to a list of channelgroups.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelGroupIDArray (list [int]) - a list of channelgroup IDs
  • channelIDArray (list [int]) - a list of channel IDs
  • clientDatabaseIDArray (list [int]) - a list of client database IDs
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

requestUnmuteClients(serverConnectionHandlerID, clientIDArray, returnCode)

source code 

Unmutes a list of clients.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientIDArray (list [int]) - a list of client IDs
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

sendFile(serverConnectionHandlerID, channelID, channelPW, file, overwrite, resume, sourceDirectory, returnCode)

source code 

Starts a fileupload to the server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel in which the file will be placed in
  • channelPW (string) - the password of the channel, pass an empty string if the channel is not password protected
  • file (string) - the complete path to the file in the channel
  • overwrite (int or bool) - if set to 1 (or True) and a file with that name already exists will be overwritten
  • resume (int or bool) - if set to 1 (or True), a previously started filetransfer can be resumed
  • sourceDirectory (string) - the directory on the system, where the original file is placed in
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: tuple (int, int)
a tuple, containing the errorcode and the ID of the filetransfer

sendPluginCommand(serverConnectionHandlerID, command, targetMode, targetIDs, returnCode)

source code 

Sends a plugin command to other users.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • command (string) - the command string
  • targetMode (int) - specifies, to whom the command will be send, see ts3defines.PluginTargetMode
  • targetIDs (list [int]) - a list of client IDs, only needed if targetMode == ts3defines.PluginTargetMode.PluginCommandTarget_CLIENT
Returns: int
the errorcode (as this is wrapped in python, there could be errors)

serverPropertyStringToFlag(serverPropertyString)

source code 

Converts a server property name used in strings (eg the serverquery) to the corresponding flag.

Parameters:
  • serverPropertyString (str) - the lowercase string representation
Returns: tuple (int, int)
a tuple, containing the errorcode and the flag (see ts3defines.ClientProperties and ts3defines.ClientPropertiesRare)

set3DWaveAttributes(serverConnectionHandlerID, waveHandle, position)

source code 

Positions a wave file that was opened previously with playWaveFileHandle in 3D space.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • waveHandle (int) - handle of the played wavefile sound returned by playWaveFileHandle
  • position (tuple (float, float, float)) - A tuple defining the 3D position of the sound
Returns: int
the errorcode

setChannelVariableAsInt(serverConnectionHandlerID, channelID, flag, value)

source code 

Sets a channel variable to a new int value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel, pass 0 to set a new channel's variables
  • flag (int) - the flag to set
  • value (int) - the new value
Returns: int
the errorcode

setChannelVariableAsString(serverConnectionHandlerID, channelID, flag, value)

source code 

Sets a channel variable to a new string value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel, pass 0 to set a new channel's variables
  • flag (int) - the flag to set
  • value (int) - the new value
Returns: int
the errorcode

setChannelVariableAsUInt64(serverConnectionHandlerID, channelID, flag, value)

source code 

Sets a channel variable to a new unsigned long long int value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel, pass 0 to set a new channel's variables
  • flag (int) - the flag to set
  • value (int) - the new value
Returns: int
the errorcode

setClientSelfVariableAsInt(serverConnectionHandlerID, flag, value)

source code 

Sets a variable of the own client to a new int value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • flag (int) - the flag to set
  • value (int) - the new value
Returns: int
the errorcode

setClientSelfVariableAsString(serverConnectionHandlerID, flag, value)

source code 

Sets a variable of the own client to a new string value.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • flag (int) - the flag to set
  • value (string) - the new value
Returns: int
the errorcode

setClientVolumeModifier(serverConnectionHandlerID, clientID, value)

source code 

Sets the volume modifier of a client.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • clientID (int) - the client's ID
  • value (float) - the value to set
Returns: int
the errorcode

setPlaybackConfigValue(serverConnectionHandlerID, ident, value)

source code 

Sets a playback option.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • ident (string) - the playback option to reset
  • value (string) - the value to set
Returns: int
the errorcode

setPluginMenuEnabled(menuID, enabled)

source code 

Enables or disables a menuitem. The menuID must be the global id, not the local id plugin developers set in menuItems. Retrieve it with PluginHost.globalMenuID.

Parameters:
  • menuID (int) - global id of the menuitem
  • enabled (bool) - set to True to enable it, False otherwise

setPreProcessorConfigValue(serverConnectionHandlerID, ident, value)

source code 

Sets a sound preprocessor flag.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • ident (string) - the flag to be set
  • value (string) - the value to set the flag to
Returns: int
the errorcode

spawnNewServerConnectionHandler(port)

source code 

Creates a new server connection handler and receive its ID.

Parameters:
  • port (int) - Port the client should bind on. Specify zero to let the operating system chose any free port
Returns: tuple (int, int)
A tuple, containig the errorcode and the resulting ID

startConnection(serverConnectionHandlerID, identity, ip, port, nickname, defaultChannelArray, defaultChannelPassword, serverPassword)

source code 

Starts a connection to the given server.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • identity (string) - the client's identity
  • ip (string) - hostname or ip of the server
  • port (int) - port of the server
  • nickname (string) - the client's nickname
  • defaultChannelArray (list [string]) - list of strings defining the path to a channel on the server, pass empty list to join in server's default channel
  • defaultChannelPassword (string) - password of the default channel, pass an empty string if not using defaultChannelArray or channel is not password protected
  • serverPassword (string) - password of the server, pass an empty string if the server is not password protected
Returns: int
the errorcode

startVoiceRecording(serverConnectionHandlerID)

source code 

Sets the voice recording flag of the own client on a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: int
the errorcode

stopConnection(serverConnectionHandlerID, quitMessage)

source code 

Stops the connection of a serverconnection.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • quitMessage (string) - a message displayed when leaving the server encoded in UTF-8
Returns: int
the errorcode

stopVoiceRecording(serverConnectionHandlerID)

source code 

Removes the voice recording flag of the own client on a serverconnection

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
Returns: int
the errorcode

systemset3DListenerAttributes(serverConnectionHandlerID, position, forward, up)

source code 

Sets the position, velocity and orientation of the own client in 3D space

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • position (tuple (float, float, float)) - A tuple defining the 3D position, pass None to ignore
  • forward (tuple (float, float, float)) - A tuple defining the forward orientation of the listener. The vector must be of unit length and perpendicular to the up vector. Pass None to ignore.
  • up (tuple (float, float, float)) - A tuple defining the upward orientation of the listener. The vector must be of unit length and perpendicular to the forward vector. Pass None to ignore.
Returns: int
the errorcode

systemset3DSettings(serverConnectionHandlerID, distanceFactor, rolloffScale)

source code 

Adjust 3D sound system settings.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • distanceFactor (float) - relative distance factor. Default is 1.0 = 1 meter
  • rolloffScale (float) - Scaling factor for 3D sound rolloff. Defines how fast sound volume will attenuate. As higher the value, as faster the sound is toned with increasing distance.
Returns: int
the errorcode

unregisterCustomDevice(deviceID)

source code 

Unregisters a custom device, previously registered with registerCustomDevice.

Parameters:
  • deviceID (string) - the ID of the device, used in registerCustomDevice
Returns: int
the errorcode

urlsToBB(text, maxLen=256)

source code 

Converts an url to the BB-code respresentation.

Parameters:
  • text (string) - the url
  • maxLen (int) - length of the buffer, passed to the clientlib to store the path to, default value is 256
Returns: string
the BB-code representation

verifyChannelPassword(serverConnectionHandlerID, channelID, channelPassword, returnCode)

source code 

Verifies the password to a channel. The result can be checked in onServerErrorEvent.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • channelID (int) - the ID of the channel
  • channelPassword (string) - the password to be verified
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode

verifyServerPassword(serverConnectionHandlerID, serverPassword, returnCode)

source code 

Verifies the password to a server. The result can be checked in onServerErrorEvent.

Parameters:
  • serverConnectionHandlerID (int) - the ID of the serverconnection
  • serverPassword (string) - the password to be verified
  • returnCode (string) - returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional.
Returns: int
the errorcode