TeamTalk 5 Java DLL Version 5.12A
|
This section explains users interact and how to configure user settings. More...
Classes | |
struct | BearWare.User |
A struct containing the properties of a user. More... | |
struct | BearWare.UserStatistics |
Packet reception and data statistics for a user. More... | |
struct | BearWare.TextMessage |
A struct containing the properties of a text message sent by a user. More... | |
Enumerations | |
enum | BearWare.UserType : uint |
The types of users supported. More... | |
enum | BearWare.Subscription : uint |
A user by default accepts audio, video and text messages from all users. Using subscribtions can, however, change what the local client instance is willing to accept from other users. More... | |
enum | BearWare.UserState : uint |
The possible states for a user. Used for BearWare.User's uUserState variable. More... | |
enum | BearWare.TextMsgType : uint |
Text message types. More... | |
Functions | |
int | BearWare.TeamTalkBase.GetMyUserID () |
Get the local client instance's user ID. More... | |
bool | BearWare.TeamTalkBase.GetMyUserAccount (ref UserAccount lpUserAccount) |
Get the local client instance's BearWare.UserAccount. More... | |
UserType | BearWare.TeamTalkBase.GetMyUserType () |
Get the client instance's user type. More... | |
BearWare.UserRight | BearWare.TeamTalkBase.GetMyUserRights () |
Convenience method for TeamTalkBase.GetMyUserAccount() More... | |
int | BearWare.TeamTalkBase.GetMyUserData () |
If an account was used in TeamTalkBase.DoLogin() then this value will return the nUserData from the BearWare.UserAccount. More... | |
bool | BearWare.TeamTalkBase.GetUser (int nUserID, ref User lpUser) |
Get the user with the specified ID. More... | |
bool | BearWare.TeamTalkBase.GetUserStatistics (int nUserID, ref UserStatistics lpUserStatistics) |
Get statistics for data and packet reception from a user. More... | |
bool | BearWare.TeamTalkBase.GetUserByUsername (string szUsername, ref User lpUser) |
Get the user with the specified username. More... | |
Variables | |
const int | BearWare.TeamTalkBase.TT_CHANNELS_OPERATOR_MAX = 16 |
Properties | |
int | BearWare.TeamTalkBase.UserID [get] |
Same as GetMyUserID(). More... | |
BearWare.UserType | BearWare.TeamTalkBase.UserType [get] |
Same as GetMyUserType(). More... | |
BearWare.UserRight | BearWare.TeamTalkBase.UserRights [get] |
Same as GetMyUserRights(). More... | |
int | BearWare.TeamTalkBase.UserData [get] |
Same as GetMyUserData(). More... | |
This section explains users interact and how to configure user settings.
Users can be seen on the server after a successful call to TeamTalkBase.DoLogin(). Once logged in a user can send user to user text-messages using TeamTalkBase.DoTextMessage() as well as receive broadcast messages. A user cannot send audio and video data to other users until they have joined the same channel.
Sections:
A user can either be a default user #UserType.USERTYPE_DEFAULT or an administrator #UserType.USERTYPE_ADMIN. A default user has limited rights on the server (see uUserRights
of BearWare.UserAccount) whereas an administrator can change server properties, create, delete and remove channels as well as move, kick and ban users. Checkout User Administration on how to set up user rights.
Once a user has joined a channel it is possible to transmit voice and video data to other users. If a user starts talking in the channel the event TeamTalkBase.OnUserStateChange() is posted to the user application and if a video frame is received the event TeamTalkBase.OnUserVideoFrame() is sent to the user application.
While in the same channel the user application can change different settings on a user. If e.g. a user's volume is too low the user application can call TeamTalkBase.SetUserVolume() to increase the volume.
If on the other hand the user application wants to mute a user TeamTalkBase.SetUserMute() can be used for this. Note that muting a user doesn't mean that the client instance will stop receiving audio from that user, it simply means it will not be played. To stop receiving audio from a user the local client instance must ask the server to unsubscribe audio data from the user. This is explained in the next section.
When logging on to a server the local client instance will by default subscribe to user messages, channel messages, broadcast messages, audio data and video data from all users. If, however, a client wants to stop receiving e.g. audio from a user, he can call TeamTalkBase.DoUnsubscribe() along with the user ID and the #Subscription.SUBSCRIBE_VOICE-flag to tell the server that he no longer wants to receive audio from that user. The server will then respond with the event TeamTalkBase.OnCmdUserUpdate() and the uLocalSubscriptions member of BearWare.User will have the #Subscription.SUBSCRIBE_VOICE-flag removed. At the remote user the uPeerSubscriptions member will be changed. Subscribe/unsubscribe can also be done for user, channel and broadcast messages and video data. The function TeamTalkBase.DoSubscribe() can be used to revert unsubscriptions.
Previously it has been said that users can only receive audio and video from users when they are in the same channel, but actually an administrator user can call TeamTalkBase.DoSubscribe() with the flags prefixed SUBSCRIBE_INTERCEPT_* to spy on users outside his own channel. In other words it's possible hear and see video data outside ones channel. Also all user and channel messages sent by a user can also be intercepted in this way.
Having the ability to intercept all data sent from users in any channel means that it's possible to log everything that is happening on the server. Both audio and video transfers as well as text messaging. Checkout TeamTalkBase.SetUserMediaStorageDir() on how to store voice data to audio files.
enum BearWare.UserType : uint |
enum BearWare.Subscription : uint |
A user by default accepts audio, video and text messages from all users. Using subscribtions can, however, change what the local client instance is willing to accept from other users.
By calling TeamTalkBase.DoSubscribe() and TeamTalkBase.DoUnsubscribe() the local client instance can tell the server (and thereby remote users) what he is willing to accept from other users.
To check what a user subscribes to check out the BearWare.User struct's uLocalSubscriptions. The subscriptions with the prefix SUBSCRIBE_INTERCEPT_* options can be used to spy on users and receive data from them even if one is not participating in the same channel as they are.
Definition at line 2181 of file TeamTalk.cs.
enum BearWare.UserState : uint |
The possible states for a user. Used for BearWare.User's uUserState variable.
Definition at line 2247 of file TeamTalk.cs.
enum BearWare.TextMsgType : uint |
Text message types.
The types of messages which can be passed to TeamTalkBase.DoTextMessage().
Definition at line 2474 of file TeamTalk.cs.
int BearWare.TeamTalkBase.GetMyUserID | ( | ) |
Get the local client instance's user ID.
This information can be retrieved after the OnCmdMyselfLoggedIn event.
Definition at line 7669 of file TeamTalk.cs.
bool BearWare.TeamTalkBase.GetMyUserAccount | ( | ref UserAccount | lpUserAccount | ) |
Get the local client instance's BearWare.UserAccount.
This information can be retrieved after TeamTalkBase.OnCmdMyselfLoggedIn() event.
lpUserAccount | The local client's user account registered on the server. Note that the szPassword field of BearWare.UserAccount will not be set. |
Definition at line 7684 of file TeamTalk.cs.
UserType BearWare.TeamTalkBase.GetMyUserType | ( | ) |
Get the client instance's user type.
This information can be retrieved after OnCmdMyselfLoggedIn event.
Definition at line 7704 of file TeamTalk.cs.
BearWare.UserRight BearWare.TeamTalkBase.GetMyUserRights | ( | ) |
Convenience method for TeamTalkBase.GetMyUserAccount()
Definition at line 7720 of file TeamTalk.cs.
int BearWare.TeamTalkBase.GetMyUserData | ( | ) |
If an account was used in TeamTalkBase.DoLogin() then this value will return the nUserData from the BearWare.UserAccount.
This information can be retrieved after OnCmdMyselfLoggedIn event.
Definition at line 7734 of file TeamTalk.cs.
bool BearWare.TeamTalkBase.GetUser | ( | int | nUserID, |
ref User | lpUser | ||
) |
Get the user with the specified ID.
nUserID | The ID of the user to extract. |
lpUser | A preallocated BearWare.User struct. |
Definition at line 7750 of file TeamTalk.cs.
bool BearWare.TeamTalkBase.GetUserStatistics | ( | int | nUserID, |
ref UserStatistics | lpUserStatistics | ||
) |
Get statistics for data and packet reception from a user.
nUserID | The ID of the user to extract. |
lpUserStatistics | A preallocated BearWare.UserStatistics struct. |
Definition at line 7759 of file TeamTalk.cs.
bool BearWare.TeamTalkBase.GetUserByUsername | ( | string | szUsername, |
ref User | lpUser | ||
) |
Get the user with the specified username.
Remember to take into account that multiple users can log in with the same account if #UserRight.USERRIGHT_MULTI_LOGIN is specified.
szUsername | The user's username (from BearWare.UserAccount). |
lpUser | A preallocated BearWare.User struct. |
Definition at line 7771 of file TeamTalk.cs.
|
static |
The maximum number of channels where a user can automatically become channel operator.
Definition at line 4265 of file TeamTalk.cs.
|
get |
Same as GetMyUserID().
Definition at line 7692 of file TeamTalk.cs.
|
get |
Same as GetMyUserType().
Definition at line 7712 of file TeamTalk.cs.
|
get |
Same as GetMyUserRights().
Definition at line 7717 of file TeamTalk.cs.
|
get |
Same as GetMyUserData().
Definition at line 7742 of file TeamTalk.cs.