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

Source Code for Module ts3lib

1 -def getPluginID():
2 """ 3 Returns pyTSon's plugin id 4 @return: the plugin id 5 @rtype: string 6 """
7
8 -def acquireCustomPlaybackData(deviceName, samples):
9 """ 10 Retrieves playback data from the clientlib 11 @param deviceName: the name of the playback device previously registered with registerCustomDevice 12 @type deviceName: string 13 @param samples: specifies how long the resultbuffer should be, which is passed to the clientlib 14 @type samples: int 15 @return: a tuple containing the errorcode and the buffer as list of ints 16 @rtype: tuple(int, list[int]) 17 """
18
19 -def activateCaptureDevice(serverConnectionHandlerID):
20 """ 21 Activates the capture device on a serverconnection. 22 @param serverConnectionHandlerID: the ID of the serverconnection 23 @type serverConnectionHandlerID: int 24 @return: the errorcode 25 @rtype: int 26 """
27
28 -def banadd(serverConnectionHandlerID, ipRegExp, nameRegexp, uniqueIdentity, timeInSeconds, banReason, returnCode):
29 """ 30 Adds a new ban. 31 @param serverConnectionHandlerID: the ID of the serverconnection 32 @type serverConnectionHandlerID: int 33 @param ipRegExp: regular expression to match IPs, pass an empty string to ignore IPs 34 @type ipRegExp: string 35 @param nameRegexp: regular expression to match client nicknames, pass an empty string to ignore nicknames 36 @type nameRegexp: string 37 @param uniqueIdentity: client UID to ban, pass an empty string to ignore UIDs 38 @type uniqueIdentity: string 39 @param timeInSeconds: the time, the client should be banned for, pass 0 to add a permanent ban 40 @type timeInSeconds: int 41 @param banReason: the reason for the ban 42 @type banReason: string 43 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 44 @type returnCode: string 45 @return: the errorcode 46 @rtype: int 47 """
48
49 -def banclient(serverConnectionHandlerID, clientID, timeInSeconds, banReason, returnCode):
50 """ 51 @param serverConnectionHandlerID: the ID of the serverconnection 52 @type serverConnectionHandlerID: int 53 @param clientID: the ID of the client 54 @type clientID: int 55 @param timeInSeconds: the time, the client should be banned for, pass 0 to add a permanent ban 56 @type timeInSeconds: int 57 @param banReason: the reason for the ban 58 @type banReason: string 59 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 60 @type returnCode: string 61 @return: the errorcode 62 @rtype: int 63 """
64
65 -def banclientdbid(serverConnectionHandlerID, clientDBID, timeInSeconds, banReason, returnCode):
66 """ 67 Bans a user defined by his database ID. 68 @param serverConnectionHandlerID: the ID of the serverconnection 69 @type serverConnectionHandlerID: int 70 @param clientDBID: the database ID of the user 71 @type clientDBID: int 72 @param timeInSeconds: the time, the client should be banned for, pass 0 to add a permanent ban 73 @type timeInSeconds: int 74 @param banReason: the reason for the ban 75 @type banReason: string 76 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 77 @type returnCode: string 78 @return: the errorcode 79 @rtype: int 80 """
81
82 -def bandel(serverConnectionHandlerID, banID, returnCode):
83 """ 84 Deletes a ban. 85 @param serverConnectionHandlerID: the ID of the serverconnection 86 @type serverConnectionHandlerID: int 87 @param banID: the ID of the ban 88 @type banID: int 89 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 90 @type returnCode: string 91 @return: the errorcode 92 @rtype: int 93 """
94
95 -def bandelall(serverConnectionHandlerID, returnCode):
96 """ 97 Deletes all bans on a server. 98 @param serverConnectionHandlerID: the ID of the serverconnection 99 @type serverConnectionHandlerID: int 100 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 101 @type returnCode: string 102 @return: the errorcode 103 @rtype: int 104 """
105
106 -def channelPropertyStringToFlag(channelPropertyString):
107 """ 108 Converts a channel property name used in strings (eg the serverquery) to the corresponding flag. 109 @param channelPropertyString: 110 @type channelPropertyString: string 111 @return: a tuple, containing the errorcode and the flag (see ts3defines.ChannelProperties and ts3defines.ChannelPropertiesRare) 112 @rtype: tuple (int, int) 113 """
114
115 -def channelset3DAttributes(serverConnectionHandlerID, clientID, position):
116 """ 117 Adjusts a clients position and velocity in 3D space. 118 @param serverConnectionHandlerID: the ID of the serverconnection 119 @type serverConnectionHandlerID: int 120 @param clientID: the ID of the client to adjust 121 @type clientID: int 122 @param position: a tuple defining the position of the clientID 123 @type position: tuple (float, float, float) 124 @return: the errorcode 125 @rtype: int 126 """
127
128 -def cleanUpConnectionInfo(serverConnectionHandlerID, clientID):
129 """ 130 //FIXME: 131 @param serverConnectionHandlerID: the ID of the serverconnection 132 @type serverConnectionHandlerID: int 133 @param clientID: the ID of the client 134 @type clientID: int 135 @return: the errorcode 136 @rtype: int 137 """
138
139 -def clientChatClosed(serverConnectionHandlerID, clientUniqueIdentifier, clientID, returnCode):
140 """ 141 Sends the client chat closed command to a client the own client is currently chatting with. 142 @param serverConnectionHandlerID: the ID of the serverconnection 143 @type serverConnectionHandlerID: int 144 @param clientUniqueIdentifier: the uid of the own chatting client 145 @type clientUniqueIdentifier: string 146 @param clientID: the ID of the client, the own client is chatting with 147 @type clientID: int 148 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 149 @type returnCode: string 150 @return: the errorcode 151 @rtype: int 152 """
153
154 -def clientChatComposing(serverConnectionHandlerID, clientID, returnCode):
155 """ 156 Sends the client chat composing command to a client the own client is currently chatting with. 157 @param serverConnectionHandlerID: the ID of the serverconnection 158 @type serverConnectionHandlerID: int 159 @param clientID: the ID of the client, the own client is chatting with 160 @type clientID: int 161 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 162 @type returnCode: string 163 @return: the errorcode 164 @rtype: int 165 """
166
167 -def clientPropertyStringToFlag(clientPropertyString):
168 """ 169 Converts a client property name used in strings (eg the serverquery) to the corresponding flag. 170 @param clientPropertyString: 171 @type clientPropertyString: string 172 @return: a tuple, containing the errorcode and the flag (see ts3defines.ClientProperties and ts3defines.ClientPropertiesRare) 173 @rtype: tuple (int, int) 174 """
175
176 -def closeCaptureDevice(serverConnectionHandlerID):
177 """ 178 Closes a capture device on a serverconnection. 179 @param serverConnectionHandlerID: the ID of the serverconnection 180 @type serverConnectionHandlerID: int 181 @return: the errorcode 182 @rtype: int 183 """
184
185 -def closePlaybackDevice(serverConnectionHandlerID):
186 """ 187 Closes a playback device on a serverconnection. 188 @param serverConnectionHandlerID: the ID of the serverconnection 189 @type serverConnectionHandlerID: int 190 @return: the errorcode 191 @rtype: int 192 """
193
194 -def closeWaveFileHandle(serverConnectionHandlerID, waveHandle):
195 """ 196 Closes a wavefile sound handle previously returned by playWaveFileHandle. 197 @param serverConnectionHandlerID: the ID of the serverConnection the sound was played on 198 @type serverConnectionHandlerID: int 199 @param waveHandle: the handle returned by playWaveFileHandle 200 @type waveHandle: int 201 @return: the errorcode 202 @rtype: int 203 """
204
205 -def createBookmark(bookmarkuuid, serverLabel, serverAddress, serverPassword, nickname, channel, channelPassword, captureProfile, playbackProfile, hotkeyProfile, soundProfile, uniqueUserId, oneTimeKey, phoneticName):
206 """ 207 Creates a new bookmark. 208 @param serverLabel: the label of the connection 209 @type serverLabel: string 210 @param serverAddress: host or ip address 211 @type serverAddress: string 212 @param serverPassword: password to the server, pass an empty string if the server is not password protected 213 @type serverPassword: string 214 @param nickname: the user's nickname 215 @type nickname: string 216 @param channel: complete path to the channel to connect to 217 @type channel: string 218 @param channelPassword: password to the channel, pass an empty string if the channel is not password protected 219 @type channelPassword: string 220 @param captureProfile: the name of the capture profile to use; pass an empty string to always use the default one 221 @type captureProfile: string 222 @param playbackProfile: the name of the playback profile to use; pass an empty string to always use the default one 223 @type playbackProfile: string 224 @param hotkeyProfile: the name of the hotkey profile to use; pass an empty string to always use the default one 225 @type hotkeyProfile: string 226 @param soundProfile: the name of the sound profile to use; pass an empty string to always use the default one 227 @type soundProfile: string 228 @param uniqueUserId: identity (name) to use; pass an empty string to always use the default one 229 @type uniqueUserId: string 230 @param oneTimeKey: privilege key to use on connect 231 @type oneTimeKey: string 232 @param phoneticName: phonetic nickname 233 @type phoneticName: string 234 @return: the errorcode 235 @rtype: int 236 """
237
238 -def createReturnCode(maxLen = 128):
239 """ 240 Creates a returnCode which can be passed to the other functions and will be passed to the event onServerErrorEvent. 241 @param maxLen: length of the buffer, passed to the clientlib to store the path to, default value is 256 242 @type maxLen: int 243 @return: the created returnCode 244 @rtype: string 245 """
246
247 -def destroyServerConnectionHandler(serverConnectionHandlerID):
248 """ 249 Destroys a server connection handler. 250 @param serverConnectionHandlerID: the ID of the serverconnection 251 @type serverConnectionHandlerID: int 252 @return: the errorcode 253 @rtype: int 254 """
255
256 -def flushChannelCreation(serverConnectionHandlerID, channelParentID, returnCode):
257 """ 258 Flushes the channel creation made by the setChannelVariable-functions to the server. 259 @param serverConnectionHandlerID: the ID of the serverconnection 260 @type serverConnectionHandlerID: int 261 @param channelParentID: the ID of the parent channel of the new channel 262 @type channelParentID: int 263 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 264 @type returnCode: string 265 @return: the errorcode 266 @rtype: int 267 """
268
269 -def flushChannelUpdates(serverConnectionHandlerID, channelID, returnCode):
270 """ 271 Flushes the changes made by the setChannelVariable-functions to the server. 272 @param serverConnectionHandlerID: the ID of the serverconnection 273 @type serverConnectionHandlerID: int 274 @param channelID: the ID of the channelID 275 @type channelID: int 276 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 277 @type returnCode: string 278 @return: the errorcode 279 @rtype: int 280 """
281
282 -def flushClientSelfUpdates(serverConnectionHandlerID, returnCode):
283 """ 284 Flushes the changes made by the setClientSelfVariable-functions to the server. 285 @param serverConnectionHandlerID: the ID of the serverconnection 286 @type serverConnectionHandlerID: int 287 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 288 @type returnCode: string 289 @return: the errorcode 290 @rtype: int 291 """
292
293 -def getAppPath(maxLen = 256):
294 """ 295 Returns the ts3 application path. 296 @param maxLen: length of the buffer, passed to the clientlib to store the path to, default value is 256 297 @type maxLen: int 298 @return: the application path 299 @rtype: string 300 """
301
302 -def getAvatar(serverConnectionHandlerID, clientID, maxLen = 256):
303 """ 304 Returns the path on the system to the avatar image file of a client. 305 @param serverConnectionHandlerID: the ID of the serverconnection 306 @type serverConnectionHandlerID: int 307 @param clientID: the ID of the client 308 @type clientID: int 309 @param maxLen: length of the buffer, passed to the clientlib to store the path to, default value is 256 310 @type maxLen: int 311 @return: a tuple, containing the errorcode and the path to the avatar 312 @rtype: tuple (int, string) 313 """
314
315 -def getAverageTransferSpeed(transferID):
316 """ 317 Returns the average transfer speed of a filetransfer. 318 @param transferID: the ID of the filetransfer 319 @type transferID: int 320 @return: a tuple, containing the errorcode and the speed 321 @rtype: tuple (int, float) 322 """
323
324 -def getBookmarkList():
325 """ 326 Returns the list of bookmarks. 327 @return: a tuple, containing the errorcode and a list of tuples (name, isFolder, uid, childs) 328 @rtype: tuple (int, [tuple (string, int or bool, string or None, [childs])]) 329 """
330
331 -def getCaptureDeviceList(modeID):
332 """ 333 Queries all available capture devices. 334 @param modeID: Defines the capture mode to use. 335 @type modeID: string 336 @return: A tuple, containing the errorcode and the list of capture devices as tuple (devicename, deviceid) 337 @rtype: tuple (int, [(string, string)]) 338 """
339
340 -def getCaptureModeList():
341 """ 342 Queries all available capture modes. 343 @return: A tuple, containing the errorcode and the list of capture modes 344 @rtype: tuple (int, [string]) 345 """
346
347 -def getChannelClientList(serverConnectionHandlerID, channelID):
348 """ 349 Returns all clients in a specified channel. 350 @param serverConnectionHandlerID: the ID of the serverconnection 351 @type serverConnectionHandlerID: int 352 @param channelID: the ID of the channel 353 @type channelID: int 354 @return: a tuple, containing the errorcode and a list of client IDs or None if the call failed 355 @rtype: tuple (int, [int]) or tuple(int, None) 356 """
357
358 -def getChannelConnectInfo(serverConnectionHandlerID, channelID, maxLen):
359 """ 360 Returns the channel connect info (path and password) of a channel. 361 @param serverConnectionHandlerID: the ID of the serverconnection 362 @type serverConnectionHandlerID: int 363 @param channelID: the ID of the channel 364 @type channelID: int 365 @param maxLen: length of the buffer, passed to the clientlib to store the path to, default value is 256 366 @type maxLen: int 367 @return: a tuple, containing the errorcode, the path and the password of a channel 368 @rtype: tuple (int, string, string) 369 """
370
371 -def getChannelIDFromChannelNames(serverConnectionHandlerID, channelNameArray):
372 """ 373 Returns the ID of a channel defined by its name. 374 @param serverConnectionHandlerID: the ID of the serverconnection 375 @type serverConnectionHandlerID: int 376 @param channelNameArray: list of strings, defining the position of the channel (['grandparent', 'parent', 'channel']) 377 @type channelNameArray: list [string] 378 @return: a tuple, containing the errorcode and the ID of the channel 379 @rtype: tuple (int, int) 380 """
381
382 -def getChannelList(serverConnectionHandlerID):
383 """ 384 Returns all channels on the server. 385 @param serverConnectionHandlerID: the ID of the serverconnection 386 @type serverConnectionHandlerID: int 387 @return: a tuple, containing the errorcode and a list of channel IDs 388 @rtype: tuple (int, [int]) 389 """
390
391 -def getChannelOfClient(serverConnectionHandlerID, clientID):
392 """ 393 Returns the channel of a client. 394 @param serverConnectionHandlerID: the ID of the serverconnection 395 @type serverConnectionHandlerID: int 396 @param clientID: the ID of the client 397 @type clientID: int 398 @return: a tuple, containing the errorcode and the channel 399 @rtype: tuple (int, int) 400 """
401
402 -def getChannelVariableAsInt(serverConnectionHandlerID, channelID, flag):
403 """ 404 Returns a channel variable as int value. 405 @param serverConnectionHandlerID: the ID of the serverconnection 406 @type serverConnectionHandlerID: int 407 @param channelID: the ID of the channel 408 @type channelID: int 409 @param flag: the flag to return 410 @type flag: int 411 @return: a tuple, containing the errorcode and the value of the flag 412 @rtype: tuple (int, int) 413 """
414
415 -def getChannelVariableAsString(serverConnectionHandlerID, channelID, flag):
416 """ 417 Returns a channel variable as string value. 418 @param serverConnectionHandlerID: the ID of the serverconnection 419 @type serverConnectionHandlerID: int 420 @param channelID: the ID of the channel 421 @type channelID: int 422 @param flag: the flag to return 423 @type flag: int 424 @return: a tuple, containing the errorcode and the value of the flag 425 @rtype: tuple (int, int) 426 """
427
428 -def getChannelVariableAsUInt64(serverConnectionHandlerID, channelID, flag):
429 """ 430 Returns a channel variable as unsigned long long int value. 431 @param serverConnectionHandlerID: the ID of the serverconnection 432 @type serverConnectionHandlerID: int 433 @param channelID: the ID of the channel 434 @type channelID: int 435 @param flag: the flag to return 436 @type flag: int 437 @return: a tuple, containing the errorcode and the value of the flag 438 @rtype: tuple (int, int) 439 """
440
441 -def getClientDisplayName(serverConnectionHandlerID, clientID, maxLen = 128):
442 """ 443 Returns the client display name receiving from the client's contacts settings. 444 @param serverConnectionHandlerID: the ID of the serverconnection 445 @type serverConnectionHandlerID: int 446 @param clientID: the ID of the client 447 @type clientID: int 448 @param maxLen: length of the buffer, passed to the clientlib to store the path to, default value is 128 449 @type maxLen: int 450 @return: a tuple, containing the errorcode and the display name 451 @rtype: tuple (int, string) 452 """
453
454 -def getClientID(serverConnectionHandlerID):
455 """ 456 Returns the own client ID on a given serverconnection. 457 @param serverConnectionHandlerID: the ID of the serverconnection 458 @type serverConnectionHandlerID: int 459 @return: a tuple, containing the errorcode and the client ID 460 @rtype: tuple (int, int) 461 """
462
463 -def getClientLibVersion():
464 """ 465 Returns the clientlib's version as string. 466 @return: A tuple, containing the errorcode and the result 467 @rtype: tuple (int, string) 468 """
469
470 -def getClientLibVersionNumber():
471 """ 472 Returns the clientlib's version number 473 @return: A tuple, containing the errorcode and the result 474 @rtype: tuple (int, int) 475 """
476
477 -def getClientList(serverConnectionHandlerID):
478 """ 479 Returns all clients in view on the server. 480 @param serverConnectionHandlerID: the ID of the serverconnection 481 @type serverConnectionHandlerID: int 482 @return: a tuple, containing the errorcode and the list of client IDs 483 @rtype: tuple (int, [int]) 484 """
485
486 -def getClientNeededPermission(serverConnectionHandlerID, permissionName):
487 """ 488 Returns the value of the client's needed permission. 489 @param serverConnectionHandlerID: the ID of the serverconnection 490 @type serverConnectionHandlerID: int 491 @param permissionName: name of the permission 492 @type permissionName: string 493 @return: a tuple, containing the errorcode and the value of the permission 494 @rtype: tuple (int, int) 495 """
496
497 -def getClientSelfVariableAsInt(serverConnectionHandlerID, flag):
498 """ 499 Returns the value of a given flag of the own client as int value. 500 @param serverConnectionHandlerID: the ID of the serverconnection 501 @type serverConnectionHandlerID: int 502 @param flag: the flag to return 503 @type flag: int 504 @return: a tuple, containing the errorcode and the value of the queried flag 505 @rtype: tuple (int, int) 506 """
507
508 -def getClientSelfVariableAsString(serverConnectionHandlerID, flag):
509 """ 510 Returns the value of a given flag of the own client as string. 511 @param serverConnectionHandlerID: the ID of the serverconnection 512 @type serverConnectionHandlerID: int 513 @param flag: the flag to return 514 @type flag: int 515 @return: a tuple, containing the errorcode and the value of the queried flag 516 @rtype: tuple (int, string) 517 """
518
519 -def getClientVariableAsInt(serverConnectionHandlerID, clientID, flag):
520 """ 521 Returns the value of a given flag of a client as int value. 522 @param serverConnectionHandlerID: the ID of the serverconnection 523 @type serverConnectionHandlerID: int 524 @param clientID: the ID of the client 525 @type clientID: int 526 @param flag: the flag to return 527 @type flag: int 528 @return: a tuple, containing the errorcode and the value of the flag 529 @rtype: tuple (int, int) 530 """
531
532 -def getClientVariableAsString(serverConnectionHandlerID, clientID, flag):
533 """ 534 Returns the value of a given flag of a client as string value. 535 @param serverConnectionHandlerID: the ID of the serverconnection 536 @type serverConnectionHandlerID: int 537 @param clientID: the ID of the client 538 @type clientID: int 539 @param flag: the flag to return 540 @type flag: int 541 @return: a tuple, containing the errorcode and the value of the flag 542 @rtype: tuple (int, string) 543 """
544
545 -def getClientVariableAsUInt64(serverConnectionHandlerID, clientID, flag):
546 """ 547 Returns the value of a given flag of a client as unsigned long long int value. 548 @param serverConnectionHandlerID: the ID of the serverconnection 549 @type serverConnectionHandlerID: int 550 @param clientID: the ID of the client 551 @type clientID: int 552 @param flag: the flag to return 553 @type flag: int 554 @return: a tuple, containing the errorcode and the value of the flag 555 @rtype: tuple (int, int) 556 """
557
558 -def getConfigPath(maxLen = 256):
559 """ 560 Returns the ts3 config path. 561 @param maxLen: length of the buffer, passed to the clientlib to store the path to, default value is 256 562 @type maxLen: int 563 @return: the config path 564 @rtype: string 565 """
566
567 -def getConnectionStatus(serverConnectionHandlerID):
568 """ 569 Returns the current connection status of a serverconnection. 570 @param serverConnectionHandlerID: the ID of the serverconnection 571 @type serverConnectionHandlerID: int 572 @return: a tuple, containing the errorcode and the connection status 573 @rtype: tuple (int, int) 574 """
575
576 -def getConnectionVariableAsDouble(serverConnectionHandlerID, clientID, flag):
577 """ 578 Returns a client's connection variable as python floating point variable. 579 @param serverConnectionHandlerID: the ID of the serverconnection 580 @type serverConnectionHandlerID: int 581 @param clientID: the ID of the client 582 @type clientID: int 583 @return: a tuple, containing the errorcode and the value of the flag 584 @rtype: tuple (int, double) 585 """
586
587 -def getConnectionVariableAsString(serverConnectionHandlerID, clientID, flag):
588 """ 589 Returns a client's connection variable as string variable. 590 @param serverConnectionHandlerID: the ID of the serverconnection 591 @type serverConnectionHandlerID: int 592 @param clientID: the ID of the client 593 @type clientID: int 594 @return: a tuple, containing the errorcode and the value of the flag 595 @rtype: tuple (int, string) 596 """
597
598 -def getConnectionVariableAsUInt64(serverConnectionHandlerID, clientID, flag):
599 """ 600 Returns a client's connection variable as unsigned long long int variable. 601 @param serverConnectionHandlerID: the ID of the serverconnection 602 @type serverConnectionHandlerID: int 603 @param clientID: the ID of the client 604 @type clientID: int 605 @return: a tuple, containing the errorcode and the value of the flag 606 @rtype: tuple (int, int) 607 """
608
609 -def getCurrentCaptureDeviceName(serverConnectionHandlerID):
610 """ 611 Queries the current playback device's name on a serverconnection. 612 @param serverConnectionHandlerID: ID of the serverconnection 613 @type serverConnectionHandlerID: int 614 @return: A tuple, containing the errorcode, the capture device's name and the status, if it's default 615 @rtype: tuple (int, string, int) 616 """
617
618 -def getCurrentCaptureMode(serverConnectionHandlerID):
619 """ 620 Queries the current capture mode on a serverconnection. 621 @param serverConnectionHandlerID: ID of the serverconnection 622 @type serverConnectionHandlerID: int 623 @return: A tuple, containing the errorcode and the current capture mode 624 @rtype: tuple (int, string) 625 """
626
627 -def getCurrentPlaybackDeviceName(serverConnectionHandlerID):
628 """ 629 Queries the current playback device's name on a serverconnection. 630 @param serverConnectionHandlerID: ID of the serverconnection 631 @type serverConnectionHandlerID: int 632 @return: A tuple, containing the errorcode, the playback device's name and the status, if it's default 633 @rtype: tuple (int, string, int) 634 """
635
636 -def getCurrentPlayBackMode(serverConnectionHandlerID):
637 """ 638 Queries the current playback mode on a serverconnection. 639 @param serverConnectionHandlerID: ID of the serverconnection 640 @type serverConnectionHandlerID: int 641 @return: A tuple, containing the errorcode and the current playback mode 642 @rtype: tuple (int, string) 643 """
644
645 -def getCurrentServerConnectionHandlerID():
646 """ 647 Returns the current serverconnection handler. 648 @return: the ID of the current serverconnection handler 649 @rtype: int 650 """
651
652 -def getCurrentTransferSpeed(transferID):
653 """ 654 Returns the current transfer speed of a filetransfer. 655 @param transferID: the ID of the filetransfer 656 @type transferID: int 657 @return: a tuple, containing the errorcode and the speed 658 @rtype: tuple (int, float) 659 """
660
661 -def getDefaultCaptureDevice(modeID):
662 """ 663 Queries the default capture device. 664 @param modeID: Defines the capture mode to use 665 @type modeID: string 666 @return: A tuple, containing the errorcode and the default capture device as tuple (devicename, deviceid) 667 @rtype: tuple (int, (string, string)) 668 """
669
670 -def getDefaultCaptureMode():
671 """ 672 Queries the default capture mode. 673 @return: A tuple, containing the errorcode and the default capture mode 674 @rtype: tuple (int, string) 675 """
676
677 -def getDefaultPlaybackDevice(modeID):
678 """ 679 Queries the default playback device. 680 @param modeID: Defines the playback mode to use 681 @type modeID: string 682 @return: A tuple, containing the errorcode and the default playback device as tuple (devicename, deviceid) 683 @rtype: tuple (int, (string, string)) 684 """
685
686 -def getDefaultPlayBackMode():
687 """ 688 Queries the default playback mode. 689 @return: A tuple, containing the errorcode and the default playback mode 690 @rtype: tuple (int, string) 691 """
692
693 -def getDirectories(path, maxLen = 256):
694 """ 695 Returns a list of subdirectories of a path as space-separated string. 696 @param path: the parent path 697 @type path: str 698 @param maxLen: length of the buffer, passed to the clientlib to store the path to, default value is 256 699 @type maxLen: int 700 @return: the resulting path 701 @rtype: string 702 """
703
704 -def getEncodeConfigValue(serverConnectionHandlerID, ident):
705 """ 706 Queries a speex encoder option. 707 @param serverConnectionHandlerID: the ID of the serverconnection 708 @type serverConnectionHandlerID: int 709 @param ident: the encoder option to be queried 710 @type ident: string 711 @return: A tuple, containing the errorcode and the flag's value 712 @rtype: tuple (int, string) 713 """
714
715 -def getErrorMessage(errorCode):
716 """ 717 Queries a printable error string for a specific error code. 718 @param errorCode: The error code returned from all Client Lib functions 719 @type errorCode: int 720 @return: A tuple, containing the errorcode and the resulting string 721 @rtype: tuple (int, string) 722 """
723
724 -def getHotkeyFromKeyword(keywords):
725 """ 726 Returns a list of hotkeys by its keywords. 727 @param keywords: a list of keywords 728 @type keywords: list[str] 729 @return: a tuple containing the errorcode and the list of hotkeys 730 @rtype: tuple(int, list[str]) 731 """
732
733 -def getParentChannelOfChannel(serverConnectionHandlerID, channelID):
734 """ 735 Returns the parent channel of another channel. 736 @param serverConnectionHandlerID: the ID of the serverconnection 737 @type serverConnectionHandlerID: int 738 @param channelID: the ID of the channel 739 @type channelID: int 740 @return: a tuple, containing the errorcode and the ID of the parent channel 741 @rtype: tuple (int, int) 742 """
743
744 -def getPermissionIDByName(serverConnectionHandlerID, permissionName):
745 """ 746 Returns the ID of a permission defined by its name. 747 @param serverConnectionHandlerID: the ID of the serverconnection 748 @type serverConnectionHandlerID: int 749 @param permissionName: name of the permission 750 @type permissionName: string 751 @return: a tuple, containing the errorcode and the ID of the permission 752 @rtype: tuple (int, int) 753 """
754
755 -def getPlaybackConfigValueAsFloat(serverConnectionHandlerID, ident):
756 """ 757 Queries a playback option. 758 @param serverConnectionHandlerID: the ID of the serverconnection 759 @type serverConnectionHandlerID: int 760 @param ident: the playback option to be queried 761 @type ident: string 762 @return: A tuple, containing the errorcode and the flag's value 763 @rtype: tuple (int, float) 764 """
765
766 -def getPlaybackDeviceList(modeID):
767 """ 768 Queries all available playback devices. 769 @param modeID: Defines the playback mode to use. 770 @type modeID: string 771 @return: A tuple, containing the errorcode and the list of playback devices as tuple (devicename, deviceid) 772 @rtype: tuple (int, [(string, string)]) 773 """
774
775 -def getPlaybackModeList():
776 """ 777 Queries all available playback modes. 778 @return: A tuple, containing the errorcode and the list of modes 779 @rtype: tuple (int, [string]) 780 """
781
782 -def getPluginPath(maxLen):
783 """ 784 Returns the TeamSpeak 3 client's pluginpath. 785 @param maxLen: the size of the buffer passed to the clientlib. Optional, defaults to 256 786 @type maxLen: int 787 @return: the pluginpath 788 @rtype: str 789 """
790
791 -def getPreProcessorInfoValue(serverConnectionHandlerID, ident):
792 """ 793 Querie a sound preprocessor flag and returns it as string. 794 @param serverConnectionHandlerID: the ID of the serverconnection 795 @type serverConnectionHandlerID: int 796 @param ident: the flag to be queried 797 @type ident: string 798 @return: A tuple, containing the errorcode and the value of the queried flag 799 @rtype: tuple (int, string) 800 """
801
802 -def getPreProcessorInfoValueFloat(serverConnectionHandlerID, ident):
803 """ 804 Queries a sound preprocessor flag and returns it as float. 805 @param serverConnectionHandlerID: the ID of the serverconnection 806 @type serverConnectionHandlerID: int 807 @param ident: the flag to be queried 808 @type ident: string 809 @return: A tuple, containing the errorcode and the value of the queried flag 810 @rtype: tuple (int, float) 811 """
812
813 -def getProfileList(profile):
814 """ 815 Returns a list of existing profiles and the default profile's index in list. 816 @param profile: the profile type, see ts3defines.PluginGuiProfile 817 @type profile: int 818 @return: a tuple, containing the errorcode, the default profile's index and the profile list 819 @rtype: tuple (int, int, [string]) 820 """
821
822 -def getResourcesPath(maxLen = 256):
823 """ 824 Returns the ts3 resources path. 825 @param maxLen: length of the buffer, passed to the clientlib to store the path to. Optional, defaults to 256 826 @type maxLen: int 827 @return: the resources path 828 @rtype: string 829 """
830
831 -def getServerConnectInfo(serverConnectionHandlerID, maxLen = 256):
832 """ 833 Returns the connect info (host, port and password) of a serverconnection. 834 @param serverConnectionHandlerID: the ID of the serverconnection 835 @type serverConnectionHandlerID: int 836 @param maxLen: length of the buffer, passed to the clientlib to store the path to, default value is 256 837 @type maxLen: int 838 @return: a tuple, containing the errorcode, the host, the port and the password of the serverconnection 839 @rtype: tuple (int, string, int, string) 840 """
841
842 -def getServerConnectionHandlerList():
843 """ 844 Returns a list of serverconnection handlers. 845 @return: a tuple, containing the errorcode and the list of serverconnection handler IDs 846 @rtype: tuple (int, [int]) 847 """
848
849 -def getServerVariableAsInt(serverConnectionHandlerID, flag):
850 """ 851 Returns a server variable as int value. 852 @param serverConnectionHandlerID: the ID of the serverconnection 853 @type serverConnectionHandlerID: int 854 @param flag: the flag to return 855 @type flag: int 856 @return: a tuple, containing the errorcode and the value of the flag 857 @rtype: tuple (int, int) 858 """
859
860 -def getServerVariableAsString(serverConnectionHandlerID, flag):
861 """ 862 Returns a server variable as string value. 863 @param serverConnectionHandlerID: the ID of the serverconnection 864 @type serverConnectionHandlerID: int 865 @param flag: the flag to return 866 @type flag: int 867 @return: a tuple, containing the errorcode and the value of the flag 868 @rtype: tuple (int, string) 869 """
870
871 -def getServerVariableAsUInt64(serverConnectionHandlerID, flag):
872 """ 873 Returns a server variable as unsigned long long int value. 874 @param serverConnectionHandlerID: the ID of the serverconnection 875 @type serverConnectionHandlerID: int 876 @param flag: the flag to return 877 @type flag: int 878 @return: a tuple, containing the errorcode and the value of the flag 879 @rtype: tuple (int, int) 880 """
881
882 -def getServerVersion(serverConnectionHandlerID):
883 """ 884 Returns the server version. 885 @param serverConnectionHandlerID: the ID of the serverconnection 886 @type serverConnectionHandlerID: int 887 @return: the server version 888 @rtype: int 889 """
890
891 -def getTransferFileName(transferID):
892 """ 893 Returns the filename of a filetransfer. 894 @param transferID: the ID of the filetransfer 895 @type transferID: int 896 @return: a tuple, containing the errorcode and the filename 897 @rtype: tuple (int, string) 898 """
899
900 -def getTransferFilePath(transferID):
901 """ 902 Returns the filepath of a filetransfer. 903 @param transferID: the ID of the filetransfer 904 @type transferID: int 905 @return: a tuple, containing the errorcode and the filepath 906 @rtype: tuple (int, string) 907 """
908
909 -def getTransferFileSize(transferID):
910 """ 911 Returns the total filesize (in Bytes) of a filetransfer. 912 @param transferID: the ID of the filetransfer 913 @type transferID: int 914 @return: a tuple, containing the errorcode and the filesize 915 @rtype: tuple (int, int) 916 """
917
918 -def getTransferFileSizeDone(transferID):
919 """ 920 Returns the already downloaded size (in Bytes) of a filetransfer. 921 @param transferID: the ID of the filetransfer 922 @type transferID: int 923 @return: a tuple, containing the errorcode and the size 924 @rtype: tuple (int, int) 925 """
926
927 -def getTransferRunTime(transferID):
928 """ 929 Returns the runtime of a filetransfer. 930 @param transferID: the ID of the filetransfer 931 @type transferID: int 932 @return: a tuple, containing the errorcode and the runtime in seconds 933 @rtype: tuple (int, int) 934 """
935
936 -def getTransferStatus(transferID):
937 """ 938 Returns the status of a filetransfer, whether if it is initialising, active or finished see ts3defines.FileTransferState 939 @param transferID: the ID of the filetransfer 940 @type transferID: int 941 @return: a tuple, containing the errorcode and the status 942 @rtype: tuple (int, int) 943 """
944
945 -def guiConnect(connectTab, serverLabel, serverAddress, serverPassword, nickname, channel, channelPassword, captureProfile, playbackProfile, hotkeyProfile, userIdentity, oneTimeKey, phoneticName):
946 """ 947 Connects to a server and displays it as tab in the client. 948 @param connectTab: defines, which tab will be used, see ts3defines.PluginConnectTab 949 @type connectTab: int 950 @param serverLabel: the label of the connection 951 @type serverLabel: string 952 @param serverAddress: host or ip address 953 @type serverAddress: string 954 @param serverPassword: password to the server, pass an empty string if the server is not password protected 955 @type serverPassword: string 956 @param nickname: the user's nickname 957 @type nickname: string 958 @param channel: complete path to the channel to connect to 959 @type channel: string 960 @param channelPassword: password to the channel, pass an empty string if the channel is not password protected 961 @type channelPassword: string 962 @param captureProfile: the name of the capture profile to use 963 @type captureProfile: string 964 @param playbackProfile: the name of the playback profile to use 965 @type playbackProfile: string 966 @param hotkeyProfile: the name of the hotkey profile to use 967 @type hotkeyProfile: string 968 @param userIdentity: identity to use 969 @type userIdentity: string 970 @param oneTimeKey: privilege key to use on connect 971 @type oneTimeKey: string 972 @param phoneticName: phonetic nickname 973 @type phoneticName: string 974 @return: a tuple, containing the errorcode and the ID of the created serverconnection handler 975 @rtype: tuple (int, int) 976 """
977
978 -def guiConnectBookmark(connectTab, bookmarkuuid):
979 """ 980 Connects to a server from a bookmark and displays it as tab in the client. 981 @param connectTab: defines, which tab will be used, see ts3defines.PluginConnectTab 982 @type connectTab: int 983 @param bookmarkuuid: UID of the bookmark 984 @type bookmarkuuid: string 985 @return: a tuple, containing the errorcode and the ID of the created serverconnection handler 986 @rtype: tuple (int, int) 987 """
988
989 -def haltTransfer(serverConnectionHandlerID, transferID, deleteUnfinishedFile, returnCode):
990 """ 991 Halts a currently running filetransfer. 992 @param serverConnectionHandlerID: the ID of the serverconnection 993 @type serverConnectionHandlerID: int 994 @param transferID: the ID of the filetransfer 995 @type transferID: int 996 @param deleteUnfinishedFile: if set to 1 (or True) and the file is not yet finished, it will be deleted; to prevent, pass 0 (or False) 997 @type deleteUnfinishedFile: int or bool 998 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 999 @type returnCode: string 1000 @return: the errorcode 1001 @rtype: int 1002 """
1003
1004 -def initiateGracefulPlaybackShutdown(serverConnectionHandlerID):
1005 """ 1006 Graceful shutdown the playback device on a serverconnection. 1007 @param serverConnectionHandlerID: the ID of the serverconnection 1008 @type serverConnectionHandlerID: int 1009 @return: the errorcode 1010 @rtype: int 1011 """
1012
1013 -def isReceivingWhisper(serverConnectionHandlerID, clientID):
1014 """ 1015 //FIXME: 1016 @param serverConnectionHandlerID: the ID of the serverconnection 1017 @type serverConnectionHandlerID: int 1018 @param clientID: the ID of the client 1019 @type clientID: int 1020 @return: a tuple, containing the errorcode and the status 1021 @rtype: tuple (int, int or bool) 1022 """
1023
1024 -def isTransferSender(transferID):
1025 """ 1026 Returns the upload/download direction of a filetransfer. 1027 @param transferID: the ID of the filetransfer 1028 @type transferID: int 1029 @return: a tuple, containing the errorcode and 1 if it's an upload or 0 if it's a download 1030 @rtype: tuple (int, int or bool) 1031 """
1032
1033 -def isWhispering(serverConnectionHandlerID, clientID):
1034 """ 1035 Returns the status of a client whether he is currently whispering to the own client. 1036 @param serverConnectionHandlerID: the ID of the serverconnection 1037 @type serverConnectionHandlerID: int 1038 @return: a tuple, containing the errorcode and the status 1039 @rtype: tuple (int, int or bool) 1040 """
1041
1042 -def logMessage(logMessage, severity, channel, logID):
1043 """ 1044 Logs a string. 1045 @param logMessage: Text which should be logged 1046 @type logMessage: string 1047 @param severity: The level of the message, warning or error. Defined by the class LogLevel 1048 @type severity: int 1049 @param channel: Custom text to categorize the message channel 1050 @type channel: string 1051 @param logID: ID of the serverconnection to identify the current server connection when using multiple connections, 0 if unused 1052 @type logID: int 1053 @return: The errorcode 1054 @rtype: int 1055 """
1056
1057 -def openCaptureDevice(serverConnectionHandlerID, modeID, captureDevice):
1058 """ 1059 Opens a playback device on a serverconnection. 1060 @param serverConnectionHandlerID: ID of the serverconnection on which the capture device should be initialized on 1061 @type serverConnectionHandlerID: int 1062 @param modeID: the playback mode to use 1063 @type modeID: string 1064 @param captureDevice: the id of the capture device 1065 @type captureDevice: string 1066 @return: the errorcode 1067 @rtype: int 1068 """
1069
1070 -def openPlaybackDevice(serverConnectionHandlerID, modeID, playbackDevice):
1071 """ 1072 Opens a playback device on a serverconnection. 1073 @param serverConnectionHandlerID: ID of the serverconnection on which the playback device should be initialized on 1074 @type serverConnectionHandlerID: int 1075 @param modeID: the playback mode to use 1076 @type modeID: string 1077 @param playbackDevice: the id of the playback device 1078 @type playbackDevice: string 1079 @return: the errorcode 1080 @rtype: int 1081 """
1082
1083 -def pauseWaveFileHandle(serverConnectionHandlerID, waveHandle, pause):
1084 """ 1085 Pauses a wavefile sound previously started with playWaveFileHandle. 1086 @param serverConnectionHandlerID: the ID of the serverConnection the sound is played on 1087 @type serverConnectionHandlerID: int 1088 @param waveHandle: the handle returned by playWaveFileHandle 1089 @type waveHandle: int 1090 @param pause: if set to 1 (or True), the sound will pause, 0 (or False) will unpause the sound 1091 @type pause: int or bool 1092 @return: the errorcode 1093 @rtype: int 1094 """
1095
1096 -def playWaveFile(serverConnectionHandlerID, path):
1097 """ 1098 Plays a wavefile sound on a serverconnection. 1099 @param serverConnectionHandlerID: the ID of the serverconnection 1100 @type serverConnectionHandlerID: int 1101 @param path: the path to the wavefile on the system 1102 @type path: string 1103 @return: the errorcode 1104 @rtype: int 1105 """
1106
1107 -def playWaveFileHandle(serverConnectionHandlerID, path, loop):
1108 """ 1109 Plays a wavefile sound on a serverconnection and returns a handle to it. 1110 @param serverConnectionHandlerID: the ID of the serverconnection on which the sound will be played on 1111 @type serverConnectionHandlerID: int 1112 @param path: the path to the wavefile on the system 1113 @type path: string 1114 @param loop: if set to 1 (or True), the sound will loop 1115 @type loop: int or bool 1116 @return: A tuple, containing the errorcode and the handle, with which the sound can be paused and unpaused 1117 @rtype: tuple (int, int) 1118 """
1119
1120 -def printMessage(serverConnectionHandlerID, message, messageTarget):
1121 """ 1122 Prints a message to a specific client chat tab. 1123 @param serverConnectionHandlerID: the ID of the serverconnection 1124 @type serverConnectionHandlerID: int 1125 @param message: the message to print 1126 @type message: string 1127 @param messageTarget: the target to send the message, see ts3defines.PluginMessageTarget 1128 @type messageTarget: int 1129 """
1130
1131 -def printMessageToCurrentTab(message):
1132 """ 1133 Prints a message to the currently visible tab. 1134 @param message: the message to send 1135 @type message: string 1136 """
1137
1138 -def privilegeKeyUse(serverConnectionHandlerID, tokenKey, returnCode):
1139 """ 1140 Uses a privilege key as the current client of the serverconnection. 1141 @param serverConnectionHandlerID: the ID of the serverconnection 1142 @type serverConnectionHandlerID: int 1143 @param tokenKey: the token 1144 @type tokenKey: string 1145 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1146 @type returnCode: string 1147 @return: the errorcode 1148 @rtype: int 1149 """
1150
1151 -def processCustomCaptureData(deviceName, buffer):
1152 """ 1153 Sends captured data from a custom device to the client libg 1154 @param deviceName: the name of the device capturing the data, previously registered with registerCustomDevice 1155 @type deviceName: string 1156 @param buffer: a list containing the buffered data 1157 @type buffer: list [int] 1158 @return: the errorcode 1159 @rtype: int 1160 """
1161
1162 -def registerCustomDevice(deviceID, deviceDisplayName, capFrequency, capChannels, playFrequency, playChannels):
1163 """ 1164 Registers a custom device, announcing the device ID and name to the Client Lib. 1165 @param deviceID: ID string of the custom device, under which the device can be later accessed 1166 @type deviceID: string 1167 @param deviceDisplayName: Displayed name of the custom device. Freely choose a name which identifies your device 1168 @type deviceDisplayName: string 1169 @param capFrequency: Frequency of the capture device 1170 @type capFrequency: int 1171 @param capChannels: Number of channels of the capture device. This value depends on if the used codec is a mono or stereo CodecEncryptionMode 1172 @type capChannels: int 1173 @param playFrequency: Frequency of the playback deviceDisplayName 1174 @type playFrequency: int 1175 @param playChannels: Number of channels of the playback device 1176 @type playChannels: int 1177 @return: the errorcode 1178 @rtype: int 1179 """
1180
1181 -def requestBanList(serverConnectionHandlerID, returnCode):
1182 """ 1183 Requests the banlist on a server. The event onBanListEvent will be triggered. 1184 @param serverConnectionHandlerID: the ID of the serverconnection 1185 @type serverConnectionHandlerID: int 1186 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1187 @type returnCode: string 1188 @return: the errorcode 1189 @rtype: int 1190 """
1191
1192 -def requestChannelAddPerm(serverConnectionHandlerID, channelID, permissionIDArray, permissionValueArray, returnCode):
1193 """ 1194 Adds a list of permissions to a channel. 1195 @param serverConnectionHandlerID: the ID of the serverconnection 1196 @type serverConnectionHandlerID: int 1197 @param channelID: the ID of the channel 1198 @type channelID: int 1199 @param permissionIDArray: a list of permission IDs 1200 @type permissionIDArray: list [int] 1201 @param permissionValueArray: list of permission values, in order of the permissions in permissionIDArray 1202 @type permissionValueArray: list [int] 1203 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1204 @type returnCode: string 1205 @return: the errorcode 1206 @rtype: int 1207 """
1208
1209 -def requestChannelClientAddPerm(serverConnectionHandlerID, channelID, clientDatabaseID, permissionIDArray, permissionValueArray, returnCode):
1210 """ 1211 Adds a list of permissions on a channel to a user. 1212 @param serverConnectionHandlerID: the ID of the serverconnection 1213 @type serverConnectionHandlerID: int 1214 @param channelID: the ID of the channel 1215 @type channelID: int 1216 @param clientDatabaseID: the database ID of the user 1217 @type clientDatabaseID: int 1218 @param permissionIDArray: a list of permission IDs 1219 @type permissionIDArray: list [int] 1220 @param permissionValueArray: list of permission values, in order of the permissions in permissionIDArray 1221 @type permissionValueArray: list [int] 1222 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1223 @type returnCode: string 1224 @return: the errorcode 1225 @rtype: int 1226 """
1227
1228 -def requestChannelClientDelPerm(serverConnectionHandlerID, channelID, clientDatabaseID, permissionIDArray, returnCode):
1229 """ 1230 Deletes a list of permissions of a user in a channel. 1231 @param serverConnectionHandlerID: the ID of the serverconnection 1232 @type serverConnectionHandlerID: int 1233 @param channelID: the ID of the channel 1234 @type channelID: int 1235 @param clientDatabaseID: the database ID of the user 1236 @type clientDatabaseID: int 1237 @param permissionIDArray: a list of permission IDs 1238 @type permissionIDArray: list [int] 1239 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1240 @type returnCode: string 1241 @return: the errorcode 1242 @rtype: int 1243 """
1244
1245 -def requestChannelClientPermList(serverConnectionHandlerID, channelID, clientDatabaseID, returnCode):
1246 """ 1247 Requests the list of permissions of a user in a channel. 1248 @param serverConnectionHandlerID: the ID of the serverconnection 1249 @type serverConnectionHandlerID: int 1250 @param channelID: the ID of the channel 1251 @type channelID: int 1252 @param clientDatabaseID: the database ID of the user 1253 @type clientDatabaseID: int 1254 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1255 @type returnCode: string 1256 @return: the errorcode 1257 @rtype: int 1258 """
1259
1260 -def requestChannelDelete(serverConnectionHandlerID, channelID, force, returnCode):
1261 """ 1262 Deletes a channel. 1263 @param serverConnectionHandlerID: the ID of the serverconnection 1264 @type serverConnectionHandlerID: int 1265 @param channelID: the ID of the channel to delete 1266 @type channelID: int 1267 @param force: if set to 1 (or True), the channel will be deleted even when it is not empty 1268 @type force: int or bool 1269 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1270 @type returnCode: string 1271 @return: the errorcode 1272 @rtype: int 1273 """
1274
1275 -def requestChannelDelPerm(serverConnectionHandlerID, channelID, permissionIDArray, returnCode):
1276 """ 1277 Deletes a list of permissions from a channel. 1278 @param serverConnectionHandlerID: the ID of the serverconnection 1279 @type serverConnectionHandlerID: int 1280 @param channelID: the ID of the channel 1281 @type channelID: int 1282 @param permissionIDArray: a list of permission IDs 1283 @type permissionIDArray: list [int] 1284 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1285 @type returnCode: string 1286 @return: the errorcode 1287 @rtype: int 1288 """
1289
1290 -def requestChannelDescription(serverConnectionHandlerID, channelID, returnCode):
1291 """ 1292 Requests the channel description of a channel. Afterwards, getChannelVariableAsString can return it. 1293 @param serverConnectionHandlerID: the ID of the serverconnection 1294 @type serverConnectionHandlerID: int 1295 @param channelID: the ID of the channel 1296 @type channelID: int 1297 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1298 @type returnCode: string 1299 @return: the errorcode 1300 @rtype: int 1301 """
1302
1303 -def requestChannelGroupAdd(serverConnectionHandlerID, groupName, groupType, returnCode):
1304 """ 1305 Adds a channelgroup. 1306 @param serverConnectionHandlerID: the ID of the serverconnection 1307 @type serverConnectionHandlerID: int 1308 @param groupName: the name of the channelgroup to create 1309 @type groupName: string 1310 @param groupType: type of the channelgroup, see ts3defines.GroupType 1311 @type groupType: int 1312 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1313 @type returnCode: string 1314 @return: the errorcode 1315 @rtype: int 1316 """
1317
1318 -def requestChannelGroupAddPerm(serverConnectionHandlerID, channelGroupID, continueonerror, permissionIDArray, permissionValueArray, returnCode):
1319 """ 1320 Adds a list of permissions to a channelgroup. 1321 @param serverConnectionHandlerID: the ID of the serverconnection 1322 @type serverConnectionHandlerID: int 1323 @param channelGroupID: the ID of the channelgroup 1324 @type channelGroupID: int 1325 @param continueonerror: if set to True, if an error with a permission occurs, the other permissions will even though be handled 1326 @type continueonerror: bool 1327 @param permissionIDArray: a list of permission IDs 1328 @type permissionIDArray: list [int] 1329 @param permissionValueArray: list of permission values, in order of the permissions in permissionIDArray 1330 @type permissionValueArray: list [int] 1331 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1332 @type returnCode: string 1333 @return: the errorcode 1334 @rtype: int 1335 """
1336
1337 -def requestChannelGroupDel(serverConnectionHandlerID, channelGroupID, force, returnCode):
1338 """ 1339 Deletes a channelgroup. 1340 @param serverConnectionHandlerID: the ID of the serverconnection 1341 @type serverConnectionHandlerID: int 1342 @param channelGroupID: the ID of the channelgroup 1343 @type channelGroupID: int 1344 @param force: if set to 1 (or True), even if there are users assigned to this channelgroup, it will be deleted 1345 @type force: int or bool 1346 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1347 @type returnCode: string 1348 @return: the errorcode 1349 @rtype: int 1350 """
1351
1352 -def requestChannelGroupDelPerm(serverConnectionHandlerID, channelGroupID, continueOnError, permissionIDArray, returnCode):
1353 """ 1354 Deletes a list of permissions from a channelgroup. 1355 @param serverConnectionHandlerID: the ID of the serverconnection 1356 @type serverConnectionHandlerID: int 1357 @param channelGroupID: the ID of the channelgroup 1358 @type channelGroupID: int 1359 @param continueOnError: if set to 1 (or True), if an error with a permission occurs, the other permissions will even though be handled 1360 @type continueOnError: int or bool 1361 @param permissionIDArray: a list of permission IDs 1362 @type permissionIDArray: list [int] 1363 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1364 @type returnCode: string 1365 @return: the errorcode 1366 @rtype: int 1367 """
1368
1369 -def requestChannelGroupList(serverConnectionHandlerID, returnCode):
1370 """ 1371 Requests the list of channelgroups. The events onChannelGroupListEvent and onChannelGroupListEvent will be triggered. 1372 @param serverConnectionHandlerID: the ID of the serverconnection 1373 @type serverConnectionHandlerID: int 1374 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1375 @type returnCode: string 1376 @return: the errorcode 1377 @rtype: int 1378 """
1379
1380 -def requestChannelGroupPermList(serverConnectionHandlerID, channelGroupID, returnCode):
1381 """ 1382 Requests the list of permissions assigned to a channelgroup. The events onChannelGroupPermListEvent and onChannelGroupPermListFinishedEvent will be triggered. 1383 @param serverConnectionHandlerID: the ID of the serverconnection 1384 @type serverConnectionHandlerID: int 1385 @param channelGroupID: the ID of the channelGroupID 1386 @type channelGroupID: int 1387 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1388 @type returnCode: string 1389 @return: the errorcode 1390 @rtype: int 1391 """
1392
1393 -def requestChannelMove(serverConnectionHandlerID, channelID, newChannelParentID, newChannelOrder, returnCode):
1394 """ 1395 Moves a channel to a new parent channel. 1396 @param serverConnectionHandlerID: the ID of the serverconnection 1397 @type serverConnectionHandlerID: int 1398 @param channelID: the ID of the channel to move 1399 @type channelID: int 1400 @param newChannelParentID: the ID of the new parent channel 1401 @type newChannelParentID: int 1402 @param newChannelOrder: Channel order defining where the channel should be sorted under the new parent. Pass 0 to sort the channel right after the parent 1403 @type newChannelOrder: int 1404 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1405 @type returnCode: string 1406 @return: the errorcode 1407 @rtype: int 1408 """
1409
1410 -def requestChannelPermList(serverConnectionHandlerID, channelID, returnCode):
1411 """ 1412 Requests the list of permissions assigned to a channel. The events onChannelPermListEvent and onChannelPermListFinishedEvent will be triggered. 1413 @param serverConnectionHandlerID: the ID of the serverconnection 1414 @type serverConnectionHandlerID: int 1415 @param channelID: the ID of the channel 1416 @type channelID: int 1417 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1418 @type returnCode: string 1419 @return: the errorcode 1420 @rtype: int 1421 """
1422
1423 -def requestChannelSubscribe(serverConnectionHandlerID, channelIDArray, returnCode):
1424 """ 1425 Subscribes to a list of channels to get notifications of the clients in them. 1426 @param serverConnectionHandlerID: the ID of the serverconnection 1427 @type serverConnectionHandlerID: int 1428 @param channelIDArray: a list of channel IDs 1429 @type channelIDArray: list [int] 1430 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1431 @type returnCode: string 1432 @return: the errorcode 1433 @rtype: int 1434 """
1435
1436 -def requestChannelSubscribeAll(serverConnectionHandlerID, returnCode):
1437 """ 1438 Subscribes to all channels on the server. 1439 @param serverConnectionHandlerID: the ID of the serverconnection 1440 @type serverConnectionHandlerID: int 1441 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1442 @type returnCode: string 1443 @return: the errorcode 1444 @rtype: int 1445 """
1446
1447 -def requestChannelUnsubscribe(serverConnectionHandlerID, channelIDArray, returnCode):
1448 """ 1449 Unsubscribes from a list channels. 1450 @param serverConnectionHandlerID: the ID of the serverconnection 1451 @type serverConnectionHandlerID: int 1452 @param channelIDArray: a list of channel IDs 1453 @type channelIDArray: list [int] 1454 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1455 @type returnCode: string 1456 @return: the errorcode 1457 @rtype: int 1458 """
1459
1460 -def requestChannelUnsubscribeAll(serverConnectionHandlerID, returnCode):
1461 """ 1462 Unsubscribes from all channels on the server. 1463 @param serverConnectionHandlerID: the ID of the serverconnection 1464 @type serverConnectionHandlerID: int 1465 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1466 @type returnCode: string 1467 @return: the errorcode 1468 @rtype: int 1469 """
1470
1471 -def requestClientAddPerm(serverConnectionHandlerID, clientDatabaseID, permissionIDArray, permissionValueArray, permissionSkipArray, returnCode):
1472 """ 1473 Adds a list of permissions to a user. 1474 @param serverConnectionHandlerID: the ID of the serverconnection 1475 @type serverConnectionHandlerID: int 1476 @param clientDatabaseID: the database ID of the user 1477 @type clientDatabaseID: int 1478 @param permissionIDArray: a list of permission IDs 1479 @type permissionIDArray: list [int] 1480 @param permissionValueArray: list of permission values, in order of the permissions in permissionIDArray 1481 @type permissionValueArray: list [int] 1482 @param permissionSkipArray: list of permission skip values, in order of the permissions in permissionIDArray 1483 @type permissionSkipArray: list [int] 1484 @return: the errorcode 1485 @rtype: int 1486 """
1487
1488 -def requestClientDBIDfromUID(serverConnectionHandlerID, clientUniqueIdentifier, returnCode):
1489 """ 1490 Requests the database ID of a client defined by the UID. The event onClientDBIDfromUIDEvent will be triggered. 1491 @param serverConnectionHandlerID: the ID of the serverconnection 1492 @type serverConnectionHandlerID: int 1493 @param clientUniqueIdentifier: the UID of the client 1494 @type clientUniqueIdentifier: string 1495 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1496 @type returnCode: string 1497 @return: the errorcode 1498 @rtype: int 1499 """
1500
1501 -def requestClientDelPerm(serverConnectionHandlerID, clientDatabaseID, permissionIDArray, returnCode):
1502 """ 1503 Deletes a list of permissions from a user. 1504 @param serverConnectionHandlerID: the ID of the serverconnection 1505 @type serverConnectionHandlerID: int 1506 @param clientDatabaseID: the database ID of the user 1507 @type clientDatabaseID: int 1508 @param permissionIDArray: a list of permission IDs 1509 @type permissionIDArray: list [int] 1510 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1511 @type returnCode: string 1512 @return: the errorcode 1513 @rtype: int 1514 """
1515
1516 -def requestClientEditDescription(serverConnectionHandlerID, clientID, clientDescription, returnCode):
1517 """ 1518 Sets the description of a client. 1519 @param serverConnectionHandlerID: the ID of the serverconnection 1520 @type serverConnectionHandlerID: int 1521 @param clientID: the ID of the client 1522 @type clientID: int 1523 @param clientDescription: the description to set 1524 @type clientDescription: string 1525 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1526 @type returnCode: string 1527 @return: the errorcode 1528 @rtype: int 1529 """
1530
1531 -def requestClientIDs(serverConnectionHandlerID, clientUniqueIdentifier, returnCode):
1532 """ 1533 Requests the client IDs for a given UID. Will trigger the event onClientIDsEvent. 1534 @param serverConnectionHandlerID: the ID of the serverconnection 1535 @type serverConnectionHandlerID: int 1536 @param clientUniqueIdentifier: the UID of the client 1537 @type clientUniqueIdentifier: string 1538 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1539 @type returnCode: string 1540 @return: the errorcode 1541 @rtype: int 1542 """
1543
1544 -def requestClientKickFromChannel(serverConnectionHandlerID, clientID, kickReason, returnCode):
1545 """ 1546 Kicks a client from its current channel to the default one. 1547 @param serverConnectionHandlerID: the ID of the serverconnection 1548 @type serverConnectionHandlerID: int 1549 @param clientID: the ID of the client to kick 1550 @type clientID: int 1551 @param kickReason: the reason for the kick 1552 @type kickReason: string 1553 @return: the errorcode 1554 @rtype: int 1555 """
1556
1557 -def requestClientKickFromServer(serverConnectionHandlerID, clientID, kickReason, returnCode):
1558 """ 1559 Kicks a client from the server. 1560 @param serverConnectionHandlerID: the ID of the serverconnection 1561 @type serverConnectionHandlerID: int 1562 @param clientID: the ID of the client to kick 1563 @type clientID: int 1564 @param kickReason: the reason for the kick 1565 @type kickReason: string 1566 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1567 @type returnCode: string 1568 @return: the errorcode 1569 @rtype: int 1570 """
1571
1572 -def requestClientMove(serverConnectionHandlerID, clientID, newChannelID, password, returnCode):
1573 """ 1574 Moves a client to a different channel. 1575 @param serverConnectionHandlerID: the ID of the serverconnection 1576 @type serverConnectionHandlerID: int 1577 @param clientID: the ID of the client to be moved 1578 @type clientID: int 1579 @param newChannelID: the ID of the channel moving the client to 1580 @type newChannelID: int 1581 @param password: password of the channel, leave empty if channel is not password protected 1582 @type password: string 1583 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1584 @type returnCode: string 1585 @return: the errorcode 1586 @rtype: int 1587 """
1588
1589 -def requestClientNamefromDBID(serverConnectionHandlerID, clientDatabaseID, returnCode):
1590 """ 1591 Requests the name of a client defined by the database ID. The event onClientNamefromDBIDEvent will be triggered. 1592 @param serverConnectionHandlerID: the ID of the serverconnection 1593 @type serverConnectionHandlerID: int 1594 @param clientDatabaseID: the database ID of the client 1595 @type clientDatabaseID: int 1596 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1597 @type returnCode: string 1598 @return: the errorcode 1599 @rtype: int 1600 """
1601
1602 -def requestClientNamefromUID(serverConnectionHandlerID, clientUniqueIdentifier, returnCode):
1603 """ 1604 Requests the name of a client defined by the UID. The event onClientNamefromUIDEvent will be triggered. 1605 @param serverConnectionHandlerID: the ID of the serverconnection 1606 @type serverConnectionHandlerID: int 1607 @param clientUniqueIdentifier: the UID of the client 1608 @type clientUniqueIdentifier: string 1609 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1610 @type returnCode: string 1611 @return: the errorcode 1612 @rtype: int 1613 """
1614
1615 -def requestClientPermList(serverConnectionHandlerID, clientDatabaseID, returnCode):
1616 """ 1617 Requests the list of permissions assigned to a user. The events 1618 @param serverConnectionHandlerID: the ID of the serverconnection 1619 @type serverConnectionHandlerID: int 1620 @param clientDatabaseID: the database ID of the user 1621 @type clientDatabaseID: int 1622 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1623 @type returnCode: string 1624 @return: the errorcode 1625 @rtype: int 1626 """
1627
1628 -def requestClientPoke(serverConnectionHandlerID, clientID, message, returnCode):
1629 """ 1630 Pokes a client with a given message. 1631 @param serverConnectionHandlerID: the ID of the serverconnection 1632 @type serverConnectionHandlerID: int 1633 @param clientID: the ID of the client 1634 @type clientID: int 1635 @param message: the message 1636 @type message: string 1637 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1638 @type returnCode: string 1639 @return: the errorcode 1640 @rtype: int 1641 """
1642
1643 -def requestClientSetIsTalker(serverConnectionHandlerID, clientID, isTalker, returnCode):
1644 """ 1645 Grants or revokes the talker flag of a client. 1646 @param serverConnectionHandlerID: the ID of the serverconnection 1647 @type serverConnectionHandlerID: int 1648 @param clientID: the ID of the client 1649 @type clientID: int 1650 @param isTalker: if set to 1 (or True) grants talker flag, if 0 (or False) revokes talker flag 1651 @type isTalker: int or bool 1652 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1653 @type returnCode: string 1654 @return: the errorcode 1655 @rtype: int 1656 """
1657
1658 -def requestClientSetWhisperList(serverConnectionHandlerID, clientID, targetChannelIDArray, targetClientIDArray, returnCode):
1659 """ 1660 Modifies the whisper list of a client. 1661 @param serverConnectionHandlerID: the ID of the serverconnection 1662 @type serverConnectionHandlerID: int 1663 @param clientID: the ID of the client whose whisperlist is modified. If set to 0, the own whisper list is modified 1664 @type clientID: int 1665 @param targetChannelIDArray: a list of channel IDs the client will whisper to. Pass None to clear it 1666 @type targetChannelIDArray: list [int] 1667 @param targetClientIDArray: a list of client IDs the client will whisper to. Pass None to clear it 1668 @type targetClientIDArray: list [int] 1669 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1670 @type returnCode: string 1671 @return: the errorcode 1672 @rtype: int 1673 """
1674
1675 -def requestClientVariables(serverConnectionHandlerID, clientID, returnCode):
1676 """ 1677 Requests latest data for a given client. The event onUpdateClientEvent will be triggered. 1678 @param serverConnectionHandlerID: the ID of the serverconnection 1679 @type serverConnectionHandlerID: int 1680 @param clientID: the ID of the client 1681 @type clientID: int 1682 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1683 @type returnCode: string 1684 @return: the errorcode 1685 @rtype: int 1686 """
1687
1688 -def requestComplainAdd(serverConnectionHandlerID, targetClientDatabaseID, complainReason, returnCode):
1689 """ 1690 Adds a complain to a user defined by his database ID. 1691 @param serverConnectionHandlerID: the ID of the serverconnection 1692 @type serverConnectionHandlerID: int 1693 @param targetClientDatabaseID: the database ID of the user 1694 @type targetClientDatabaseID: int 1695 @param complainReason: the reason for the complain 1696 @type complainReason: string 1697 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1698 @type returnCode: string 1699 @return: the errorcode 1700 @rtype: int 1701 """
1702
1703 -def requestComplainDel(serverConnectionHandlerID, targetClientDatabaseID, fromClientDatabaseID, returnCode):
1704 """ 1705 Deletes a complain to a user by a different user. 1706 @param serverConnectionHandlerID: the ID of the serverconnection 1707 @type serverConnectionHandlerID: int 1708 @param targetClientDatabaseID: the database ID of the complained user 1709 @type targetClientDatabaseID: int 1710 @param fromClientDatabaseID: the database ID of the complaining user 1711 @type fromClientDatabaseID: int 1712 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1713 @type returnCode: string 1714 @return: the errorcode 1715 @rtype: int 1716 """
1717
1718 -def requestComplainDelAll(serverConnectionHandlerID, targetClientDatabaseID, returnCode):
1719 """ 1720 Deletes all complains to a user. 1721 @param serverConnectionHandlerID: the ID of the serverconnection 1722 @type serverConnectionHandlerID: int 1723 @param targetClientDatabaseID: the database ID of the user 1724 @type targetClientDatabaseID: int 1725 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1726 @type returnCode: string 1727 @return: the errorcode 1728 @rtype: int 1729 """
1730
1731 -def requestComplainList(serverConnectionHandlerID, targetClientDatabaseID, returnCode):
1732 """ 1733 Requests the list of complains to a user. The event onComplainListEvent will be triggered. 1734 @param serverConnectionHandlerID: the ID of the serverconnection 1735 @type serverConnectionHandlerID: int 1736 @param targetClientDatabaseID: the database ID of the user 1737 @type targetClientDatabaseID: int 1738 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1739 @type returnCode: string 1740 @return: the errorcode 1741 @rtype: int 1742 """
1743
1744 -def requestConnectionInfo(serverConnectionHandlerID, clientID, returnCode):
1745 """ 1746 Requests the connection info of a client. The event onConnectionInfoEvent will be triggered. 1747 @param serverConnectionHandlerID: the ID of the serverconnection 1748 @type serverConnectionHandlerID: int 1749 @param clientID: the ID of the client 1750 @type clientID: int 1751 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1752 @type returnCode: string 1753 @return: the errorcode 1754 @rtype: int 1755 """
1756
1757 -def requestCreateDirectory(serverConnectionHandlerID, channelID, channelPW, directoryPath, returnCode):
1758 """ 1759 Creates a directory in a channel. 1760 @param serverConnectionHandlerID: the ID of the serverconnection 1761 @type serverConnectionHandlerID: int 1762 @param channelID: the ID of the channel 1763 @type channelID: int 1764 @param channelPW: the password of the channel, pass an empty string if channel is not password protected 1765 @type channelPW: string 1766 @param directoryPath: the complete path of the to be created directory 1767 @type directoryPath: string 1768 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1769 @type returnCode: string 1770 @return: the errorcode 1771 @rtype: int 1772 """
1773
1774 -def requestDeleteFile(serverConnectionHandlerID, channelID, channelPW, files, returnCode):
1775 """ 1776 Deletes a list of files in a channel. 1777 @param serverConnectionHandlerID: the ID of the serverconnection 1778 @type serverConnectionHandlerID: int 1779 @param channelID: the ID of the channel 1780 @type channelID: int 1781 @param channelPW: the password of the channel, pass an empty string if channel is not password protected 1782 @type channelPW: string 1783 @param files: a list of complete pathes of the file to delete 1784 @type files: list [string] 1785 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1786 @type returnCode: string 1787 @return: the errorcode 1788 @rtype: int 1789 """
1790
1791 -def requestFile(serverConnectionHandlerID, channelID, channelPW, file, overwrite, resume, destinationDirectory, returnCode):
1792 """ 1793 Starts a filedownload from the server. 1794 @param serverConnectionHandlerID: the ID of the serverconnection 1795 @type serverConnectionHandlerID: int 1796 @param channelID: the ID of the channel in which the file is placed in 1797 @type channelID: int 1798 @param channelPW: the password of the channel, pass an empty string if the channel is not password protected 1799 @type channelPW: string 1800 @param file: the complete path to the file in the channel 1801 @type file: string 1802 @param overwrite: if set to 1 (or True) and a file with that name already exists will be overwritten 1803 @type overwrite: int or bool 1804 @param resume: if set to 1 (or True), a previously started filetransfer can be resumed 1805 @type resume: int or bool 1806 @param destinationDirectory: the path to the directory, where the downloaded fill will be placed in 1807 @type destinationDirectory: strin 1808 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1809 @type returnCode: string 1810 @return: a tuple, containing the errorcode and the ID of the filetransfer 1811 @rtype: tuple (int, int) 1812 """
1813
1814 -def requestFileInfo(serverConnectionHandlerID, channelID, channelPW, file, returnCode):
1815 """ 1816 Requests the info to a file in a channel. The event onFileInfoEvent will be triggered. 1817 @param serverConnectionHandlerID: the ID of the serverconnection 1818 @type serverConnectionHandlerID: int 1819 @param channelID: the ID of the channel 1820 @type channelID: int 1821 @param channelPW: the password of the channel, pass an empty string if the channel is not password protected 1822 @type channelPW: string 1823 @param file: the complete path to the file 1824 @type file: string 1825 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1826 @type returnCode: string 1827 @return: the errorcode 1828 @rtype: int 1829 """
1830
1831 -def requestFileList(serverConnectionHandlerID, channelID, channelPW, path, returnCode):
1832 """ 1833 Requests the filelist of a channel. The events onFileListEvent and onFileListFinishedEvent will be triggered. 1834 @param serverConnectionHandlerID: the ID of the serverconnection 1835 @type serverConnectionHandlerID: int 1836 @param channelID: the ID of the channel 1837 @type channelID: int 1838 @param channelPW: the password of the channel, pass an empty string if the channel is not password protected 1839 @type channelPW: string 1840 @param path: the path of the directory to be listed, pass '/' for the root path 1841 @type path: string 1842 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1843 @type returnCode: string 1844 @return: the errorcode 1845 @rtype: int 1846 """
1847
1848 -def requestHotkeyInputDialog(keyword, isDown, qParentWindow):
1849 """ 1850 Shows the hotkeyinputdialog to set the hotkey for a hotkey keyword. When finished ts3plugin.onHotkeyRecordedEvent will be called with the recorded hotkey. 1851 @param keyword: the global keyword (see PluginHost.globalHotkeyKeyword) 1852 @type keyword: str 1853 @param isDown: if True, the hotkey will be triggered on keypress, on keyrelease otherwise 1854 @type isDown: bool 1855 @param qParentWindow: the window on which the dialog is shown modal to, optional 1856 @type qParentWindow: QWidget 1857 """
1858
1859 -def requestInfoUpdate(serverConnectionHandlerID, itemType, itemID):
1860 """ 1861 Requests to update the info data. 1862 @param serverConnectionHandlerID: the ID of the serverconnection 1863 @type serverConnectionHandlerID: int 1864 @param itemType: specifies, which info data update is requested, see ts3defines.PluginItemType 1865 @type itemType: int 1866 @param itemID: the ID of the item to update (only usefull if itemType != ts3defines.PluginItemType.PLUGIN_MENU_TYPE_GLOBAL) 1867 @type itemID: int 1868 @return: the errorcode 1869 @rtype: int 1870 """
1871
1872 -def requestIsTalker(serverConnectionHandlerID, isTalkerRequest, isTalkerRequestMessage, returnCode):
1873 """ 1874 Requests talk power or revokes the talk power request. 1875 @param serverConnectionHandlerID: the ID of the serverconnection 1876 @type serverConnectionHandlerID: int 1877 @param isTalkerRequest: if set to 1 (or True) requests talk power, if 0 (or False) revokes the talk power request 1878 @type isTalkerRequest: int or bool 1879 @param isTalkerRequestMessage: the message of the request 1880 @type isTalkerRequestMessage: string 1881 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1882 @type returnCode: string 1883 @return: the errorcode 1884 @rtype: int 1885 """
1886
1887 -def requestMessageAdd(serverConnectionHandlerID, toClientUID, subject, message, returnCode):
1888 """ 1889 Sends an offline message to another user. 1890 @param serverConnectionHandlerID: the ID of the serverconnection 1891 @type serverConnectionHandlerID: int 1892 @param toClientUID: the UID of the user 1893 @type toClientUID: string 1894 @param subject: the subject of the message 1895 @type subject: string 1896 @param message: the message 1897 @type message: string 1898 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1899 @type returnCode: string 1900 @return: the errorcode 1901 @rtype: int 1902 """
1903
1904 -def requestMessageDel(serverConnectionHandlerID, messageID, returnCode):
1905 """ 1906 Deletes an offline message. 1907 @param serverConnectionHandlerID: the ID of the serverconnection 1908 @type serverConnectionHandlerID: int 1909 @param messageID: the ID of the message 1910 @type messageID: int 1911 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1912 @type returnCode: string 1913 @return: the errorcode 1914 @rtype: int 1915 """
1916
1917 -def requestMessageGet(serverConnectionHandlerID, messageID, returnCode):
1918 """ 1919 Requests an offline message defined by its ID. The event onMessageGetEvent will be triggered. 1920 @param serverConnectionHandlerID: the ID of the serverconnection 1921 @type serverConnectionHandlerID: int 1922 @param messageID: the ID of the message 1923 @type messageID: int 1924 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1925 @type returnCode: string 1926 @return: the errorcode 1927 @rtype: int 1928 """
1929
1930 -def requestMessageList(serverConnectionHandlerID, returnCode):
1931 """ 1932 Requests the list of offline messages. The event onMessageListEvent will be triggered. 1933 @param serverConnectionHandlerID: the ID of the serverconnection 1934 @type serverConnectionHandlerID: int 1935 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1936 @type returnCode: string 1937 @return: the errorcode 1938 @rtype: int 1939 """
1940
1941 -def requestMessageUpdateFlag(serverConnectionHandlerID, messageID, flag, returnCode):
1942 """ 1943 Sets the message read/unread flag of an offline message 1944 @param serverConnectionHandlerID: the ID of the serverconnection 1945 @type serverConnectionHandlerID: int 1946 @param messageID: the ID of the message 1947 @type messageID: int 1948 @param flag: set to 0 to set message as unread, set to 1 to set message as read 1949 @type flag: 1950 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1951 @type returnCode: string 1952 @return: the errorcode 1953 @rtype: int 1954 """
1955
1956 -def requestMuteClients(serverConnectionHandlerID, clientIDArray, returnCode):
1957 """ 1958 Mutes a list of clients. 1959 @param serverConnectionHandlerID: the ID of the serverconnection 1960 @type serverConnectionHandlerID: int 1961 @param clientIDArray: a list of client IDs 1962 @type clientIDArray: list [int] 1963 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1964 @type returnCode: string 1965 @return: the errorcode 1966 @rtype: int 1967 """
1968
1969 -def requestPermissionList(serverConnectionHandlerID, returnCode):
1970 """ 1971 Requests the list of permissions available on the server. The events onPermissionListEvent and onPermissionListFinishedEvent will be triggered. 1972 @param serverConnectionHandlerID: the ID of the serverconnection 1973 @type serverConnectionHandlerID: int 1974 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1975 @type returnCode: string 1976 @return: the errorcode 1977 @rtype: int 1978 """
1979
1980 -def requestPermissionOverview(serverConnectionHandlerID, clientDBID, channelID, returnCode):
1981 """ 1982 Requests the permission overview of a user in a channel. The events onPermissionOverviewEvent and onPermissionOverviewFinishedEvent will be triggered. 1983 @param serverConnectionHandlerID: the ID of the serverconnection 1984 @type serverConnectionHandlerID: int 1985 @param clientDBID: the database ID of the user 1986 @type clientDBID: int 1987 @param channelID: the ID of the channel 1988 @type channelID: int 1989 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 1990 @type returnCode: string 1991 @return: the errorcode 1992 @rtype: int 1993 """
1994
1995 -def requestRenameFile(serverConnectionHandlerID, fromChannelID, channelPW, toChannelID, toChannelPW, oldFile, newFile, returnCode):
1996 """ 1997 Renames a file or moves it to another channel. 1998 @param serverConnectionHandlerID: the ID of the serverconnection 1999 @type serverConnectionHandlerID: int 2000 @param fromChannelID: the ID of the channel, the file is currently placed in 2001 @type fromChannelID: int 2002 @param channelPW: the password of the channel, the file is currently placed in, pass an empty string if channel is not password protected 2003 @type channelPW: string 2004 @param toChannelID: the ID of the channel, the file should be placed in after, pass 0, if just renaming, not moving 2005 @type toChannelID: int 2006 @param toChannelPW: 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 2007 @type toChannelPW: string 2008 @param oldFile: the complete path to the file 2009 @type oldFile: string 2010 @param newFile: the complete path to the new filename 2011 @type newFile: string 2012 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2013 @type returnCode: string 2014 @return: the errorcode 2015 @rtype: int 2016 """
2017
2018 -def requestSendChannelTextMsg(serverConnectionHandlerID, message, targetChannelID, returnCode):
2019 """ 2020 Sends a text message to all clients in a channel. 2021 @param serverConnectionHandlerID: the ID of the serverconnection 2022 @type serverConnectionHandlerID: int 2023 @param message: the message to send 2024 @type message: string 2025 @param targetChannelID: the ID of the channel 2026 @type targetChannelID: int 2027 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2028 @type returnCode: string 2029 @return: the errorcode 2030 @rtype: int 2031 """
2032
2033 -def requestSendClientQueryCommand(serverConnectionHandlerID, command, returnCode):
2034 """ 2035 Requests to execute a clientquery command. 2036 @param serverConnectionHandlerID: the ID of the serverconnection 2037 @type serverConnectionHandlerID: int 2038 @param command: the command to execute 2039 @type command: string 2040 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2041 @type returnCode: string 2042 @return: the errorcode 2043 @rtype: int 2044 """
2045
2046 -def requestSendPrivateTextMsg(serverConnectionHandlerID, message, targetClientID, returnCode):
2047 """ 2048 Sends a private text message to a client. 2049 @param serverConnectionHandlerID: the ID of the serverconnection 2050 @type serverConnectionHandlerID: int 2051 @param message: the message to send 2052 @type message: string 2053 @param targetClientID: the ID of the client to send the message to 2054 @type targetClientID: int 2055 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2056 @type returnCode: string 2057 @return: the errorcode 2058 @rtype: int 2059 """
2060
2061 -def requestSendServerTextMsg(serverConnectionHandlerID, message, returnCode):
2062 """ 2063 Sends a text message to all clients on the server. 2064 @param serverConnectionHandlerID: the ID of the serverconnection 2065 @type serverConnectionHandlerID: int 2066 @param message: the message to send 2067 @type message: string 2068 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2069 @type returnCode: string 2070 @return: the errorcode 2071 @rtype: int 2072 """
2073
2074 -def requestServerGroupAdd(serverConnectionHandlerID, groupName, groupType, returnCode):
2075 """ 2076 Adds a servergroup. 2077 @param serverConnectionHandlerID: the ID of the serverconnection 2078 @type serverConnectionHandlerID: int 2079 @param groupName: the name of the group to create 2080 @type groupName: string 2081 @param groupType: type of the servergroup, see ts3defines.GroupType 2082 @type groupType: int 2083 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2084 @type returnCode: string 2085 @return: the errorcode 2086 @rtype: int 2087 """
2088
2089 -def requestServerGroupAddClient(serverConnectionHandlerID, serverGroupID, clientDatabaseID, returnCode):
2090 """ 2091 Adds a user defined by his database ID to a servergroup. 2092 @param serverConnectionHandlerID: the ID of the serverconnection 2093 @type serverConnectionHandlerID: int 2094 @param serverGroupID: the ID of the servergroup 2095 @type serverGroupID: int 2096 @param clientDatabaseID: the database ID of the user 2097 @type clientDatabaseID: int 2098 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2099 @type returnCode: string 2100 @return: the errorcode 2101 @rtype: int 2102 """
2103
2104 -def requestServerGroupAddPerm(serverConnectionHandlerID, serverGroupID, continueonerror, permissionIDArray, permissionValueArray, permissionNegatedArray, permissionSkipArray, returnCode):
2105 """ 2106 Adds a list of permissions to a servergroup. 2107 @param serverConnectionHandlerID: the ID of the serverconnection 2108 @type serverConnectionHandlerID: int 2109 @param serverGroupID: the ID of the servergroup 2110 @type serverGroupID: int 2111 @param continueonerror: if set to 1 (or True), if an error with a permission occurs, the other permissions will even though be handled 2112 @type continueonerror: int or bool 2113 @param permissionIDArray: list of permission IDs 2114 @type permissionIDArray: list [int] 2115 @param permissionValueArray: list of permission values, in order of the permissions in permissionIDArray 2116 @type permissionValueArray: list [int] 2117 @param permissionNegatedArray: list of permission negated values, in order of the permissions in permissionIDArray 2118 @type permissionNegatedArray: list [int] 2119 @param permissionSkipArray: list of permission skip values, in order of the permissions in permissionIDArray 2120 @type permissionSkipArray: list [int] 2121 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2122 @type returnCode: string 2123 @return: the errorcode 2124 @rtype: int 2125 """
2126
2127 -def requestServerGroupClientList(serverConnectionHandlerID, serverGroupID, withNames, returnCode):
2128 """ 2129 Requests the list of clients assigned to a servergroup. The event onServerGroupClientListEvent will be triggered. 2130 @param serverConnectionHandlerID: the ID of the serverconnection 2131 @type serverConnectionHandlerID: int 2132 @param serverGroupID: the ID of the servergroup 2133 @type serverGroupID: int 2134 @param withNames: if set to 1 (or True), the event will contain the nick and uid of the user instead of empty strings 2135 @type withNames: int or bool 2136 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2137 @type returnCode: string 2138 @return: the errorcode 2139 @rtype: int 2140 """
2141
2142 -def requestServerGroupDel(serverConnectionHandlerID, serverGroupID, force, returnCode):
2143 """ 2144 Deletes a servergroup. 2145 @param serverConnectionHandlerID: the ID of the serverconnection 2146 @type serverConnectionHandlerID: int 2147 @param serverGroupID: the ID of the servergroup 2148 @type serverGroupID: int 2149 @param force: if set to 1 (or True), even if there are users assigned to this servergroup, it will be deleted 2150 @type force: int or bool 2151 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2152 @type returnCode: string 2153 @return: the errorcode 2154 @rtype: int 2155 """
2156
2157 -def requestServerGroupDelClient(serverConnectionHandlerID, serverGroupID, clientDatabaseID, returnCode):
2158 """ 2159 Deletes a user defined by his database ID from a servergroup. 2160 @param serverConnectionHandlerID: the ID of the serverconnection 2161 @type serverConnectionHandlerID: int 2162 @param serverGroupID: the ID of the servergroup 2163 @type serverGroupID: int 2164 @param clientDatabaseID: the database ID of the user 2165 @type clientDatabaseID: int 2166 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2167 @type returnCode: string 2168 @return: the errorcode 2169 @rtype: int 2170 """
2171
2172 -def requestServerGroupDelPerm(serverConnectionHandlerID, serverGroupID, continueOnError, permissionIDArray, returnCode):
2173 """ 2174 Deletes a list of permissions from a servergroup. 2175 @param serverConnectionHandlerID: the ID of the serverconnection 2176 @type serverConnectionHandlerID: int 2177 @param serverGroupID: the ID of the servergroup 2178 @type serverGroupID: int 2179 @param continueOnError: if set to 1 (or True), if an error with a permission occurs, the other permissions will even though be handled 2180 @type continueOnError: int or bool 2181 @param permissionIDArray: list of permission IDs 2182 @type permissionIDArray: list [int] 2183 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2184 @type returnCode: string 2185 @return: the errorcode 2186 @rtype: int 2187 """
2188
2189 -def requestServerGroupList(serverConnectionHandlerID, returnCode):
2190 """ 2191 Requests the list of servergroups. The events onServerGroupListEvent and onServerGroupListFinishedEvent will be triggered. 2192 @param serverConnectionHandlerID: the ID of the serverconnection 2193 @type serverConnectionHandlerID: int 2194 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2195 @type returnCode: string 2196 @return: the errorcode 2197 @rtype: int 2198 """
2199
2200 -def requestServerGroupPermList(serverConnectionHandlerID, serverGroupID, returnCode):
2201 """ 2202 Requests the list of permissions assigned to a servergroup. The events onServerGroupPermListEvent and onServerGroupPermListFinishedEvent will be triggered. 2203 @param serverConnectionHandlerID: the ID of the serverconnection 2204 @type serverConnectionHandlerID: int 2205 @param serverGroupID: the ID of the servergroup 2206 @type serverGroupID: int 2207 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2208 @type returnCode: string 2209 @return: the errorcode 2210 @rtype: int 2211 """
2212
2213 -def requestServerGroupsByClientID(serverConnectionHandlerID, clientDatabaseID, returnCode):
2214 """ 2215 Requests all servergroups of a user defined by his database ID. The event onServerGroupByClientIDEvent will be triggered. 2216 @param serverConnectionHandlerID: the ID of the serverconnection 2217 @type serverConnectionHandlerID: int 2218 @param clientDatabaseID: the database ID of the user 2219 @type clientDatabaseID: int 2220 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2221 @type returnCode: string 2222 @return: the errorcode 2223 @rtype: int 2224 """
2225
2226 -def requestServerTemporaryPasswordAdd(serverConnectionHandlerID, password, description, duration, targetChannelID, targetChannelPW, returnCode):
2227 """ 2228 Adds a temporary password to the server. 2229 @param serverConnectionHandlerID: the ID of the serverconnection 2230 @type serverConnectionHandlerID: int 2231 @param password: the temporary password 2232 @type password: string 2233 @param description: the description of the temporary password 2234 @type description: string 2235 @param duration: the duration in seconds 2236 @type duration: int 2237 @param targetChannelID: the ID of the channel to which the accessing clients will join by default 2238 @type targetChannelID: int 2239 @param targetChannelPW: the password of the targetChannel, pass an empty string, if the channel is not password protected 2240 @type targetChannelPW: string 2241 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2242 @type returnCode: string 2243 @return: the errorcode 2244 @rtype: int 2245 """
2246
2247 -def requestServerTemporaryPasswordDel(serverConnectionHandlerID, password, returnCode):
2248 """ 2249 Deletes an existing temporary password. 2250 @param serverConnectionHandlerID: the ID of the serverconnection 2251 @type serverConnectionHandlerID: int 2252 @param password: the password to delete 2253 @type password: string 2254 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2255 @type returnCode: string 2256 @return: the errorcode 2257 @rtype: int 2258 """
2259
2260 -def requestServerTemporaryPasswordList(serverConnectionHandlerID, returnCode):
2261 """ 2262 Requests a list of existing temporary passwords. The event onServerTemporaryPasswordListEvent will be triggered. 2263 @param serverConnectionHandlerID: the ID of the serverconnection 2264 @type serverConnectionHandlerID: int 2265 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2266 @type returnCode: string 2267 @return: the errorcode 2268 @rtype: int 2269 """
2270
2271 -def requestServerVariables(serverConnectionHandlerID):
2272 """ 2273 Requests all server variables of a serverconnection. The event onServerUpdatedEvent will be triggered. 2274 @param serverConnectionHandlerID: the ID of the serverconnection 2275 @type serverConnectionHandlerID: int 2276 @return: the errorcode 2277 @rtype: int 2278 """
2279
2280 -def requestSetClientChannelGroup(serverConnectionHandlerID, channelGroupIDArray, channelIDArray, clientDatabaseIDArray, returnCode):
2281 """ 2282 Adds a list of users to a list of channelgroups. 2283 @param serverConnectionHandlerID: the ID of the serverconnection 2284 @type serverConnectionHandlerID: int 2285 @param channelGroupIDArray: a list of channelgroup IDs 2286 @type channelGroupIDArray: list [int] 2287 @param channelIDArray: a list of channel IDs 2288 @type channelIDArray: list [int] 2289 @param clientDatabaseIDArray: a list of client database IDs 2290 @type clientDatabaseIDArray: list [int] 2291 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2292 @type returnCode: string 2293 @return: the errorcode 2294 @rtype: int 2295 """
2296
2297 -def requestUnmuteClients(serverConnectionHandlerID, clientIDArray, returnCode):
2298 """ 2299 Unmutes a list of clients. 2300 @param serverConnectionHandlerID: the ID of the serverconnection 2301 @type serverConnectionHandlerID: int 2302 @param clientIDArray: a list of client IDs 2303 @type clientIDArray: list [int] 2304 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2305 @type returnCode: string 2306 @return: the errorcode 2307 @rtype: int 2308 """
2309
2310 -def sendFile(serverConnectionHandlerID, channelID, channelPW, file, overwrite, resume, sourceDirectory, returnCode):
2311 """ 2312 Starts a fileupload to the server. 2313 @param serverConnectionHandlerID: the ID of the serverconnection 2314 @type serverConnectionHandlerID: int 2315 @param channelID: the ID of the channel in which the file will be placed in 2316 @type channelID: int 2317 @param channelPW: the password of the channel, pass an empty string if the channel is not password protected 2318 @type channelPW: string 2319 @param file: the complete path to the file in the channel 2320 @type file: string 2321 @param overwrite: if set to 1 (or True) and a file with that name already exists will be overwritten 2322 @type overwrite: int or bool 2323 @param resume: if set to 1 (or True), a previously started filetransfer can be resumed 2324 @type resume: int or bool 2325 @param sourceDirectory: the directory on the system, where the original file is placed in 2326 @type sourceDirectory: string 2327 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2328 @type returnCode: string 2329 @return: a tuple, containing the errorcode and the ID of the filetransfer 2330 @rtype: tuple (int, int) 2331 """
2332
2333 -def sendPluginCommand(serverConnectionHandlerID, command, targetMode, targetIDs, returnCode):
2334 """ 2335 Sends a plugin command to other users. 2336 @param serverConnectionHandlerID: the ID of the serverconnection 2337 @type serverConnectionHandlerID: int 2338 @param command: the command string 2339 @type command: string 2340 @param targetMode: specifies, to whom the command will be send, see ts3defines.PluginTargetMode 2341 @type targetMode: int 2342 @param targetIDs: a list of client IDs, only needed if targetMode == ts3defines.PluginTargetMode.PluginCommandTarget_CLIENT 2343 @type targetIDs: list [int] 2344 @return: the errorcode (as this is wrapped in python, there could be errors) 2345 @rtype: int 2346 """
2347
2348 -def serverPropertyStringToFlag(serverPropertyString):
2349 """ 2350 Converts a server property name used in strings (eg the serverquery) to the corresponding flag. 2351 @param serverPropertyString: the lowercase string representation 2352 @type serverPropertyString: str 2353 @return: a tuple, containing the errorcode and the flag (see ts3defines.ClientProperties and ts3defines.ClientPropertiesRare) 2354 @rtype: tuple (int, int) 2355 """
2356
2357 -def set3DWaveAttributes(serverConnectionHandlerID, waveHandle, position):
2358 """ 2359 Positions a wave file that was opened previously with playWaveFileHandle in 3D space. 2360 @param serverConnectionHandlerID: the ID of the serverconnection 2361 @type serverConnectionHandlerID: int 2362 @param waveHandle: handle of the played wavefile sound returned by playWaveFileHandle 2363 @type waveHandle: int 2364 @param position: A tuple defining the 3D position of the sound 2365 @type position: tuple (float, float, float) 2366 @return: the errorcode 2367 @rtype: int 2368 """
2369
2370 -def setChannelVariableAsInt(serverConnectionHandlerID, channelID, flag, value):
2371 """ 2372 Sets a channel variable to a new int value. 2373 @param serverConnectionHandlerID: the ID of the serverconnection 2374 @type serverConnectionHandlerID: int 2375 @param channelID: the ID of the channel, pass 0 to set a new channel's variables 2376 @type channelID: int 2377 @param flag: the flag to set 2378 @type flag: int 2379 @param value: the new value 2380 @type value: int 2381 @return: the errorcode 2382 @rtype: int 2383 """
2384
2385 -def setChannelVariableAsString(serverConnectionHandlerID, channelID, flag, value):
2386 """ 2387 Sets a channel variable to a new string value. 2388 @param serverConnectionHandlerID: the ID of the serverconnection 2389 @type serverConnectionHandlerID: int 2390 @param channelID: the ID of the channel, pass 0 to set a new channel's variables 2391 @type channelID: int 2392 @param flag: the flag to set 2393 @type flag: int 2394 @param value: the new value 2395 @type value: int 2396 @return: the errorcode 2397 @rtype: int 2398 """
2399
2400 -def setChannelVariableAsUInt64(serverConnectionHandlerID, channelID, flag, value):
2401 """ 2402 Sets a channel variable to a new unsigned long long int value. 2403 @param serverConnectionHandlerID: the ID of the serverconnection 2404 @type serverConnectionHandlerID: int 2405 @param channelID: the ID of the channel, pass 0 to set a new channel's variables 2406 @type channelID: int 2407 @param flag: the flag to set 2408 @type flag: int 2409 @param value: the new value 2410 @type value: int 2411 @return: the errorcode 2412 @rtype: int 2413 """
2414
2415 -def setClientSelfVariableAsInt(serverConnectionHandlerID, flag, value):
2416 """ 2417 Sets a variable of the own client to a new int value. 2418 @param serverConnectionHandlerID: the ID of the serverconnection 2419 @type serverConnectionHandlerID: int 2420 @param flag: the flag to set 2421 @type flag: int 2422 @param value: the new value 2423 @type value: int 2424 @return: the errorcode 2425 @rtype: int 2426 """
2427
2428 -def setClientSelfVariableAsString(serverConnectionHandlerID, flag, value):
2429 """ 2430 Sets a variable of the own client to a new string value. 2431 @param serverConnectionHandlerID: the ID of the serverconnection 2432 @type serverConnectionHandlerID: int 2433 @param flag: the flag to set 2434 @type flag: int 2435 @param value: the new value 2436 @type value: string 2437 @return: the errorcode 2438 @rtype: int 2439 """
2440
2441 -def setClientVolumeModifier(serverConnectionHandlerID, clientID, value):
2442 """ 2443 Sets the volume modifier of a client. 2444 @param serverConnectionHandlerID: the ID of the serverconnection 2445 @type serverConnectionHandlerID: int 2446 @param clientID: the client's ID 2447 @type clientID: int 2448 @param value: the value to set 2449 @type value: float 2450 @return: the errorcode 2451 @rtype: int 2452 """
2453
2454 -def setPlaybackConfigValue(serverConnectionHandlerID, ident, value):
2455 """ 2456 Sets a playback option. 2457 @param serverConnectionHandlerID: the ID of the serverconnection 2458 @type serverConnectionHandlerID: int 2459 @param ident: the playback option to reset 2460 @type ident: string 2461 @param value: the value to set 2462 @type value: string 2463 @return: the errorcode 2464 @rtype: int 2465 """
2466
2467 -def setPluginMenuEnabled(menuID, enabled):
2468 """ 2469 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. 2470 @param menuID: global id of the menuitem 2471 @type menuID: int 2472 @param enabled: set to True to enable it, False otherwise 2473 @type enabled: bool 2474 """
2475
2476 -def setPreProcessorConfigValue(serverConnectionHandlerID, ident, value):
2477 """ 2478 Sets a sound preprocessor flag. 2479 @param serverConnectionHandlerID: the ID of the serverconnection 2480 @type serverConnectionHandlerID: int 2481 @param ident: the flag to be set 2482 @type ident: string 2483 @param value: the value to set the flag to 2484 @type value: string 2485 @return: the errorcode 2486 @rtype: int 2487 """
2488
2489 -def showHotkeySetup():
2490 """ 2491 Opens the hotkey settings in the TeamSpeak 3 client's settings dialog. 2492 """
2493
2494 -def spawnNewServerConnectionHandler(port):
2495 """ 2496 Creates a new server connection handler and receive its ID. 2497 @param port: Port the client should bind on. Specify zero to let the operating system chose any free port 2498 @type port: int 2499 @return: A tuple, containig the errorcode and the resulting ID 2500 @rtype: tuple (int, int) 2501 """
2502
2503 -def startConnection(serverConnectionHandlerID, identity, ip, port, nickname, defaultChannelArray, defaultChannelPassword, serverPassword):
2504 """ 2505 Starts a connection to the given server. 2506 @param serverConnectionHandlerID: the ID of the serverconnection 2507 @type serverConnectionHandlerID: int 2508 @param identity: the client's identity 2509 @type identity: string 2510 @param ip: hostname or ip of the server 2511 @type ip: string 2512 @param port: port of the server 2513 @type port: int 2514 @param nickname: the client's nickname 2515 @type nickname: string 2516 @param defaultChannelArray: list of strings defining the path to a channel on the server, pass empty list to join in server's default channel 2517 @type defaultChannelArray: list [string] 2518 @param defaultChannelPassword: password of the default channel, pass an empty string if not using defaultChannelArray or channel is not password protected 2519 @type defaultChannelPassword: string 2520 @param serverPassword: password of the server, pass an empty string if the server is not password protected 2521 @type serverPassword: string 2522 @return: the errorcode 2523 @rtype: int 2524 """
2525
2526 -def startVoiceRecording(serverConnectionHandlerID):
2527 """ 2528 Sets the voice recording flag of the own client on a serverconnection. 2529 @param serverConnectionHandlerID: the ID of the serverconnection 2530 @type serverConnectionHandlerID: int 2531 @return: the errorcode 2532 @rtype: int 2533 """
2534
2535 -def stopConnection(serverConnectionHandlerID, quitMessage):
2536 """ 2537 Stops the connection of a serverconnection. 2538 @param serverConnectionHandlerID: the ID of the serverconnection 2539 @type serverConnectionHandlerID: int 2540 @param quitMessage: a message displayed when leaving the server encoded in UTF-8 2541 @type quitMessage: string 2542 @return: the errorcode 2543 @rtype: int 2544 """
2545
2546 -def stopVoiceRecording(serverConnectionHandlerID):
2547 """ 2548 Removes the voice recording flag of the own client on a serverconnection 2549 @param serverConnectionHandlerID: the ID of the serverconnection 2550 @type serverConnectionHandlerID: int 2551 @return: the errorcode 2552 @rtype: int 2553 """
2554
2555 -def systemset3DListenerAttributes(serverConnectionHandlerID, position, forward, up):
2556 """ 2557 Sets the position, velocity and orientation of the own client in 3D space 2558 @param serverConnectionHandlerID: the ID of the serverconnection 2559 @type serverConnectionHandlerID: int 2560 @param position: A tuple defining the 3D position, pass None to ignore 2561 @type position: tuple (float, float, float) 2562 @param forward: 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. 2563 @type forward: tuple (float, float, float) 2564 @param up: 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. 2565 @type up: tuple (float, float, float) 2566 @return: the errorcode 2567 @rtype: int 2568 """
2569
2570 -def systemset3DSettings(serverConnectionHandlerID, distanceFactor, rolloffScale):
2571 """ 2572 Adjust 3D sound system settings. 2573 @param serverConnectionHandlerID: the ID of the serverconnection 2574 @type serverConnectionHandlerID: int 2575 @param distanceFactor: relative distance factor. Default is 1.0 = 1 meter 2576 @type distanceFactor: float 2577 @param rolloffScale: 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. 2578 @type rolloffScale: float 2579 @return: the errorcode 2580 @rtype: int 2581 """
2582
2583 -def unregisterCustomDevice(deviceID):
2584 """ 2585 Unregisters a custom device, previously registered with registerCustomDevice. 2586 @param deviceID: the ID of the device, used in registerCustomDevice 2587 @type deviceID: string 2588 @return: the errorcode 2589 @rtype: int 2590 """
2591
2592 -def urlsToBB(text, maxLen = 256):
2593 """ 2594 Converts an url to the BB-code respresentation. 2595 @param text: the url 2596 @type text: string 2597 @param maxLen: length of the buffer, passed to the clientlib to store the path to, default value is 256 2598 @type maxLen: int 2599 @return: the BB-code representation 2600 @rtype: string 2601 """
2602
2603 -def verifyChannelPassword(serverConnectionHandlerID, channelID, channelPassword, returnCode):
2604 """ 2605 Verifies the password to a channel. The result can be checked in onServerErrorEvent. 2606 @param serverConnectionHandlerID: the ID of the serverconnection 2607 @type serverConnectionHandlerID: int 2608 @param channelID: the ID of the channel 2609 @type channelID: int 2610 @param channelPassword: the password to be verified 2611 @type channelPassword: string 2612 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2613 @type returnCode: string 2614 @return: the errorcode 2615 @rtype: int 2616 """
2617
2618 -def verifyServerPassword(serverConnectionHandlerID, serverPassword, returnCode):
2619 """ 2620 Verifies the password to a server. The result can be checked in onServerErrorEvent. 2621 @param serverConnectionHandlerID: the ID of the serverconnection 2622 @type serverConnectionHandlerID: int 2623 @param serverPassword: the password to be verified 2624 @type serverPassword: string 2625 @param returnCode: returnCode passed to onServerErrorEvent or onServerPermissionErrorEvent. Optional. 2626 @type returnCode: string 2627 @return: the errorcode 2628 @rtype: int 2629 """
2630