Click or drag to resize
Client Class
Represents a Client on a TeamSpeak-Server
Inheritance Hierarchy
SystemObject
  TeamSpeak.Sdk.ClientClient

Namespace:  TeamSpeak.Sdk.Client
Assembly:  TeamSpeak.Sdk (in TeamSpeak.Sdk.dll) Version: 0.1.6124.20226 (0.1.0.0)
Syntax
public class Client : IEquatable<Client>

The Client type exposes the following members.

Constructors
  NameDescription
Public methodClient
Creates a new Client-Object.
Top
Properties
  NameDescription
Public propertyChannel
The channel the client is currently joined
Public propertyConnection
Server Connection
Public propertyConnectionInfo
Server ConnectionInfo
Public propertyDefaultChannel
Default channel name used in the last Start Overload call. Only available for own client
Public propertyID
ID of the client
Public propertyIdleTime
Public propertyInputHardwareEnabled
Set if the clients capture device is not available. Always available for visible clients
Public propertyInputMuted
Indicates the mute status of the clients capture device. Always available for visible clients
Public propertyIsInputDeactivated
Determines if the sound input is deactivated , only usable for Self, not propagated to the network.
Public propertyIsRecording
Indicates a client is currently recording all voice data in his channel
Public propertyIsTalking
Set when the client is currently sending voice data to the server. Always available for visible clients.
Public propertyMetaData
Not used by TeamSpeak 3, offers free storage for SDK users. Always available for visible clients
Public propertyMuted
Indicates a client has been locally muted. Client-side only
Public propertyNickname
Nickname used by the client. This value is always automatically updated for visible clients
Public propertyOutputHardware
True if the clients playback device is not available. Always available for visible clients
Public propertyOutputMuted
Indicates the combined mute status of the clients playback and capture devices. Always available for visible clients
Public propertyOutputOnlyMuted
Indicates the mute status of the clients playback device. Always available for visible clients
Public propertyPlatform
Operating system used by this client. Needs to be requested with RequestClientVariables unless called on own client.
Public propertyUniqueIdentifier
Unique ID for this client. Stays the same after restarting the application, so you can use this to identify individual users
Public propertyVersion
Application version used by this client. Needs to be requested with RequestClientVariables unless called on own client
Public propertyVolumeModificator
The client volume modifier
Top
Methods
  NameDescription
Public methodEquals(Object)
Indicates whether this instance and a specified object are equal.
(Overrides ObjectEquals(Object).)
Public methodEquals(Client)
Indicates whether this instance and a another instance are equal.
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode
Returns the hash code for this instance.
(Overrides ObjectGetHashCode.)
Public methodGetType (Inherited from Object.)
Public methodKickFromChannel
Kick the client from the channel
Public methodKickFromServer
Kick the client from the server
Protected methodMemberwiseClone (Inherited from Object.)
Public methodMoveTo
Switch the client to a certain channel.
Public methodRequestClientVariables
Request the latest data for the client from the server.
Public methodSendTextMessage
Send a private text message to the client.
Public methodSet3DAttributes
Adjust a position and velocity in 3D space
Public methodSetWhisperList
With a whisper list set a client can talk to the specified clients and channels bypassing the standard rule that voice is only transmitted to the current channel. Whisper lists can be defined for individual clients.
Public methodToString
Returns a string that represents the current object.
(Overrides ObjectToString.)
Top
Operators
  NameDescription
Public operatorStatic memberEquality
Compares two Client for equality.
Public operatorStatic memberInequality
Compares two Client for inequality.
Top
See Also