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

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

#include <TeamTalk4.h>

Public Attributes

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

Detailed Description

A struct containing the properties of a user.

See Also
UserType
TT_GetUser

Member Data Documentation

INT32 User::nUserID

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

TTCHAR User::szNickname[TT_STRLEN]

The user's nickname.

See Also
TT_DoChangeNickname
TTCHAR User::szUsername[TT_STRLEN]

Username of user's account.

INT32 User::nStatusMode

The user's currently status mode.

See Also
TT_DoChangeStatus()
TTCHAR User::szStatusMsg[TT_STRLEN]

The user's current status message.

See Also
TT_DoChangeStatus()
INT32 User::nChannelID

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

TTCHAR User::szIPAddress[TT_STRLEN]

The user's IP-address.

TTCHAR User::szVersion[TT_STRLEN]

The user's client version.

UserTypes User::uUserType

A bitmask of the type of user based on UserType.

UserStates User::uUserState

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

Subscriptions User::uLocalSubscriptions

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

See Also
TT_DoSubscribe
Subscriptions User::uPeerSubscriptions

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

See Also
TT_DoSubscribe
INT32 User::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 User::szAudioFolder[TT_STRLEN]

Store audio received from this user to this folder.

See Also
TT_SetUserAudioFolder
AudioFileFormat User::uAFF

The AudioFileFormat used for audio files.

See Also
TT_SetUserAudioFolder()
TTCHAR User::szAudioFileName[TT_STRLEN]

Name of audio file currently being recorded.

See Also
TT_SetUserAudioFolder()