TeamTalk 4 .NET DLL  Version 4.5A
BearWare.User Struct Reference

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

Public Attributes

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

Detailed Description

A struct containing the properties of a user.

See Also
BearWare.UserType
BearWare.TeamTalk4.GetUser

Member Data Documentation

int BearWare.User.nUserID

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

string BearWare.User.szNickname

The user's nickname.

See Also
BearWare.TeamTalk4.DoChangeNickname
string BearWare.User.szUsername

Username of user's account.

int BearWare.User.nStatusMode

The user's currently status mode.

See Also
BearWare.TeamTalk4.DoChangeStatusMode
string BearWare.User.szStatusMsg

The user's current status message.

See Also
BearWare.TeamTalk4.DoChangeStatusMode
int BearWare.User.nChannelID

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

string BearWare.User.szIPAddress

The user's IP-address.

string BearWare.User.szVersion

The user's client version.

UserType BearWare.User.uUserType

A bitmask of the type of user based on UserType.

UserState BearWare.User.uUserState

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

Subscription BearWare.User.uLocalSubscriptions

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

See Also
BearWare.TeamTalk4.DoSubscribe
Subscription BearWare.User.uPeerSubscriptions

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

See Also
BearWare.TeamTalk4.DoSubscribe
int BearWare.User.nUserData

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

string BearWare.User.szAudioFolder

Store audio received from this user to this folder.

See Also
TeamTalk4.SetUserAudioFolder
AudioFileFormat BearWare.User.uAFF

The AudioFileFormat used for audio files.

See Also
TeamTalk4.SetUserAudioFolder()
string BearWare.User.szAudioFileName

Name of audio file currently being recorded.

See Also
TeamTalk4.SetUserAudioFolder()