![]() | Library Class |
Namespace: TeamSpeak.Sdk.Client
The Library type exposes the following members.
Name | Description | |
---|---|---|
![]() ![]() | ClientPasswordEncrypt |
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.
|
![]() ![]() | Connections |
List of all currently existing server connections
|
![]() ![]() | CustomDevices |
List of all currently existing custom devices
|
![]() ![]() | CustomPacketDecrypt |
Decrypts incoming data
|
![]() ![]() | CustomPacketEncrypt |
Encrypts outgoing data
|
![]() ![]() | FunctionRarePointers |
Unused by SDK
|
![]() ![]() | IsInitialized |
true if the TeamSpeak library has been loaded and initialized; otherwise, false
|
![]() ![]() | LogFileFolder |
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.
|
![]() ![]() | LogLevel |
The minimum severity of log messages that are passed to UserLogMessage |
![]() ![]() | NativeBinary |
Location to the TeamSpeak library binary.
|
![]() ![]() | Platform |
Platform the library is running on
|
![]() ![]() | ResourcesFolder |
Path pointing to the directory where the soundbackends folder is located.
|
![]() ![]() | SpeedLimitDown |
To get the download speed limit for all virtual servers in bytes/s
|
![]() ![]() | SpeedLimitUp |
To get the upload speed limit for all virtual servers in bytes/s
|
![]() ![]() | UsedLogTypes |
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.
|
![]() ![]() | Version |
The complete Client Lib version string can be queried with
|
![]() ![]() | VersionNumber |
Version number, a part of the complete version string
|
Name | Description | |
---|---|---|
![]() ![]() | CreateCustomDevice |
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).
|
![]() ![]() | CreateIdentity |
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.
|
![]() ![]() | Destroy |
Releases the unmanaged resources used by the Library |
![]() ![]() | GetCaptureDevices |
Get capture devices available for the given mode, as well as the current operating systems default.
|
![]() ![]() | GetCaptureModes |
Query all available capture modes
|
![]() ![]() | GetErrorMessage |
Gets a descriptive text message for a error-code
|
![]() ![]() | GetPlaybackDevices |
Get playback devices available for the given mode, as well as the current operating systems default.
|
![]() ![]() | GetPlaybackModes |
Query all available playback modes
|
![]() ![]() | IdentityToUniqueIdentifier |
Generate the unique identifier of a identity
|
![]() ![]() | Initialize |
Initializes the TeamSpeak clientlib
|
![]() ![]() | Initialize(LibraryParameters) |
Creates a new Library-Instance
|
![]() ![]() | Initialize(LogTypes) |
Initializes the TeamSpeak clientlib
|
![]() ![]() | Log |
Basic logging function.
|
![]() ![]() | SpawnNewConnection |
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.
|
Name | Description | |
---|---|---|
![]() ![]() | SoundDeviceListChanged |
Called when the list of sound devices returned by GetCaptureDevices(String) and GetPlaybackDevices(String) was changed
|
![]() ![]() | UserLogMessage |
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
|