ServerProperties Struct Reference
[Server Properties]

A struct containing the properties of the server's settings. More...

#include <TeamTalk4.h>

List of all members.

Public Attributes

TTCHAR szServerName [TT_STRLEN]
 The server's name.
TTCHAR szServerPasswd [TT_STRLEN]
 The server's password to login. Users must provide this in the TT_DoLogin command. When extracted through TT_GetServerProperties the password will only be set for users of user-type USERTYPE_ADMIN.
TTCHAR szMOTD [TT_STRLEN]
 The message of the day. When updating the MOTD an admin can use the variables users% (number of users), admins% (number of admins), uptime% (hours, minutes and seconds the server has been online), voicetx% (KBytes transmitted), voicerx% (KBytes received) and lastuser% (nickname of last user to log on to the server) as part of the MOTD.
TTCHAR szMOTDRaw [TT_STRLEN]
 The message of the day including variables. This property is only set for USERTYPE_ADMIN users. Read-only property.
UserRights uUserRights
 A bitmask based on UserRight which specifies the rights a user have who logs onto the server.
INT32 nMaxUsers
 The maximum number of users allowed on the server. A user with admin account can ignore this.
INT32 nAudioCodecBpsLimit
 Bandwidth restriction for audio codecs created by non-administrators. This value will hold the highest bitrate which is allowed for audio codecs. 0 = no limit.
INT32 nMaxAudioTxPerSecond
 The maximum number of bytes per second which the server will allow for audio packets. If this value is exceeded the server will start dropping audio packets. 0 = disabled.
INT32 nMaxVideoTxPerSecond
 The maximum number of bytes per second which the server will allow for video packets. If this value is exceeded the server will start dropping video packets. 0 = disabled.
INT32 nMaxDesktopTxPerSecond
 The maximum number of bytes per second which the server will allow for desktop packets. If this value is exceeded the server will start dropping desktop packets. 0 = disabled.
INT32 nMaxTotalTxPerSecond
 The amount of bytes per second which the server will allow for packet forwarding. If this value is exceeded the server will start dropping packets. 0 = disabled.
BOOL bAutoSave
 Whether the server automatically saves changes.
INT32 nTcpPort
 The server's TCP port.
INT32 nUdpPort
 The server's UDP port.
INT32 nUserTimeout
 The number of seconds before a user who hasn't responded to keepalives will be kicked off the server.
TTCHAR szServerVersion [TT_STRLEN]
 The server version. Read-only property.
TTCHAR szServerProtocolVersion [TT_STRLEN]
 The version of the server's protocol. Read-only property.

Detailed Description

A struct containing the properties of the server's settings.

The server properties is available after a successful call to TT_DoLogin

See also:
TT_DoUpdateServer
TT_GetServerProperties
TT_Login
UserRight

Member Data Documentation

The server's name.

The server's password to login. Users must provide this in the TT_DoLogin command. When extracted through TT_GetServerProperties the password will only be set for users of user-type USERTYPE_ADMIN.

The message of the day. When updating the MOTD an admin can use the variables users% (number of users), admins% (number of admins), uptime% (hours, minutes and seconds the server has been online), voicetx% (KBytes transmitted), voicerx% (KBytes received) and lastuser% (nickname of last user to log on to the server) as part of the MOTD.

The message of the day including variables. This property is only set for USERTYPE_ADMIN users. Read-only property.

A bitmask based on UserRight which specifies the rights a user have who logs onto the server.

The maximum number of users allowed on the server. A user with admin account can ignore this.

Bandwidth restriction for audio codecs created by non-administrators. This value will hold the highest bitrate which is allowed for audio codecs. 0 = no limit.

See also:
AudioCodec

The maximum number of bytes per second which the server will allow for audio packets. If this value is exceeded the server will start dropping audio packets. 0 = disabled.

The maximum number of bytes per second which the server will allow for video packets. If this value is exceeded the server will start dropping video packets. 0 = disabled.

The maximum number of bytes per second which the server will allow for desktop packets. If this value is exceeded the server will start dropping desktop packets. 0 = disabled.

The amount of bytes per second which the server will allow for packet forwarding. If this value is exceeded the server will start dropping packets. 0 = disabled.

Whether the server automatically saves changes.

The server's TCP port.

The server's UDP port.

The number of seconds before a user who hasn't responded to keepalives will be kicked off the server.

See also:
TT_SetKeepAliveInterval.

The server version. Read-only property.

The version of the server's protocol. Read-only property.

Generated on Sun Mar 18 17:18:33 2012 for TeamTalk 4 C-API DLL by  doxygen 1.6.3