API

class ts3py.TS3Server(ip, port=10011)

command(cmd, params={}, options=[])

Send a command to the Teamspeak3-server and return the response.

Parameters:

• cmd (string) – command
• params (dict) – parameters appended to the command
• options (list) – options appended to the command

Returns:

response of the command (if any)

Return type:

list

connect(ip, port=10011)

Connect to a Teamspeak3-Server.

Parameters:

• ip (string) – ip of the Teamspeak3-server
• port (int) – port of the Teamspeak3-server’s query-interface

disconnect()

Disconnect from the Teamspeak3-server.

ts3utils.build_command(cmd, params={}, options=[])

Build query command-string from cmd, params and options.

Parameters:

• cmd (str) – command
• params (dict) – parameters for the command
• options (list) – options for the command

ts3utils.escape(data)

Escape to TS3Query-format.

Parameters:data (str) – data in normal form

ts3utils.parse_response(response)

Parse raw response to a list of key-value-dicts.

Parameters:response (str) – query-response Returns:list of parsed objects from response Return type:list

ts3utils.unescape(data)

Escape to normal-format.

Parameters:data (str) – data in escaped form