BearWare.ServerProperties Struct Reference
[Server Properties]

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

List of all members.

Public Attributes

string szServerName
 The server's name.
string szServerPasswd
 The server's password to login. Users must provide this in the TeamTalk4.DoLogin() command. When extracted through TeamTalk4.GetServerProperties() the password will only be set for users of user-type UserType.USERTYPE_ADMIN.
string szMOTD
 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.
string szMOTDRaw
 The message of the day including variables. This property is only set for UserType.USERTYPE_ADMIN users. Read-only property.
UserRight uUserRights
 A bitmask based on UserRight which specifies the rights a user have who logs onto the server.
int nMaxUsers
 The maximum number of users allowed on the server. A user with admin account can ignore this.
int 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.
int 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.
int nMaxVideoTxPerSecond
 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 video packets. 0 = disabled.
int 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.
int 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.
int nTcpPort
 The server's TCP port.
int nUdpPort
 The server's UDP port.
int nUserTimeout
 The number of seconds before a user who hasn't responded to keepalives will be kicked off the server.
string szServerVersion
 The server version.
string szServerProtocolVersion
 The version of the server's protocol.

Detailed Description

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

The server properties is available after a successful call to TeamTalk4.DoLogin()

See also:
TeamTalk4.DoUpdateServer
TeamTalk4.GetServerProperties
TeamTalk4.DoLogin
UserRight

Member Data Documentation

The server's name.

The server's password to login. Users must provide this in the TeamTalk4.DoLogin() command. When extracted through TeamTalk4.GetServerProperties() the password will only be set for users of user-type UserType.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.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 audio 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:
TeamTalk4.SetKeepAliveInterval.

The server version.

The version of the server's protocol.

Generated on Sun Mar 18 17:16:15 2012 for TeamTalk 4 .NET DLL by  doxygen 1.6.3