User Struct Reference
[User Properties]

A struct containing the properties of a user. More...

#include <TeamTalk4.h>

List of all members.

Public Attributes

INT32 nUserID
 The user's ID. A value from 1 - 65535.
TTCHAR szNickname [TT_STRLEN]
 The user's nickname.
TTCHAR szUsername [TT_STRLEN]
 Username of user's account.
INT32 nStatusMode
 The user's currently status mode.
TTCHAR szStatusMsg [TT_STRLEN]
 The user's current status message.
INT32 nChannelID
 The channel the user is currently participating in. 0 if none.
TTCHAR szIPAddress [TT_STRLEN]
 The user's IP-address.
TTCHAR szVersion [TT_STRLEN]
 The user's client version.
UserTypes uUserType
 A bitmask of the type of user based on UserType.
UserStates uUserState
 A bitmask of the user's current state, e.g. talking, muted, etc.
Subscriptions uLocalSubscriptions
 A bitmask of what the local user subscribes to from this user.
Subscriptions uPeerSubscriptions
 A bitmask of what this user subscribes to from local user.
INT32 nUserData
 The nUserData of the UserAccount used by the user to log in. This field can be use to denote e.g. a database ID.
TTCHAR szAudioFolder [TT_STRLEN]
 Store audio received from this user to this folder.
AudioFileFormat uAFF
 The AudioFileFormat used for audio files.
TTCHAR szAudioFileName [TT_STRLEN]
 Name of audio file currently being recorded.

Detailed Description

A struct containing the properties of a user.

See also:
UserType
TT_GetUser

Member Data Documentation

The user's ID. A value from 1 - 65535.

The user's nickname.

See also:
TT_DoChangeNickname

Username of user's account.

The user's currently status mode.

See also:
TT_DoChangeStatusMode

The user's current status message.

See also:
TT_DoChangeStatusMode

The channel the user is currently participating in. 0 if none.

The user's IP-address.

TTCHAR User::szVersion[TT_STRLEN]

The user's client version.

A bitmask of the type of user based on UserType.

A bitmask of the user's current state, e.g. talking, muted, etc.

A bitmask of what the local user subscribes to from this user.

See also:
TT_DoSubscribe

A bitmask of what this user subscribes to from local user.

See also:
TT_DoSubscribe

The nUserData of the UserAccount used by the user to log in. This field can be use to denote e.g. a database ID.

Store audio received from this user to this folder.

See also:
TT_SetUserAudioFolder

The AudioFileFormat used for audio files.

See also:
TT_SetUserAudioFolder()

Name of audio file currently being recorded.

See also:
TT_SetUserAudioFolder()
Generated on Sun Mar 18 17:18:33 2012 for TeamTalk 4 C-API DLL by  doxygen 1.6.3