![]() | Connection Class |
Namespace: TeamSpeak.Sdk.Client
The Connection type exposes the following members.
Name | Description | |
---|---|---|
![]() | Connection |
Spawns a new Connection |
Name | Description | |
---|---|---|
![]() | AllChannels |
A list of all channels on the virtual server
|
![]() | AllClients |
A list of all currently visible clients on the virtual server
|
![]() | CaptureDevice |
Currently open capture device. Set using OpenCapture(ISoundDevice) |
![]() | Channels |
A list of channels who have the channel as a parent
|
![]() | ChannelsOnline |
Number of channels currently on this virtual server. Needs to be requested using RefreshVariables.
|
![]() | ClientsOnline |
Number of clients currently on this virtual server. Needs to be requested using RefreshVariables.
|
![]() | CodecEncryptionMode |
Defines if voice data encryption is configured per channel, globally forced on or globally forced off for this virtual server.
The default behavior is configure per channel, in this case modifying CodecIsUnencrypted
defines voice data encryption of individual channels.
|
![]() | Created |
Time when this virtual server was created. Always available when connected.
|
![]() | ID |
ID of the client
|
![]() | IsVoiceRecording |
When using EditCapturedVoiceData to record voice, you should notify the server when recording starts or stops
|
![]() | LocalTestMode |
Instead of sending the sound through the network, it can be routed directly through the playback device, so the user will get immediate audible feedback when for example configuring some sound settings.
|
![]() | MaxClients |
Defines maximum number of clients which may connect to this server. Needs to be requested using RefreshVariables.
|
![]() | Name |
Name of this virtual server. Always available when connected.
|
![]() | Platform |
Operating system used by this server. Always available when connected.
|
![]() | PlaybackDevice |
Currently open playback device. Set using OpenPlayback(ISoundDevice) |
![]() | Preprocessor |
Sound Preprocessor Parameters
|
![]() | Self |
the connection as a client object
|
![]() | ServerIp |
IP of the server (seen from the client side)
|
![]() | ServerPort |
Port of the server (seen from the client side)
|
![]() | SpeedLimitDown |
The download speed limit for the specified virtual server in bytes/s.
|
![]() | SpeedLimitUp |
The upload speed limit for the specified virtual server in bytes/s.
|
![]() | Status |
Status of the connection to the given server
|
![]() | UniqueIdentifier |
Unique ID for this virtual server. Stays the same after restarting the server application. Always available when connected.
|
![]() | Uptime |
Uptime of this virtual server. Needs to be requested using RefreshVariables.
|
![]() | Version |
Application version of this server. Always available when connected.
|
![]() | VolumeFactorWave |
Adjust the volume of wave files played by PlayWaveFile(String, Boolean).
The value is a float defining the volume reduction in decibel.
Reasonable values range from “-40.0” (very silent) to “0.0” (loudest).
|
![]() | VolumeModifier |
Modify the voice volume of other speakers. Value is in decibel, so 0 is no modification,
negative values make the signal quieter and values greater than zero boost the signal louder than it is.
Be careful with high positive values, as you can really cause bad audio quality due to clipping.
The maximum possible Value is 30. Zero and all negative values cannot cause clipping and distortion,
and are preferred for optimal audio quality. Values greater than zero and less than +6 dB
might cause moderate clipping and distortion, but should still be within acceptable bounds.
Values greater than +6 dB will cause clipping and distortion that will negatively affect your audio quality.
It is advised to choose lower values. Generally we recommend to not allow values higher than 15 db.
|
![]() | WelcomeMessage |
Optional welcome message sent to the client on login. This value should be queried by the client after connection has been established, it is not updated afterwards.
|
Name | Description | |
---|---|---|
![]() | ActivateCaptureDevice |
When connecting to multiple servers with the same client, the capture device can only be active for one server at the same time.
As soon as the client connects to a new server, the Library will deactivate the capture device for the previously active server.
When a user wants to talk to that previous server again, the client needs to reactivate the capture device.
|
![]() | AllowWhispersFrom |
Add a client to the whisper allow list.
|
![]() | Close |
Closes the connection
|
![]() | CloseCaptureDevice |
Close the capture device
|
![]() | ClosePlaybackDevice |
Close the playback device
|
![]() | CreateChannel |
Create a new Channel
|
![]() | Dispose |
Releases the unmanaged resources used by the CustomDevice and optionally releases the managed resources.
|
![]() | Equals | (Inherited from Object.) |
![]() | Finalize |
Allows Connection to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Overrides ObjectFinalize.) |
![]() | FindClient |
Returns every client with a matching UniqueId
|
![]() | GetHashCode | (Inherited from Object.) |
![]() | GetType | (Inherited from Object.) |
![]() | InitiateGracefulPlaybackShutdown |
Prepares the playback device be closed via ClosePlaybackDevice.
Should be used to prevent interrupting of still playing sounds.
|
![]() | MemberwiseClone | (Inherited from Object.) |
![]() | Move(Channel, Channel, Channel) |
Move a channel to a new parent channel
|
![]() | Move(Client, Channel, String) |
Move a client to a channel.
|
![]() | Mute |
Mutes one or more clients
|
![]() | OpenCapture |
To initialize a capture device
|
![]() | OpenPlayback |
To initialize a playback device
|
![]() | PlayWaveFile |
Play a local wave file
|
![]() | RefreshVariables |
Refreshing the server information.
|
![]() | RemoveFromAllowedWhispersFrom |
Remove a client from the whisper allow list.
|
![]() | SendTextMessage(String) |
Send a text message to the server
|
![]() | SendTextMessage(Channel, String) |
Send a text message to a channel
|
![]() | SendTextMessage(Client, String) |
Send a private text message to a client
|
![]() | Set3DListenerAttributes |
Set the position, velocity and orientation of the listener in 3D space
|
![]() | Set3DSettings |
Adjusts 3D sound system settings
|
![]() | Start(String, String, UInt32, String, String, String, String) |
Connect to a TeamSpeak 3 server
|
![]() | Start(String, String, UInt32, String, String, String, String) |
Connect to a TeamSpeak 3 server
|
![]() | Stop |
Disconnect from a TeamSpeak 3 server
|
![]() | Subscribe |
Subscribes to one or more channels
|
![]() | SubscribeAll |
Subscribe to all channels on the server
|
![]() | ToString | (Inherited from Object.) |
![]() | Unmute |
Unmute one or more clients
|
![]() | Unsubscribe |
Unsubscribes from one or more channels
|
![]() | UnsubscribeAll |
Unsubscribe from all channels on the server
|
Name | Description | |
---|---|---|
![]() | ChannelChanged |
Called when a channel was changed
|
![]() | ChannelDeleted |
After deleting a Channel the event will be called.
|
![]() | ChannelDescriptionUpdated |
Called when the Description was edited
|
![]() | ChannelMessage |
Called when a channel message was received
|
![]() | ChannelMoved |
Called when a channel is being moved.
|
![]() | ChannelPasswordChanged |
Called when a Password was modified.
|
![]() | ChannelSubscribed |
Called when channel has been subscribed
|
![]() | ChannelSubscribesFinished |
Marks the end of multiple calls to ChannelSubscribed |
![]() | ChannelUnsubscribed |
Called when channel has been unsubscribed
|
![]() | ChannelUnsubscribesFinished |
Marks the end of multiple calls to ChannelUnsubscribed |
![]() | CheckServerUniqueIdentifier |
Used to check if the unique identifier is the correct one
|
![]() | ClientKickedFromChannel |
When a client is kicked from a channel
|
![]() | ClientKickedFromServer |
When a client is kicked from the server
|
![]() | ClientMessage |
Called when a private text message from a client was received
|
![]() | ClientMoved |
Called when a client is actively switching channels.
|
![]() | ClientMovedSubscription |
Once a channel has been subscribed or unsubscribed, the event is called for each client in the subscribed channel. The event is not to be confused with ClientMoved, which is called for clients actively switching channels.
|
![]() | ClientTimeout |
When a clients is moved because of a timeout
|
![]() | ClientUpdated |
Called when a client was changed
|
![]() | Custom3dRolloffCalculationClient |
Called to calculate volume attenuation for distance in 3D positioning of clients.
|
![]() | Custom3dRolloffCalculationWaveReceived |
Called to calculate volume attenuation for distance in 3D positioning of a wave file that was opened with PlayWaveFile(String, Boolean).
|
![]() | EditCapturedVoiceData |
Called after sound is recorded from the sound device and is preprocessed. This event can be used to get/alter recorded sound.
It can also be used to determine if this sound will be send, or discarded.
|
![]() | EditMixedPlaybackVoiceData |
The following event is called when all sounds that are about to be played back for this server connection have been mixed. This is the last chance to alter/get sound.
The event can be used to alter or get the sound data before playback.
|
![]() | EditPlaybackVoiceData |
Called when a incoming voice packet from a remote client was decoded and is about to be played, before it is 3D positioned and mixed with other sound sources.
The event can be used to alter the voice data (for example when you want to do effects on it) or to record the voice data.
|
![]() | EditPostProcessVoiceData |
Called when a incoming voice packet from a remote client was decoded and 3D positioned and is about to be played, but before it is mixed with other sounds sources.
The event can be used to alter or get the voice data after it has been 3D positioned.
|
![]() | FileInfoReceived |
Called after GetFileInfo(String, String) containing the reply by the server
|
![]() | FileTransferStatusReceived |
Called when a file finished being transfered, triggered by SendFile Overload or RequestFile Overload has finished or aborted with an error.
|
![]() | NewChannel |
Informs about the existence of each channel, after connection has been established, all current channels on the server are announced. This happens with delays to avoid a flood of information after connecting.
|
![]() | NewChannelCreated |
After on successfully creating a new Channel the event will be called
|
![]() | PlaybackShutdownCompleted |
Called after InitiateGracefulPlaybackShutdown finished for a device
|
![]() | ProtocolVersionReceived |
While connecting to a server, the protocol version is reported.
|
![]() | ServerError |
Error codes sent by the server to the client
|
![]() | ServerMessage |
Called when a server message was received
|
![]() | ServerStop |
Called when the server has been shutdown
|
![]() | ServerUpdated |
Called when the virtual server was changed
|
![]() | StatusChanged |
After calling Start Overload the client will be informed of the connection status changes by the event
|
![]() | TalkStatusChanged |
When a client starts or stops talking
|
![]() | WhisperIgnored |
Used when whisper is received from a Client that has not been added to the whisper allow list.
|