TeamTalk 4 C-API DLL  Version 4.5A
ServerProperties Struct Reference

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

#include <TeamTalk4.h>

Public Attributes

TTCHAR szServerName [TT_STRLEN]
 The server's name. More...
 
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. More...
 
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. More...
 
TTCHAR szMOTDRaw [TT_STRLEN]
 The message of the day including variables. This property is only set for USERTYPE_ADMIN users. Read-only property. More...
 
UserRights uUserRights
 A bitmask based on UserRight which specifies the rights a user have who logs onto the server. More...
 
INT32 nMaxUsers
 The maximum number of users allowed on the server. A user with admin account can ignore this. More...
 
INT32 nMaxLoginAttempts
 The maximum number of logins with wrong password before banning user's IP-address. More...
 
INT32 nMaxLoginsPerIPAddress
 The maximum number of users allowed to log in with the same IP-address. 0 means disabled. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
BOOL bAutoSave
 Whether the server automatically saves changes. More...
 
INT32 nTcpPort
 The server's TCP port. More...
 
INT32 nUdpPort
 The server's UDP port. More...
 
INT32 nUserTimeout
 The number of seconds before a user who hasn't responded to keepalives will be kicked off the server. More...
 
TTCHAR szServerVersion [TT_STRLEN]
 The server version. Read-only property. More...
 
TTCHAR szServerProtocolVersion [TT_STRLEN]
 The version of the server's protocol. Read-only property. More...
 

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

TTCHAR ServerProperties::szServerName[TT_STRLEN]

The server's name.

TTCHAR ServerProperties::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 ServerProperties::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 ServerProperties::szMOTDRaw[TT_STRLEN]

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

UserRights ServerProperties::uUserRights

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

INT32 ServerProperties::nMaxUsers

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

INT32 ServerProperties::nMaxLoginAttempts

The maximum number of logins with wrong password before banning user's IP-address.

INT32 ServerProperties::nMaxLoginsPerIPAddress

The maximum number of users allowed to log in with the same IP-address. 0 means disabled.

INT32 ServerProperties::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.

See Also
AudioCodec
INT32 ServerProperties::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 ServerProperties::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 ServerProperties::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 ServerProperties::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 ServerProperties::bAutoSave

Whether the server automatically saves changes.

INT32 ServerProperties::nTcpPort

The server's TCP port.

INT32 ServerProperties::nUdpPort

The server's UDP port.

INT32 ServerProperties::nUserTimeout

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

See Also
TT_SetKeepAliveInterval.
TTCHAR ServerProperties::szServerVersion[TT_STRLEN]

The server version. Read-only property.

TTCHAR ServerProperties::szServerProtocolVersion[TT_STRLEN]

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