Property Enums

Common

enum ConnectionProperties

Various connection properties. These are all read only, and except for your own client must be requested using ts3client_requestConnectionInfo

Values:

enumerator CONNECTION_PING

UInt64. Round trip latency for the connection based on the last 5 seconds. On the server this is the average across all connected clients for the last 5 seconds.

enumerator CONNECTION_PING_DEVIATION

Double. Standard deviation for the round trip latency in CONNECTION_PING.

enumerator CONNECTION_CONNECTED_TIME

UInt64. Seconds the client has been connected.

enumerator CONNECTION_IDLE_TIME

UInt64. Time in seconds since the last activity (voice transmission, switching channels, changing mic / speaker mute status) of the client.

enumerator CONNECTION_CLIENT_IP

String. IP of this client (as seen from the server side)

enumerator CONNECTION_CLIENT_PORT

UInt64. Client side port of this client (as seen from the server side)

enumerator CONNECTION_SERVER_IP

String. The IP or hostname used to connect to the server. Only available on yourself.

enumerator CONNECTION_SERVER_PORT

UInt64. The server port connected to. Only available on yourself.

enumerator CONNECTION_PACKETS_SENT_SPEECH

UInt64. The number of voice packets transmitted by the client.

enumerator CONNECTION_PACKETS_SENT_KEEPALIVE

UInt64. The number of keep alive packets transmitted by the client.

enumerator CONNECTION_PACKETS_SENT_CONTROL

UInt64. The number of command & control packets transmitted by the client.

enumerator CONNECTION_PACKETS_SENT_TOTAL

UInt64. Total number of packets transmitted by the client. Equal to the sum of CONNECTION_PACKETS_SENT_SPEECH, CONNECTION_PACKETS_SENT_KEEPALIVE and CONNECTION_PACKETS_SENT_CONTROL

enumerator CONNECTION_BYTES_SENT_SPEECH

UInt64. Outgoing traffic used for voice data by the client.

enumerator CONNECTION_BYTES_SENT_KEEPALIVE

UInt64. Outgoing traffic used for keeping the connection alive by the client.

enumerator CONNECTION_BYTES_SENT_CONTROL

UInt64. Outgoing traffic used for command & control data by the client.

enumerator CONNECTION_BYTES_SENT_TOTAL

UInt64. Total outgoing traffic to the server by this client. Equal to the sum of CONNECTION_BYTES_SENT_SPEECH, CONNECTION_BYTES_SENT_KEEPALIVE and CONNECTION_BYTES_SENT_CONTROL

enumerator CONNECTION_PACKETS_RECEIVED_SPEECH

UInt64. Number of voice packets received by the client.

enumerator CONNECTION_PACKETS_RECEIVED_KEEPALIVE

UInt64. Number of keep alive packets received by the client.

enumerator CONNECTION_PACKETS_RECEIVED_CONTROL

UInt64. Number of command & control packets received by the client.

enumerator CONNECTION_PACKETS_RECEIVED_TOTAL

UInt64. Total number of packets received by the client. Equal to the sum of CONNECTION_PACKETS_RECEIVED_SPEECH, CONNECTION_PACKETS_RECEIVED_KEEPALIVE and CONNECTION_PACKETS_RECEIVED_CONTROL

enumerator CONNECTION_BYTES_RECEIVED_SPEECH

UInt64. Incoming traffic used by the client for voice data.

enumerator CONNECTION_BYTES_RECEIVED_KEEPALIVE

UInt64. Incoming traffic used by the client to keep the connection alive.

enumerator CONNECTION_BYTES_RECEIVED_CONTROL

UInt64. Incoming traffic used by the client for command & control data.

enumerator CONNECTION_BYTES_RECEIVED_TOTAL

UInt64. Total incoming traffic used by the client. Equal to the sum of CONNECTION_BYTES_RECEIVED_SPEECH, CONNECTION_BYTES_RECEIVED_KEEPALIVE and CONNECTION_BYTES_RECEIVED_CONTROL

enumerator CONNECTION_PACKETLOSS_SPEECH

Double. Percentage points of voice packets for the client that did not arrive at the client or server averaged across the last 5 seconds.

enumerator CONNECTION_PACKETLOSS_KEEPALIVE

Double. Percentage points of keep alive packets for the client that did not arrive at the client or server averaged across the last 5 seconds.

enumerator CONNECTION_PACKETLOSS_CONTROL

Double. Percentage points of command & control packets for the client that did not arrive at the client or server averaged across the last 5 seconds.

enumerator CONNECTION_PACKETLOSS_TOTAL

Double. Cumulative chance in percentage points with which a packet round trip failed because a packet was lost

enumerator CONNECTION_SERVER2CLIENT_PACKETLOSS_SPEECH

Double. Probability with which a voice packet sent by the server was not received by the client.

enumerator CONNECTION_SERVER2CLIENT_PACKETLOSS_KEEPALIVE

Double. Probability with which a keepalive packet sent by the server was not received by the client.

enumerator CONNECTION_SERVER2CLIENT_PACKETLOSS_CONTROL

Double. Probability with which a control packet sent by the server was not received by the client.

enumerator CONNECTION_SERVER2CLIENT_PACKETLOSS_TOTAL

Double. Probability with which a packet sent by the server was not received by the client.

enumerator CONNECTION_CLIENT2SERVER_PACKETLOSS_SPEECH

Double. Probability with which a speech packet sent by the client was not received by the server.

enumerator CONNECTION_CLIENT2SERVER_PACKETLOSS_KEEPALIVE

Double. Probability with which a keepalive packet sent by the client was not received by the server.

enumerator CONNECTION_CLIENT2SERVER_PACKETLOSS_CONTROL

Double. Probability with which a control packet sent by the client was not received by the server.

enumerator CONNECTION_CLIENT2SERVER_PACKETLOSS_TOTAL

Double. Probability with which a packet sent by the client was not received by the server.

enumerator CONNECTION_BANDWIDTH_SENT_LAST_SECOND_SPEECH

UInt64. Number of bytes sent for speech data in the last second.

enumerator CONNECTION_BANDWIDTH_SENT_LAST_SECOND_KEEPALIVE

UInt64. Number of bytes sent for keepalive data in the last second.

enumerator CONNECTION_BANDWIDTH_SENT_LAST_SECOND_CONTROL

UInt64. Number of bytes sent for control data in the last second.

enumerator CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL

UInt64. Number of bytes sent in the last second.

enumerator CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_SPEECH

UInt64. Bytes per second sent for speech data, averaged over the last minute.

enumerator CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_KEEPALIVE

UInt64. Bytes per second sent for keepalive data, averaged over the last minute.

enumerator CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_CONTROL

UInt64. Bytes per second sent for control data, averaged over the last minute.

enumerator CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL

UInt64. Bytes per second sent, averaged over the last minute.

enumerator CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_SPEECH

UInt64. Number of bytes received for speech data in the last second.

enumerator CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_KEEPALIVE

UInt64. Number of bytes received for keepalive data in the last second.

enumerator CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_CONTROL

UInt64. Number of bytes received for control data in the last second.

enumerator CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL

UInt64. Number of bytes received in the last second.

enumerator CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_SPEECH

UInt64. Bytes per second received for speech data, averaged over the last minute.

enumerator CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_KEEPALIVE

UInt64. Bytes per second received for keepalive data, averaged over the last minute.

enumerator CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_CONTROL

UInt64. Bytes per second received for control data, averaged over the last minute.

enumerator CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL

UInt64. Bytes per second received, averaged over the last minute.

enumerator CONNECTION_DUMMY_0

enumerator CONNECTION_DUMMY_1

enumerator CONNECTION_DUMMY_2

enumerator CONNECTION_DUMMY_3

enumerator CONNECTION_DUMMY_4

enumerator CONNECTION_DUMMY_5

enumerator CONNECTION_DUMMY_6

enumerator CONNECTION_DUMMY_7

enumerator CONNECTION_DUMMY_8

enumerator CONNECTION_DUMMY_9

enumerator CONNECTION_FILETRANSFER_BANDWIDTH_SENT

UInt64. Current file transfer upstream activity in bytes per second. Only available on request (ts3client_requestServerConnectionInfo).

enumerator CONNECTION_FILETRANSFER_BANDWIDTH_RECEIVED

UInt64. Current file transfer downstream activity in bytes per second. Only available on request (ts3client_requestServerConnectionInfo).

enumerator CONNECTION_FILETRANSFER_BYTES_RECEIVED_TOTAL

UInt64. Total downstream traffic, in bytes, used for file transfer since the server was started. Only available on request (ts3client_requestServerConnectionInfo).

enumerator CONNECTION_FILETRANSFER_BYTES_SENT_TOTAL

UInt64. Total upstream traffic, in bytes, used for file transfer since the server was started. Only available on request (ts3client_requestServerConnectionInfo).

enumerator CONNECTION_ENDMARKER

Server

enum VirtualServerProperties

Values:

enumerator VIRTUALSERVER_UNIQUE_IDENTIFIER

String. Read only. Unique identifier for a virtual server, does not change on server restart. Available if ts3client_getConnectionStatus is >= STATUS_CONNECTED.

enumerator VIRTUALSERVER_NAME

String. Read/Write. The virtual server display name. Available if ts3client_getConnectionStatus is >= STATUS_CONNECTED.

enumerator VIRTUALSERVER_WELCOMEMESSAGE

String. Read/Write. The welcome message displayed to clients on connect. Available if ts3client_getConnectionStatus is >= STATUS_CONNECTED. Not updated automatically when changed, updates need to be requested (ts3client_requestServerVariables).

enumerator VIRTUALSERVER_PLATFORM

String. Read only. The operating system the server is running on. Available if ts3client_getConnectionStatus is >= STATUS_CONNECTED.

enumerator VIRTUALSERVER_VERSION

String. Read only. The server software version string. Available if ts3client_getConnectionStatus is >= STATUS_CONNECTED.

enumerator VIRTUALSERVER_MAXCLIENTS

UInt64. Read/Write. The maximum number of clients that can be connected simultaneously. Only available on request (ts3client_requestServerVariables).

enumerator VIRTUALSERVER_PASSWORD

String. Read/Write. The server password. Read access is limited to the server. Clients will only get the password they supplied when connecting. Available if ts3client_getConnectionStatus is >= STATUS_CONNECTED.

enumerator VIRTUALSERVER_CLIENTS_ONLINE

UInt64. Read only. The current number of clients connected to the server, including query connections. Only available on request (ts3client_requestServerVariables).

enumerator VIRTUALSERVER_CHANNELS_ONLINE

UInt64. Read only. The current number of channels on the server. Only available on request (ts3client_requestServerVariables).

enumerator VIRTUALSERVER_CREATED

Integer. Read only. The time this virtual server was created as unix timestamp. Available if ts3client_getConnectionStatus is >= STATUS_CONNECTED.

enumerator VIRTUALSERVER_UPTIME

UInt64. Read only. Number of seconds that have passed since the virtual server was started. Only available on request (ts3client_requestServerVariables).

enumerator VIRTUALSERVER_CODEC_ENCRYPTION_MODE

Integer. Read/Write. Boolean (1/0) that specifies if voice data is encrypted during transfer. One of the values from the CodecEncryptionMode enum. Available if ts3client_getConnectionStatus is >= STATUS_CONNECTED.

enumerator VIRTUALSERVER_ENCRYPTION_CIPHERS

String. Read/Write. Comma separated list of available ciphers to encrypt the connection. The server will use the first cipher in the list that is also listed in the CLIENT_ENCRYPTION_CIPHERS of the connecting client. Clients will fail to connect if no match is found. Always available.

enumerator VIRTUALSERVER_ENDMARKER

enumerator VIRTUALSERVER_FILEBASE

String. Read only. The path to the base directory used to store files transferred using file transfer. Available only on the server. Is set by ts3server_enableFileManager

enumerator VIRTUALSERVER_MAX_DOWNLOAD_TOTAL_BANDWIDTH

UInt64. Read/Write. Maximum traffic in bytes the server can use for file transfer downloads. Only available on request (ts3client_requestServerVariables).

enumerator VIRTUALSERVER_MAX_UPLOAD_TOTAL_BANDWIDTH

UInt64. Read/Write. Maximum traffic in bytes the server can use for file transfer uploads. Only available on request (=> requestServerVariables)

enumerator VIRTUALSERVER_LOG_FILETRANSFER

Integer. Read/Write. Boolean (1/0) indicating whether to include file transfer activities (uploading or downloading of files) in the server log. Always available.

Channel

enum ChannelProperties

Values:

enumerator CHANNEL_NAME

String. Read/Write. Name of the channel. Always available.

enumerator CHANNEL_TOPIC

String. Read/Write. Short single line text describing what the channel is about. Always available.

enumerator CHANNEL_DESCRIPTION

String. Read/Write. Arbitrary text (up to 8k bytes) with information about the channel. Must be requested (ts3client_requestChannelDescription)

enumerator CHANNEL_PASSWORD

String. Read/Write. Password of the channel. Read access is limited to the server. Clients will only ever see the last password they attempted to use when joining the channel. Always available.

enumerator CHANNEL_CODEC

Integer. Read/Write. The codec this channel is using. One of the values from the CodecType enum. Always available.

enumerator CHANNEL_CODEC_QUALITY

Integer. Read/Write. The quality setting of the channel. Valid values are 0 to 10 inclusive. Higher value means better voice quality but also more bandwidth usage. Always available.

enumerator CHANNEL_MAXCLIENTS

Integer. Read/Write. The number of clients that can be in the channel simultaneously. Always available.

enumerator CHANNEL_MAXFAMILYCLIENTS

Integer. Read/Write. The total number of clients that can be in this channel and all sub channels of this channel. Always available.

enumerator CHANNEL_ORDER

UInt64. Read/Write. The ID of the channel below which this channel should be displayed. If 0 the channel is sorted at the top of the current level. Always available.

enumerator CHANNEL_FLAG_PERMANENT

Integer. Read/Write. Boolean (1/0) indicating whether the channel remains when empty. Permanent channels are stored to the database and available after server restart. SDK users will need to take care of restoring channel at server start on their own. Mutually exclusive with CHANNEL_FLAG_SEMI_PERMANENT. Always available.

enumerator CHANNEL_FLAG_SEMI_PERMANENT

Integer. Read/Write. Boolean (1/0) indicating whether the channel remains when empty. Semi permanent channels are not stored to disk and gone after server restart but remain while empty. Mutually exclusive with CHANNEL_FLAG_PERMANENT. Always available.

enumerator CHANNEL_FLAG_DEFAULT

Integer. Read/Write. Boolean (1/0). The default channel is the channel that all clients are located in when they join the server, unless the client explicitly specified a different channel when connecting and is allowed to join their preferred channel. Only one channel on the server can have this flag set. The default channel must have CHANNEL_FLAG_PERMANENT set. Always available.

enumerator CHANNEL_FLAG_PASSWORD

Integer. Read/Write. Boolean (1/0) indicating whether this channel is password protected. When removing or setting CHANNEL_PASSWORD you also need to adjust this flag.

enumerator CHANNEL_CODEC_LATENCY_FACTOR

(deprecated) Integer. Read/Write. Allows to increase packet size, reducing bandwith at the cost of higher latency of voice transmission. Valid values are 1-10 inclusive. 1 is the default and offers the lowest latency. Always available.

enumerator CHANNEL_CODEC_IS_UNENCRYPTED

Integer. Read/Write. Boolean (1/0). If 0 voice data is encrypted, if 1 the voice data is not encrypted. Only used if the server VIRTUALSERVER_CODEC_ENCRYPTION_MODE is set to CODEC_ENCRYPTION_PER_CHANNEL. Always available.

enumerator CHANNEL_SECURITY_SALT

String. Read/Write. SDK Only, not used by TeamSpeak. This channels security hash. When a client joins their CLIENT_SECURITY_HASH is compared to this value, to allow or deny the client access to the channel. Used to enforce clients joining the server with specific identity and CLIENT_META_DATA. See SDK Documentation about this feature for further details. Always available.

enumerator CHANNEL_DELETE_DELAY

UInt64. Read/Write. Number of seconds deletion of temporary channels is delayed after the last client leaves the channel. Channel is only deleted if empty when the delete delay expired. Always available.

enumerator CHANNEL_UNIQUE_IDENTIFIER

String. Read only. An identifier that uniquely identifies a channel. Available in Server >= 3.10.0

enumerator CHANNEL_ENDMARKER

Client

enum ClientProperties

Values:

enumerator CLIENT_UNIQUE_IDENTIFIER

String. Read only. Public Identity, can be used to identify a client installation. Remains identical as long as the client keeps using the same identity. Available for visible clients.

enumerator CLIENT_NICKNAME

String. Read/Write. Display name of the client. Available for visible clients.

enumerator CLIENT_VERSION

String. Read only. Version String of the client used. For clients other than ourself this needs to be requested (ts3client_requestClientVariables).

enumerator CLIENT_PLATFORM

String. Read only. Operating system used by the client. For other clients other than ourself this needs to be requested (ts3client_requestClientVariables).

enumerator CLIENT_FLAG_TALKING

Integer. Read only. Whether the client is talking. Available on clients that are either whispering to us, or in our channel.

enumerator CLIENT_INPUT_MUTED

Integer. Read/Write. Microphone mute status. Available for visible clients. One of the values from the MuteInputStatus enum.

enumerator CLIENT_OUTPUT_MUTED

Integer. Read only. Speaker mute status. Speaker mute implies microphone mute. Available for visible clients. One of the values from the MuteOutputStatus enum.

enumerator CLIENT_OUTPUTONLY_MUTED

Integer. Read only. Speaker mute status. Microphone may be active. Available for visible clients. One of the values from the MuteOutputStatus enum.

enumerator CLIENT_INPUT_HARDWARE

Integer. Read only. Indicates whether a capture device is open. Available for visible clients. One of the values from the HardwareInputStatus enum.

enumerator CLIENT_OUTPUT_HARDWARE

Integer. Read only. Indicates whether a playback device is open. Available for visible clients. One of the values from the HardwareOutputStatus enum.

enumerator CLIENT_INPUT_DEACTIVATED

Integer. Read/Write. Not available server side. Local microphone mute status. Available only for own client. Used to implement Push To Talk. One of the values from the InputDeactivationStatus enum.

enumerator CLIENT_IDLE_TIME

UInt64. Read only. Seconds since last activity. Available only for own client.

enumerator CLIENT_DEFAULT_CHANNEL

String. Read only. User specified channel they joined when connecting to the server. Available only for own client.

enumerator CLIENT_DEFAULT_CHANNEL_PASSWORD

String. Read only. User specified channel password for the channel they attempted to join when connecting to the server. Available only for own client.

enumerator CLIENT_SERVER_PASSWORD

String. Read only. User specified server password. Available only for own client.

enumerator CLIENT_META_DATA

String. Read/Write. Can be used to store up to 4096 bytes of information on clients. Not used by TeamSpeak. Available for visible clients.

enumerator CLIENT_IS_MUTED

Integer. Read only. Not available server side. Indicates whether we have muted the client using ts3client_requestMuteClients. Available for visible clients other than ourselves.

enumerator CLIENT_IS_RECORDING

Integer. Read only. Indicates whether the client is recording incoming audio. Available for visible clients.

enumerator CLIENT_VOLUME_MODIFICATOR

Integer. Read only. Volume adjustment for this client as set by ts3client_setClientVolumeModifier. Available for visible clients.

enumerator CLIENT_VERSION_SIGN

String. Read only. TeamSpeak internal signature.

enumerator CLIENT_SECURITY_HASH

String. Read/Write. This clients security hash. Not used by TeamSpeak, SDK only. Hash is provided by an outside source. A channel will use the security salt + other client data to calculate a hash, which must be the same as the one provided here. See SDK documentation about Client / Channel Security Hashes for more details.

enumerator CLIENT_ENCRYPTION_CIPHERS

String. Read only. SDK only. List of available ciphers this client can use.

enumerator CLIENT_ENDMARKER