TeamSpeak 3 Client SDK Developer Manual Revision 2012-07-30 16:09:12 Copyright © 2007-2012 TeamSpeak Systems GmbH Table of Contents Copyright .................................................................................................................................................... 2 License agreement ................................................................................................................................ 2 Introduction ................................................................................................................................................. 5 System requirements ..................................................................................................................................... 5 Overview of header files ................................................................................................................................ 5 Calling Client Lib functions ........................................................................................................................... 6 Return code ......................................................................................................................................... 6 Initializing ................................................................................................................................................... 7 The callback mechanism ........................................................................................................................ 8 Querying the library version ........................................................................................................................... 9 Shutting down ............................................................................................................................................ 10 Managing server connection handlers ............................................................................................................. 10 Connecting to a server ................................................................................................................................. 11 Disconnecting from a server ......................................................................................................................... 16 Error handling ............................................................................................................................................ 17 Logging ..................................................................................................................................................... 19 User-defined logging ........................................................................................................................... 20 Using playback and capture modes and devices ................................................................................................ 21 Initializing modes and devices ............................................................................................................... 21 Querying available modes and devices .................................................................................................... 23 Checking current modes and devices ...................................................................................................... 26 Closing devices .................................................................................................................................. 27 Using custom devices .......................................................................................................................... 29 Activating the capture device ................................................................................................................ 32 Sound codecs ............................................................................................................................................. 33 Encoder options .......................................................................................................................................... 34 Preprocessor options .................................................................................................................................... 35 Playback options ......................................................................................................................................... 38 Accessing the voice buffer ........................................................................................................................... 41 Voice recording .................................................................................................................................. 44 Playing wave files ....................................................................................................................................... 45 3D Sound .................................................................................................................................................. 47 Query available servers, channels and clients ................................................................................................... 51 Retrieve and store information ...................................................................................................................... 54 Client information ............................................................................................................................... 54 Information related to own client ................................................................................................... 54 Information related to other clients ................................................................................................. 60 Whisper lists .............................................................................................................................. 62 Channel information ............................................................................................................................ 64 Channel voice data encryption ....................................................................................................... 70 1 TeamSpeak 3 Client SDK Developer Manual Channel sorting .......................................................................................................................... 71 Server information .............................................................................................................................. 72 Interacting with the server ............................................................................................................................ 75 Joining a channel ................................................................................................................................ 75 Creating a new channel ........................................................................................................................ 78 Deleting a channel .............................................................................................................................. 80 Moving a channel ............................................................................................................................... 81 Text chat ........................................................................................................................................... 82 Sending ..................................................................................................................................... 83 Receiving .................................................................................................................................. 84 Kicking clients ................................................................................................................................... 85 Channel subscriptions .......................................................................................................................... 88 Muting clients locally .................................................................................................................................. 90 Custom encryption ...................................................................................................................................... 91 Other events ............................................................................................................................................... 93 Miscellaneous functions ............................................................................................................................... 95 FAQ ......................................................................................................................................................... 96 How to implement Push-To-Talk? ......................................................................................................... 97 How to adjust the volume? ................................................................................................................... 98 Index ........................................................................................................................................................ 99 Copyright Copyright © 2007-2012 TeamSpeak Systems GmbH. All rights reserved. TeamSpeak Systems GmbH Soiernstrasse 1 82494 Krün Germany Visit TeamSpeak-Systems on the web at www.teamspeak.com [http://www.teamspeak.com] License agreement TeamSpeak 3 LICENSE AGREEMENT October 25th, 2007 THIS IS A LEGAL AGREEMENT between "you," the company or end user