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

Public Attributes
int	nUserID
	The user's ID. A value from 1 - BearWare.TeamTalkBase.TT_USERID_MAX. This property is set by the server and will not change after login.

string	szUsername
	The szUsername of the user's BearWare.UserAccount. A user account is created by calling TeamTalkBase.DoNewUserAccount(). This property is set by the server and will not change after login.

int	nUserData
	The nUserData of the user's BearWare.UserAccount. This field can be use to denote e.g. a database ID. This property is set by the server and will not change after login.

UserType	uUserType
	The uUserType of the user's BearWare.UserAccount. This property is set by the server and will not change after login.

string	szIPAddress
	The user's IP-address. This value is set by the server.

uint	uVersion
	The user's client version. This property is set by the server and will not change after login. Three octets are used for the version number. Third octet is major, second octet is minor and third octet is build. I.e. 0x00050201 is version 5.2.1.

int	nChannelID
	The channel which the user is currently participating in. 0 if none. This value can change as a result of TeamTalkBase.DoJoinChannel() or TeamTalkBase.DoLeaveChannel(). Events BearWare.ClientEvent.CLIENTEVENT_CMD_USER_JOINED and BearWare.ClientEvent.CLIENTEVENT_CMD_USER_LEFT are posted when this value changes.

Subscription	uLocalSubscriptions
	A bitmask of what the local user subscribes to from this user. Invoking TeamTalkBase.DoSubscribe() and TeamTalkBase.DoUnsubscribe() on the local client instance can change this value. Event BearWare.ClientEvent.CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.

Subscription	uPeerSubscriptions
	A bitmask of what this user subscribes to from local client instance. Invoking TeamTalkBase.DoSubscribe() and TeamTalkBase.DoUnsubscribe() on the remoe client instance can change this value. Event BearWare.ClientEvent.CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.

string	szNickname
	The user's nickname. Invoking TeamTalkBase.DoChangeNickname() changes this value. Event BearWare.ClientEvent.CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.

int	nStatusMode
	The user's current status mode. Invoke TeamTalkBase.DoChangeStatus() to change this value. Event BearWare.ClientEvent.CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.

string	szStatusMsg
	The user's current status message. Invoke TeamTalkBase.DoChangeStatus() to change this value. Event BearWare.ClientEvent.CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.

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

string	szMediaStorageDir
	Store audio received from this user to this folder.

int	nVolumeVoice
	The user's voice volume level. Note that it's a virtual volume which is being set since the master volume affects the user volume. The value will be between BearWare.SoundLevel.SOUND_VOLUME_MIN and BearWare.SoundLevel.SOUND_VOLUME_MAX.

int	nVolumeMediaFile
	The user's voice volume level. Note that it's a virtual volume which is being set since the master volume affects the user volume. The value will be between BearWare.SoundLevel.SOUND_VOLUME_MIN and BearWare.SoundLevel.SOUND_VOLUME_MAX.

int	nStoppedDelayVoice
	The delay of when a user should no longer be considered as talking.

int	nStoppedDelayMediaFile
	The delay of when a user should no longer be considered playing audio of a media file.

float[]	soundPositionVoice
	User's position when using 3D-sound (DirectSound option). Index 0 is x-axis, index 1 is y-axis and index 2 is Z-axis.

float[]	soundPositionMediaFile
	User's position when using 3D-sound (DirectSound option). Index 0 is x-axis, index 1 is y-axis and index 2 is Z-axis.

bool[]	stereoPlaybackVoice
	Check what speaker a user is outputting to. If index 0 is TRUE then left speaker is playing. If index 1 is TRUE then right speaker is playing.

bool[]	stereoPlaybackMediaFile
	Check what speaker a user is outputting to. If index 0 is TRUE then left speaker is playing. If index 1 is TRUE then right speaker is playing.

int	nBufferMSecVoice
	The size of the buffer (in msec) to hold voice content.

int	nBufferMSecMediaFile
	The size of the buffer (in msec) to hold media file content.

int	nActiveAdaptiveDelayMSec
	The currently active adaptive jitter delay for received voice streams for this user.

string	szClientName
	The name of the client application which the user is using. This is the value passed as `szClientName` in TeamTalkBase.DoLoginEx()

Detailed Description

A struct containing the properties of a user.

See also: BearWare.UserType; BearWare.TeamTalkBase.GetUser

Definition at line 2307 of file TeamTalk.cs.

Member Data Documentation

◆ nUserID

int BearWare.User.nUserID

The user's ID. A value from 1 - BearWare.TeamTalkBase.TT_USERID_MAX. This property is set by the server and will not change after login.

Definition at line 2312 of file TeamTalk.cs.

◆ szUsername

string BearWare.User.szUsername

The szUsername of the user's BearWare.UserAccount. A user account is created by calling TeamTalkBase.DoNewUserAccount(). This property is set by the server and will not change after login.

Definition at line 2318 of file TeamTalk.cs.

◆ nUserData

int BearWare.User.nUserData

The nUserData of the user's BearWare.UserAccount. This field can be use to denote e.g. a database ID. This property is set by the server and will not change after login.

Definition at line 2323 of file TeamTalk.cs.

◆ uUserType

UserType BearWare.User.uUserType

The uUserType of the user's BearWare.UserAccount. This property is set by the server and will not change after login.

Definition at line 2327 of file TeamTalk.cs.

◆ szIPAddress

string BearWare.User.szIPAddress

The user's IP-address. This value is set by the server.

Definition at line 2330 of file TeamTalk.cs.

◆ uVersion

uint BearWare.User.uVersion

The user's client version. This property is set by the server and will not change after login. Three octets are used for the version number. Third octet is major, second octet is minor and third octet is build. I.e. 0x00050201 is version 5.2.1.

Definition at line 2336 of file TeamTalk.cs.

◆ nChannelID

int BearWare.User.nChannelID

The channel which the user is currently participating in. 0 if none. This value can change as a result of TeamTalkBase.DoJoinChannel() or TeamTalkBase.DoLeaveChannel(). Events BearWare.ClientEvent.CLIENTEVENT_CMD_USER_JOINED and BearWare.ClientEvent.CLIENTEVENT_CMD_USER_LEFT are posted when this value changes.

Definition at line 2342 of file TeamTalk.cs.

◆ uLocalSubscriptions

Subscription BearWare.User.uLocalSubscriptions

A bitmask of what the local user subscribes to from this user. Invoking TeamTalkBase.DoSubscribe() and TeamTalkBase.DoUnsubscribe() on the local client instance can change this value. Event BearWare.ClientEvent.CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.

Definition at line 2348 of file TeamTalk.cs.

◆ uPeerSubscriptions

Subscription BearWare.User.uPeerSubscriptions

A bitmask of what this user subscribes to from local client instance. Invoking TeamTalkBase.DoSubscribe() and TeamTalkBase.DoUnsubscribe() on the remoe client instance can change this value. Event BearWare.ClientEvent.CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.

Definition at line 2354 of file TeamTalk.cs.

◆ szNickname

string BearWare.User.szNickname

The user's nickname. Invoking TeamTalkBase.DoChangeNickname() changes this value. Event BearWare.ClientEvent.CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.

Definition at line 2360 of file TeamTalk.cs.

◆ nStatusMode

int BearWare.User.nStatusMode

The user's current status mode. Invoke TeamTalkBase.DoChangeStatus() to change this value. Event BearWare.ClientEvent.CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.

Definition at line 2365 of file TeamTalk.cs.

◆ szStatusMsg

string BearWare.User.szStatusMsg

The user's current status message. Invoke TeamTalkBase.DoChangeStatus() to change this value. Event BearWare.ClientEvent.CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.

Definition at line 2371 of file TeamTalk.cs.

◆ uUserState

UserState BearWare.User.uUserState

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

Definition at line 2374 of file TeamTalk.cs.

◆ szMediaStorageDir

string BearWare.User.szMediaStorageDir

Store audio received from this user to this folder.

See also: TeamTalkBase.SetUserMediaStorageDir

Definition at line 2378 of file TeamTalk.cs.

◆ nVolumeVoice

int BearWare.User.nVolumeVoice

The user's voice volume level. Note that it's a virtual volume which is being set since the master volume affects the user volume. The value will be between BearWare.SoundLevel.SOUND_VOLUME_MIN and BearWare.SoundLevel.SOUND_VOLUME_MAX.

See also: TeamTalkBase.SetUserVolume

Definition at line 2384 of file TeamTalk.cs.

◆ nVolumeMediaFile

int BearWare.User.nVolumeMediaFile

The user's voice volume level. Note that it's a virtual volume which is being set since the master volume affects the user volume. The value will be between BearWare.SoundLevel.SOUND_VOLUME_MIN and BearWare.SoundLevel.SOUND_VOLUME_MAX.

See also: TeamTalkBase.SetUserVolume

Definition at line 2390 of file TeamTalk.cs.

◆ nStoppedDelayVoice

int BearWare.User.nStoppedDelayVoice

The delay of when a user should no longer be considered as talking.

See also: TeamTalkBase.SetUserStoppedTalkingDelay

Definition at line 2394 of file TeamTalk.cs.

◆ nStoppedDelayMediaFile

int BearWare.User.nStoppedDelayMediaFile

The delay of when a user should no longer be considered playing audio of a media file.

See also: TeamTalkBase.SetUserStoppedTalkingDelay

Definition at line 2398 of file TeamTalk.cs.

◆ soundPositionVoice

float [] BearWare.User.soundPositionVoice

User's position when using 3D-sound (DirectSound option). Index 0 is x-axis, index 1 is y-axis and index 2 is Z-axis.

See also: TeamTalkBase.SetUserPosition; SoundDevice

Definition at line 2404 of file TeamTalk.cs.

◆ soundPositionMediaFile

float [] BearWare.User.soundPositionMediaFile

User's position when using 3D-sound (DirectSound option). Index 0 is x-axis, index 1 is y-axis and index 2 is Z-axis.

See also: TeamTalkBase.SetUserPosition; SoundDevice

Definition at line 2410 of file TeamTalk.cs.

◆ stereoPlaybackVoice

bool [] BearWare.User.stereoPlaybackVoice

Check what speaker a user is outputting to. If index 0 is TRUE then left speaker is playing. If index 1 is TRUE then right speaker is playing.

See also: TeamTalkBase.SetUserStereo

Definition at line 2416 of file TeamTalk.cs.

◆ stereoPlaybackMediaFile

bool [] BearWare.User.stereoPlaybackMediaFile

Check what speaker a user is outputting to. If index 0 is TRUE then left speaker is playing. If index 1 is TRUE then right speaker is playing.

See also: TeamTalkBase.SetUserStereo

Definition at line 2422 of file TeamTalk.cs.

◆ nBufferMSecVoice

int BearWare.User.nBufferMSecVoice

The size of the buffer (in msec) to hold voice content.

See also: TeamTalkBase.SetUserAudioStreamBufferSize()

Definition at line 2426 of file TeamTalk.cs.

◆ nBufferMSecMediaFile

int BearWare.User.nBufferMSecMediaFile

The size of the buffer (in msec) to hold media file content.

See also: TeamTalkBase.SetUserAudioStreamBufferSize()

Definition at line 2430 of file TeamTalk.cs.

◆ nActiveAdaptiveDelayMSec

int BearWare.User.nActiveAdaptiveDelayMSec

The currently active adaptive jitter delay for received voice streams for this user.

See also: TT_SetUserJitterControl

Definition at line 2434 of file TeamTalk.cs.

◆ szClientName

string BearWare.User.szClientName

The name of the client application which the user is using. This is the value passed as szClientName in TeamTalkBase.DoLoginEx()

Definition at line 2439 of file TeamTalk.cs.

Public Attributes