Click or drag to resize
Library Class
TeamSpeak Client Library
Inheritance Hierarchy
SystemObject
  TeamSpeak.Sdk.ClientLibrary

Namespace:  TeamSpeak.Sdk.Client
Assembly:  TeamSpeak.Sdk (in TeamSpeak.Sdk.dll) Version: 0.1.6124.20226 (0.1.0.0)
Syntax
public static class Library

The Library type exposes the following members.

Properties
  NameDescription
Public propertyStatic memberClientPasswordEncrypt
Used to hash the password in the same way it is hashed in the outside data store. Or just return the password to send the clear text to the server.
Public propertyStatic memberConnections
List of all currently existing server connections
Public propertyStatic memberCustomDevices
List of all currently existing custom devices
Public propertyStatic memberCustomPacketDecrypt
Decrypts incoming data
Public propertyStatic memberCustomPacketEncrypt
Encrypts outgoing data
Public propertyStatic memberFunctionRarePointers
Unused by SDK
Public propertyStatic memberIsInitialized
true if the TeamSpeak library has been loaded and initialized; otherwise, false
Public propertyStatic memberLogFileFolder
Defines the location where the logs are written to. Pass null for the default behavior, which is to use a folder called logs in the current working directory.
Public propertyStatic memberLogLevel
The minimum severity of log messages that are passed to UserLogMessage
Public propertyStatic memberNativeBinary
Location to the TeamSpeak library binary.
Public propertyStatic memberPlatform
Platform the library is running on
Public propertyStatic memberResourcesFolder
Path pointing to the directory where the soundbackends folder is located.
Public propertyStatic memberSpeedLimitDown
To get the download speed limit for all virtual servers in bytes/s
Public propertyStatic memberSpeedLimitUp
To get the upload speed limit for all virtual servers in bytes/s
Public propertyStatic memberUsedLogTypes
The library can output log messages (called by Log(LogLevel, String, Connection, String)) to a file (located in the logs directory relative to the client executable), to stdout or to user defined callbacks.
Public propertyStatic memberVersion
The complete Client Lib version string can be queried with
Public propertyStatic memberVersionNumber
Version number, a part of the complete version string
Top
Methods
  NameDescription
Public methodStatic memberCreateCustomDevice
Instead of opening existing sound devices that TeamSpeak has detected, you can also use our custom capture and playback mechanism to allow you to override the way in which TeamSpeak does capture and playback. When you have opened a custom capture and playback device you must regularly supply new "captured" sound data via ProcessData(Int16, Int32) and retrieve data that should be "played back" via AcquireData(Int16, Int32). Where exactly this captured sound data comes from and where the playback data goes to is up to you, which allows a lot of cool things to be done with this mechanism. A custom device can be opened like any standard device with OpenCapture(ISoundDevice) and OpenPlayback(ISoundDevice).
Public methodStatic memberCreateIdentity
To connect to a server, a client application is required to request an identity from the Library. This string should be requested only once and then locally stored in the applications configuration. The next time the application connects to a server, the identity should be read from the configuration and reused again.
Public methodStatic memberDestroy
Releases the unmanaged resources used by the Library
Public methodStatic memberGetCaptureDevices
Get capture devices available for the given mode, as well as the current operating systems default.
Public methodStatic memberGetCaptureModes
Query all available capture modes
Public methodStatic memberGetErrorMessage
Gets a descriptive text message for a error-code
Public methodStatic memberGetPlaybackDevices
Get playback devices available for the given mode, as well as the current operating systems default.
Public methodStatic memberGetPlaybackModes
Query all available playback modes
Public methodStatic memberIdentityToUniqueIdentifier
Generate the unique identifier of a identity
Public methodStatic memberInitialize
Initializes the TeamSpeak clientlib
Public methodStatic memberInitialize(LibraryParameters)
Creates a new Library-Instance
Public methodStatic memberInitialize(LogTypes)
Initializes the TeamSpeak clientlib
Public methodStatic memberLog
Basic logging function.
Public methodStatic memberSpawnNewConnection
Before connecting to a TeamSpeak 3 server, a new Connection needs to be spawned. With a Connection a connection can be established and dropped multiple times, so for simply reconnecting to the same or another server no new Connection needs to be spawned but existing ones can be reused. However, for using multiple connections simultaneously a new Connection has to be spawned for each connection.
Top
Events
  NameDescription
Public eventStatic memberSoundDeviceListChanged
Called when the list of sound devices returned by GetCaptureDevices(String) and GetPlaybackDevices(String) was changed
Public eventStatic memberUserLogMessage
If user-defined logging was enabled when initializing the Client Lib by setting Userlogging in UsedLogTypes, log messages will be sent to the callback, which allows user customizable logging and handling
Top
See Also