TeamTalk 5 C-API DLL: User Struct Reference

TeamTalk 5 C-API DLL Version 5.18A

Loading...
Searching...
No Matches
Public Attributes | List of all members
User Struct Reference
User Properties

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

`#include <TeamTalk.h>`

## Public Attributes

INT32 | nUserID
| The user's ID. A value from 1 - TT_USERID_MAX. This property is set by the server and will not change after login.
TTCHAR | szUsername [TT_STRLEN]
| The szUsername of the user's UserAccount. A user account is created by calling TT_DoNewUserAccount(). This property is set by the server and will not change after login.
INT32 | nUserData
| The nUserData of the user's 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.
UserTypes | uUserType
| The uUserType of the user's UserAccount. This property is set by the server and will not change after login.
TTCHAR | szIPAddress [TT_STRLEN]
| The user's IP-address. This value is set by the server.
UINT32 | 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.

INT32 | nChannelID

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

Subscriptions | uLocalSubscriptions
| A bitmask of what the local user subscribes to from this user. Invoking TT_DoSubscribe() and TT_DoUnsubscribe() on the local client instance can change this value. Event CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.
Subscriptions | uPeerSubscriptions
| A bitmask of what this user subscribes to from local client instance. Invoking TT_DoSubscribe() and TT_DoUnsubscribe() on the remote client instance can change this value. Event CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.
TTCHAR | szNickname [TT_STRLEN]
| The user's nickname. Invoking TT_DoChangeNickname() changes this value. Event CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.
INT32 | nStatusMode
| The user's current status mode. Invoke TT_DoChangeStatus() to change this value. Event CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.
TTCHAR | szStatusMsg [TT_STRLEN]
| The user's current status message. Invoke TT_DoChangeStatus() to change this value. Event CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.
UserStates | uUserState
| A bitmask of the user's current state, e.g. talking, muted, etc.
TTCHAR | szMediaStorageDir [TT_STRLEN]
| Store audio received from this user to this folder.
INT32 | 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 SOUND_VOLUME_MIN and SOUND_VOLUME_MAX.
INT32 | 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 SOUND_VOLUME_MIN and SOUND_VOLUME_MAX.
INT32 | nStoppedDelayVoice
| The delay of when a user should no longer be considered as talking.
INT32 | nStoppedDelayMediaFile
| The delay of when a user should no longer be considered playing audio of a media file.
float | soundPositionVoice [3]
| 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 [3]
| 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.
TTBOOL | stereoPlaybackVoice [2]
| 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.
TTBOOL | stereoPlaybackMediaFile [2]
| 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.
INT32 | nBufferMSecVoice
| The size of the buffer (in msec) to hold voice content.
INT32 | nBufferMSecMediaFile
| The size of the buffer (in msec) to hold media file content.
INT32 | nActiveAdaptiveDelayMSec
| the currently active adaptive jitter delay for received voice streams for this user.
TTCHAR | szClientName [TT_STRLEN]
| The name of the client application which the user is using. This is the value passed as `szClientName` in TT_DoLoginEx()

## Detailed Description

A struct containing the properties of a user.

See also
  UserType
  TT_GetUser

Definition at line 2196 of file TeamTalk.h.

## Member Data Documentation

## ◆ nUserID

INT32 User::nUserID

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

Definition at line 2201 of file TeamTalk.h.

## ◆ szUsername

TTCHAR User::szUsername[TT_STRLEN]

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

Definition at line 2206 of file TeamTalk.h.

## ◆ nUserData

INT32 User::nUserData

The nUserData of the user's 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 2211 of file TeamTalk.h.

## ◆ uUserType

UserTypes User::uUserType

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

Definition at line 2215 of file TeamTalk.h.

## ◆ szIPAddress

TTCHAR User::szIPAddress[TT_STRLEN]

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

Definition at line 2217 of file TeamTalk.h.

## ◆ uVersion

UINT32 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 2223 of file TeamTalk.h.

## ◆ nChannelID

INT32 User::nChannelID

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

Definition at line 2229 of file TeamTalk.h.

## ◆ uLocalSubscriptions

Subscriptions User::uLocalSubscriptions

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

Definition at line 2235 of file TeamTalk.h.

## ◆ uPeerSubscriptions

Subscriptions User::uPeerSubscriptions

A bitmask of what this user subscribes to from local client instance. Invoking TT_DoSubscribe() and TT_DoUnsubscribe() on the remote client instance can change this value. Event CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.

Definition at line 2241 of file TeamTalk.h.

## ◆ szNickname

TTCHAR User::szNickname[TT_STRLEN]

The user's nickname. Invoking TT_DoChangeNickname() changes this value. Event CLIENTEVENT_CMD_USER_UPDATE is posted if this value changes.

Definition at line 2246 of file TeamTalk.h.

## ◆ nStatusMode

INT32 User::nStatusMode

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

Definition at line 2251 of file TeamTalk.h.

## ◆ szStatusMsg

TTCHAR User::szStatusMsg[TT_STRLEN]

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

Definition at line 2256 of file TeamTalk.h.

## ◆ uUserState

UserStates User::uUserState

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

Definition at line 2259 of file TeamTalk.h.

## ◆ szMediaStorageDir

TTCHAR User::szMediaStorageDir[TT_STRLEN]

Store audio received from this user to this folder.

See also
  TT_SetUserMediaStorageDir

Definition at line 2262 of file TeamTalk.h.

## ◆ nVolumeVoice

INT32 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 SOUND_VOLUME_MIN and SOUND_VOLUME_MAX.

See also
  TT_SetUserVolume

Definition at line 2268 of file TeamTalk.h.

## ◆ nVolumeMediaFile

INT32 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 SOUND_VOLUME_MIN and SOUND_VOLUME_MAX.

See also
  TT_SetUserVolume

Definition at line 2274 of file TeamTalk.h.

## ◆ nStoppedDelayVoice

INT32 User::nStoppedDelayVoice

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

See also
  TT_SetUserStoppedTalkingDelay

Definition at line 2278 of file TeamTalk.h.

## ◆ nStoppedDelayMediaFile

INT32 User::nStoppedDelayMediaFile

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

See also
  TT_SetUserStoppedTalkingDelay

Definition at line 2282 of file TeamTalk.h.

## ◆ soundPositionVoice

float User::soundPositionVoice[3]

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
  TT_SetUserPosition()
  SoundDevice

Definition at line 2287 of file TeamTalk.h.

## ◆ soundPositionMediaFile

float User::soundPositionMediaFile[3]

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
  TT_SetUserPosition()
  SoundDevice

Definition at line 2292 of file TeamTalk.h.

## ◆ stereoPlaybackVoice

TTBOOL User::stereoPlaybackVoice[2]

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
  TT_SetUserStereo

Definition at line 2297 of file TeamTalk.h.

## ◆ stereoPlaybackMediaFile

TTBOOL User::stereoPlaybackMediaFile[2]

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
  TT_SetUserStereo

Definition at line 2302 of file TeamTalk.h.

## ◆ nBufferMSecVoice

INT32 User::nBufferMSecVoice

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

See also
  TT_SetUserAudioStreamBufferSize()

Definition at line 2306 of file TeamTalk.h.

## ◆ nBufferMSecMediaFile

INT32 User::nBufferMSecMediaFile

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

See also
  TT_SetUserAudioStreamBufferSize()

Definition at line 2310 of file TeamTalk.h.

## ◆ nActiveAdaptiveDelayMSec

INT32 User::nActiveAdaptiveDelayMSec

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

See also
  TT_SetUserJitterControl

Definition at line 2314 of file TeamTalk.h.

## ◆ szClientName

TTCHAR User::szClientName[TT_STRLEN]

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

Definition at line 2318 of file TeamTalk.h.