Index

## Index

### Symbols

3D sound, 3D Sound

### A

AGC, Preprocessor options
architecture, Architecture overview
Automatic Gain Control, Preprocessor options

### B

bandwidth, Sound codecs

### C

callback, The callback mechanism
calling convention, System requirements
capture device, Using playback and capture modes and devices
Channel order, Channel sorting
client ID, Connecting to a server
codec, Sound codecs
contact, Copyright
copyright, Copyright

### E

echo canceling, Preprocessor options
encoder, Encoder options
enums
  ChannelProperties, Channel information
  ClientProperties, Information related to own client, Information related to other clients
  ConnectStatus, Connecting to a server, Disconnecting from a server, Channel sorting
  InputDeactivationStatus, FAQ
  LogLevel, Logging
  LogType, Initializing, User-defined logging
  TextMessageTargetMode, Sending, Receiving
  VirtualServerProperties, Server information
  Visibility, Joining a channel, Kicking clients, Channel subscriptions
error codes, Overview of header files
events
  onChannelDescriptionUpdateEvent, Other events
  onChannelMoveEvent, Moving a channel
  onChannelPasswordChangedEvent, Other events
  onChannelSubscribeEvent, Channel subscriptions
  onChannelSubscribeFinishedEvent, Channel subscriptions
  onChannelUnsubscribeEvent, Channel subscriptions
  onChannelUnsubscribeFinishedEvent, Channel subscriptions
  onClientKickFromChannelEvent, Kicking clients
  onClientKickFromServerEvent, Kicking clients
  onClientMoveEvent, Joining a channel
  onClientMoveMovedEvent, Joining a channel
  onClientMoveSubscriptionEvent, Channel subscriptions
  onClientMoveTimeoutEvent, Other events
  onConnectStatusChangeEvent, Connecting to a server, Disconnecting from a server
  onCustomCaptureDeviceCloseEvent, Using custom FMOD system objects
  onCustomPacketDecryptEvent, Custom encryption
  onCustomPacketEncryptEvent, Custom encryption
  onCustomPlaybackDeviceCloseEvent, Using custom FMOD system objects
  onDelChannelEvent, Deleting a channel
  onFMODChannelCreatedEvent, Customizing FMOD channel objects
  onNewChannelCreatedEvent, Creating a new channel
  onNewChannelEvent, Connecting to a server
  onPlaybackShutdownCompleteEvent, Closing devices
  onServerEditedEvent, Server information
  onServerErrorEvent, Return code, Error handling
  onServerStopEvent, Disconnecting from a server
  onServerUpdatedEvent, Server information
  onTalkStatusChangeEvent, Other events
  onTextMessageEvent, Receiving
  onUpdateChannelEditedEvent, Channel information
  onUpdateChannelEvent, Other events
  onUpdateClientEvent, Information related to other clients
  onUserLoggingMessageEvent, User-defined logging
  onVoiceRecordDataEvent, Voice recording

### F

FAQ, FAQ
functions
  ts3client_activateCaptureDevice, Activating the capture device
  ts3client_activateCustomCaptureDevice, Using custom FMOD system objects
  ts3client_closeCaptureDevice, Closing devices
  ts3client_closePlaybackDevice, Closing devices
  ts3client_createIdentity, Connecting to a server
  ts3client_destroyClientLib, Shutting down
  ts3client_destroyServerConnectionHandler, Managing server connection handlers
  ts3client_flushChannelCreation, Creating a new channel
  ts3client_flushChannelUpdates, Channel information
  ts3client_flushClientSelfUpdates, Information related to own client
  ts3client_fmod_Channelset3DAttributes, 3D Sound
  ts3client_fmod_Systemset3DListenerAttributes, 3D Sound
  ts3client_fmod_Systemset3DSettings, 3D Sound
  ts3client_freeMemory, Miscellaneous functions
  ts3client_getCaptureDeviceList, Querying available modes and devices
  ts3client_getCaptureModeList, Querying available modes and devices
  ts3client_getChannelClientList, Query available servers, channels and clients
  ts3client_getChannelIDFromChannelNames, Channel information
  ts3client_getChannelList, Query available servers, channels and clients
  ts3client_getChannelOfClient, Query available servers, channels and clients
  ts3client_getChannelVariableAsInt, Channel information
  ts3client_getChannelVariableAsString, Channel information
  ts3client_getClientID, Connecting to a server, Information related to own client
  ts3client_getClientLibVersion, Querying the library version
  ts3client_getClientList, Query available servers, channels and clients
  ts3client_getClientSelfVariableAsInt, Information related to own client
  ts3client_getClientSelfVariableAsString, Information related to own client
  ts3client_getClientVariableAsInt, Information related to other clients
  ts3client_getClientVariableAsString, Information related to other clients
  ts3client_getConnectionStatus, Connecting to a server
  ts3client_getCurrentCaptureDevice, Querying the current FMOD System objects
  ts3client_getCurrentCaptureDeviceName, Checking current modes and devices
  ts3client_getCurrentCaptureMode, Checking current modes and devices
  ts3client_getCurrentPlaybackDevice, Querying the current FMOD System objects
  ts3client_getCurrentPlaybackDeviceName, Checking current modes and devices
  ts3client_getCurrentPlayBackMode, Checking current modes and devices
  ts3client_getDefaultCaptureDevice, Querying available modes and devices
  ts3client_getDefaultCaptureMode, Querying available modes and devices
  ts3client_getDefaultPlaybackDevice, Querying available modes and devices
  ts3client_getDefaultPlayBackMode, Querying available modes and devices
  ts3client_getEncodeConfigValue, Encoder options
  ts3client_getErrorMessage, Error handling
  ts3client_getParentChannelOfChannel, Query available servers, channels and clients
  ts3client_getPlaybackConfigValueAsFloat, Playback options
  ts3client_getPlaybackDeviceList, Querying available modes and devices
  ts3client_getPlaybackModeList, Querying available modes and devices
  ts3client_getPreProcessorConfigValue, Preprocessor options
  ts3client_getPreProcessorInfoValueFloat, Preprocessor options
  ts3client_getServerConnectionHandlerList, Query available servers, channels and clients
  ts3client_getServerVariableAsInt, Server information
  ts3client_getServerVariableAsString, Server information
  ts3client_getServerVariableAsUInt64, Server information
  ts3client_initClientLib, Initializing
  ts3client_initiateGracefulPlaybackShutdown, Closing devices
  ts3client_logMessage, Logging
  ts3client_openCaptureDevice, Initializing modes and devices
  ts3client_openCustomCaptureDevice, Using custom FMOD system objects
  ts3client_openCustomPlaybackDevice, Using custom FMOD system objects
  ts3client_openPlaybackDevice, Initializing modes and devices
  ts3client_requestChannelDelete, Deleting a channel
  ts3client_requestChannelDescription, Channel information
  ts3client_requestChannelMove, Moving a channel
  ts3client_requestChannelSubscribe, Channel subscriptions
  ts3client_requestChannelSubscribeAll, Channel subscriptions
  ts3client_requestChannelUnsubscribe, Channel subscriptions
  ts3client_requestChannelUnsubscribeAll, Channel subscriptions
  ts3client_requestClientKickFromChannel, Kicking clients
  ts3client_requestClientKickFromServer, Kicking clients
  ts3client_requestClientMove, Joining a channel
  ts3client_requestClientSetWhisperList, Whisper lists
  ts3client_requestClientVariables, Information related to other clients
  ts3client_requestMuteClients, Muting clients locally
  ts3client_requestSendTextMsg, Sending
  ts3client_requestServerVariables, Server information
  ts3client_requestUnmuteClients, Muting clients locally
  ts3client_setChannelVariableAsInt, Channel information
  ts3client_setChannelVariableAsString, Channel information
  ts3client_setClientSelfVariableAsInt, Information related to own client
  ts3client_setClientSelfVariableAsString, Information related to own client
  ts3client_setClientVolumeModifier, Playback options
  ts3client_setLocalTestMode, Miscellaneous functions
  ts3client_setLogVerbosity, User-defined logging
  ts3client_setPlaybackConfigValue, Playback options, FAQ
  ts3client_setPreProcessorConfigValue, Preprocessor options
  ts3client_spawnNewServerConnectionHandler, Managing server connection handlers
  ts3client_startConnection, Connecting to a server
  ts3client_startVoiceRecording, Voice recording
  ts3client_stopConnection, Disconnecting from a server
  ts3client_stopVoiceRecording, Voice recording

### H

headers, Overview of header files

### L

Linux, System requirements
Logging, Logging

### M

Macintosh, System requirements

### N

narrowband, Sound codecs

### P

Permanent channel, Channel information
playback device, Using playback and capture modes and devices
preprocessor, Preprocessor options
PushToTalk, FAQ

### R

return code, Return code

### S

sampling rates, Sound codecs
Semi-permanent channel, Channel information
server connection handler, Managing server connection handlers
structs
  TS3CLIENT_FMOD_VECTOR, 3D Sound
system requirements, System requirements

### T

TeamSpeak Systems, Copyright

### U

ultra-wideband, Sound codecs

### V

VAD, Preprocessor options
Voice Activity Detection, Preprocessor options
volume_modifier, Playback options, FAQ

### W

welcome message, Connecting to a server
wideband, Sound codecs
Windows, System requirements

Revision history |  |