TeamTalk 5 Java DLL Version 5.12A
|
This section explains how to handle events generated by the client instance. More...
Classes | |
struct | BearWare.TTMessage |
A struct containing the properties of an event. More... | |
struct | BearWare.UnionData |
Enumerations | |
enum | BearWare.ClientEvent : uint |
TeamTalk client event messages. More... | |
enum | BearWare.TTType : uint |
This section explains how to handle events generated by the client instance.
When events occur in the client instance, like e.g. if a new user joins a channel, the client instance invokes an event which the user application must act upon. The message queue for events is limited to 1 MB. If the queue grows above the maximum size then event handling is suspended and will not be resumed until the queue size is again below the maximum size. The event #ClientError.INTERR_TTMESSAGE_QUEUE_OVERFLOW will be posted to the message queue if an overflow has taken place.
Note that when an event occurs the TeamTalk client instance doesn't wait for the user application to process the event. So if e.g. a user sends a text-message and immediately after disconnects from the server, then the BearWare.User, who sent the message, cannot be retrieved using TeamTalkBase.GetUser() since the user is no longer available when the user application starts processing the new text-message event. This is, of course, annoying when designing the user application, but the reason for this design choice it that the client instance is a realtime component which cannot wait for the UI to process data, since audio playback and recording would then be halted.
The section Client Programming Guide gives a good idea of how events are processed in a user application.
enum BearWare.ClientEvent : uint |
TeamTalk client event messages.
Events are retrieved using TeamTalkBase.GetMessage().
Definition at line 3343 of file TeamTalk.cs.
enum BearWare.TTType : uint |
Definition at line 3901 of file TeamTalk.cs.
delegate void BearWare.TeamTalkBase.Connection | ( | ) |
Delegate for events OnConnectionSuccess, OnConnectionFailed and OnConnectionLost.
delegate void BearWare.TeamTalkBase.MaxPayloadUpdate | ( | int | nPayloadSize | ) |
Delegate for event OnConnectionMaxPayloadUpdated().
nPayloadSize | The maximum size in bytes of the payload data which is put in UDP packets. 0 means the max payload query failed. |
delegate void BearWare.TeamTalkBase.CommandProcessing | ( | int | nCmdID, |
bool | bActive | ||
) |
Delegate for event OnCmdProcessing.
nCmdID | Command ID being processed (returned by Do* commands) |
bActive | Is true if command ID started processing and false if the command has finished processing. |
delegate void BearWare.TeamTalkBase.CommandError | ( | int | nCmdID, |
ClientErrorMsg | clienterrormsg | ||
) |
Delegate for event OnCmdError.
nCmdID | The command ID returned from the Do* commands. |
clienterrormsg | Contains error description. |
delegate void BearWare.TeamTalkBase.CommandSuccess | ( | int | nCmdID | ) |
Delegate for event CommandSuccess.
nCmdID | The command ID returned from the Do* commands. |
delegate void BearWare.TeamTalkBase.MyselfLoggedIn | ( | int | nMyUserID, |
UserAccount | useraccount | ||
) |
Delegate for event OnCmdMyselfLoggedIn.
nMyUserID | The client instance's user ID, i.e. what can now be retrieved through GetMyUserID. |
useraccount | The BearWare.UserAccount of the local client instance. |
delegate void BearWare.TeamTalkBase.MyselfLoggedOut | ( | ) |
Delegate for event OnCmdMyselfLoggedOut.
delegate void BearWare.TeamTalkBase.MyselfKicked | ( | User | user | ) |
Delegate for event OnCmdMyselfKicked.
user | The user who kicked the local client instance. If user who kicked is unspecified a null user (user-id is 0) will be passed. |
delegate void BearWare.TeamTalkBase.UserUpdate | ( | User | user | ) |
Delegate for events OnCmdUserLoggedIn, OnCmdUserLoggedOut, OnCmdUserUpdate, OnCmdUserJoinedChannel and OnCmdUserLeftChannel.
user | The user. |
delegate void BearWare.TeamTalkBase.UserStreamUpdate | ( | User | user, |
int | nStreamID | ||
) |
Delegate for events OnUserFirstVoiceStreamPacket.
user | The user. |
nStreamID | Stream ID of the newly opened stream. |
delegate void BearWare.TeamTalkBase.UserTextMessage | ( | TextMessage | textmessage | ) |
Delegate for events OnCmdUserTextMessage.
delegate void BearWare.TeamTalkBase.ChannelUpdate | ( | Channel | channel | ) |
Delegate for OnCmdChannelNew, OnCmdChannelUpdate and OnCmdChannelRemove.
delegate void BearWare.TeamTalkBase.ServerUpdate | ( | ServerProperties | serverproperties | ) |
Delegate for event OnCmdServerUpdate.
delegate void BearWare.TeamTalkBase.ServerStats | ( | ServerStatistics | serverstatistics | ) |
Delegate for event OnCmdServerStatistics.
delegate void BearWare.TeamTalkBase.FileUpdate | ( | RemoteFile | remotefile | ) |
A delegate for events OnCmdFileNew and OnCmdFileRemove.
delegate void BearWare.TeamTalkBase.ListUserAccount | ( | UserAccount | useraccount | ) |
A delegate for event OnCmdUserAccount.
delegate void BearWare.TeamTalkBase.ListBannedUser | ( | BannedUser | banneduser | ) |
A delegate for event OnCmdUserAccount.
delegate void BearWare.TeamTalkBase.UserVideoFrame | ( | int | nUserID, |
int | nStreamID | ||
) |
A delegate for the event OnUserVideoCapture.
delegate void BearWare.TeamTalkBase.NewDesktopWindow | ( | int | nUserID, |
int | nStreamID | ||
) |
Delegate for event OnUserDesktopWindow.
nUserID | The user's ID. |
nStreamID | The ID of the desktop window's session. If this ID changes it means the user has started a new session. If the session ID becomes 0 it means the desktop session has been closed by the user. |
delegate void BearWare.TeamTalkBase.UserDesktopInput | ( | int | nSrcUserID, |
DesktopInput | desktopinput | ||
) |
Delegate for event OnUserDesktopCursor().
delegate void BearWare.TeamTalkBase.UserRecordMediaFile | ( | int | nUserID, |
MediaFileInfo | mediafileinfo | ||
) |
Delegate for event OnUserRecordMediaFile.
delegate void BearWare.TeamTalkBase.NewAudioBlock | ( | int | nUserID, |
StreamType | nStreamType | ||
) |
Delegate for event OnUserAudioBlock.
delegate void BearWare.TeamTalkBase.ErrorOccured | ( | ClientErrorMsg | clienterrormsg | ) |
Delegate for event OnInternalError.
delegate void BearWare.TeamTalkBase.VoiceActivation | ( | bool | bVoiceActive | ) |
Delegate for event OnVoiceActivation.
bVoiceActive | TRUE if enabled, FALSE if disabled. |
delegate void BearWare.TeamTalkBase.HotKeyToggle | ( | int | nHotKeyID, |
bool | bActive | ||
) |
Delegate for event OnHotKeyToggle.
nHotKeyID | The hotkey ID passed to HotKey_Register |
bActive | TRUE when hotkey is active and FALSE when it becomes inactive. |
delegate void BearWare.TeamTalkBase.HotKeyTest | ( | int | nVkCode, |
bool | bActive | ||
) |
Delegate for event OnHotKeyTest.
nVkCode | The virtual key code. Look here for a list of virtual key codes: http://msdn.microsoft.com/en-us/library/ms645540(VS.85).aspx |
bActive | TRUE when key is down and FALSE when released. |
delegate void BearWare.TeamTalkBase.FileTransferUpdate | ( | FileTransfer | filetransfer | ) |
Delegate for event OnFileTransfer.
filetransfer | Properties and status information about the file transfer. |
delegate void BearWare.TeamTalkBase.DesktopTransferUpdate | ( | int | nSessionID, |
int | nBytesRemain | ||
) |
Delegate for event OnDesktopWindowTransfer().
nSessionID | The desktop session's ID. If the desktop session ID becomes 0 it means the desktop session has been closed and/or cancelled. |
nBytesRemain | The number of bytes remaining before transmission of last desktop window completes. When remaining bytes is 0 TeamTalkBase.SendDesktopWindow() can be called again. |
delegate void BearWare.TeamTalkBase.StreamMediaFile | ( | MediaFileInfo | mediafileinfo | ) |
Delegate for event OnStreamMediaFile.
delegate void BearWare.TeamTalkBase.LocalMediaFile | ( | MediaFileInfo | mediafileinfo | ) |
Delegate for event OnLocalMediaFile.
delegate void BearWare.TeamTalkBase.AudioInput | ( | AudioInputProgress | aip | ) |
Delegate for event OnAudioInput.
Connection BearWare.TeamTalkBase.OnConnectionSuccess |
Connected successfully to the server.
Event handler for #ClientEvent.CLIENTEVENT_CON_SUCCESS
Definition at line 8240 of file TeamTalk.cs.
Connection BearWare.TeamTalkBase.OnConnectionFailed |
Failed to connect to server.
Event handler for #ClientEvent.CLIENTEVENT_CON_FAILED
Definition at line 8248 of file TeamTalk.cs.
Connection BearWare.TeamTalkBase.OnConnectionLost |
Connection to server has been lost.
Event handler for #ClientEvent.CLIENTEVENT_CON_LOST
Definition at line 8256 of file TeamTalk.cs.
MaxPayloadUpdate BearWare.TeamTalkBase.OnConnectionMaxPayloadUpdated |
The maximum size of the payload put into UDP packets has been updated.
Event handler for #ClientEvent.CLIENTEVENT_CON_MAX_PAYLOAD_UPDATED
Definition at line 8272 of file TeamTalk.cs.
CommandProcessing BearWare.TeamTalkBase.OnCmdProcessing |
A command issued by Do*
methods is being processed.
Event handler for #ClientEvent.CLIENTEVENT_CMD_PROCESSING
Read section Client/Server Command Processing on how to use command processing in the user application.
Definition at line 8293 of file TeamTalk.cs.
CommandError BearWare.TeamTalkBase.OnCmdError |
The server rejected a command issued by the local client instance.
Event handler for #ClientEvent.CLIENTEVENT_CMD_ERROR
Definition at line 8309 of file TeamTalk.cs.
CommandSuccess BearWare.TeamTalkBase.OnCmdSuccess |
The server successfully processed a command issued by the local client instance.
Event handler for #ClientEvent.CLIENTEVENT_CMD_SUCCESS
Definition at line 8323 of file TeamTalk.cs.
MyselfLoggedIn BearWare.TeamTalkBase.OnCmdMyselfLoggedIn |
The client instance successfully logged on to server.
Event handler for #ClientEvent.CLIENTEVENT_CMD_MYSELF_LOGGEDIN
Definition at line 8340 of file TeamTalk.cs.
MyselfLoggedOut BearWare.TeamTalkBase.OnCmdMyselfLoggedOut |
The client instance logged out of a server.
Event handler for #ClientEvent.CLIENTEVENT_CMD_MYSELF_LOGGEDOUT
Definition at line 8351 of file TeamTalk.cs.
MyselfKicked BearWare.TeamTalkBase.OnCmdMyselfKicked |
The client instance was kicked from a channel.
Event handler for #ClientEvent.CLIENTEVENT_CMD_MYSELF_KICKED
Definition at line 8364 of file TeamTalk.cs.
UserUpdate BearWare.TeamTalkBase.OnCmdUserLoggedIn |
A new user logged on to the server.
Event handler for #ClientEvent.CLIENTEVENT_CMD_USER_LOGGEDIN
Definition at line 8384 of file TeamTalk.cs.
UserUpdate BearWare.TeamTalkBase.OnCmdUserLoggedOut |
A user logged out of the server.
Event handler for #ClientEvent.CLIENTEVENT_CMD_USER_LOGGEDOUT
Definition at line 8394 of file TeamTalk.cs.
UserUpdate BearWare.TeamTalkBase.OnCmdUserUpdate |
User changed properties.
Event handler for #ClientEvent.CLIENTEVENT_CMD_USER_UPDATE
Definition at line 8400 of file TeamTalk.cs.
UserUpdate BearWare.TeamTalkBase.OnCmdUserJoinedChannel |
A user has joined a channel.
Event handler for #ClientEvent.CLIENTEVENT_CMD_USER_JOINED
Definition at line 8406 of file TeamTalk.cs.
UserUpdate BearWare.TeamTalkBase.OnCmdUserLeftChannel |
User has left a channel.
Event handler for #ClientEvent.CLIENTEVENT_CMD_USER_LEFT
Definition at line 8412 of file TeamTalk.cs.
UserTextMessage BearWare.TeamTalkBase.OnCmdUserTextMessage |
A user has sent a text-message.
Event handler for #ClientEvent.CLIENTEVENT_CMD_USER_TEXTMSG
Definition at line 8425 of file TeamTalk.cs.
ChannelUpdate BearWare.TeamTalkBase.OnCmdChannelNew |
A new channel has been created.
Event handler for #ClientEvent.CLIENTEVENT_CMD_CHANNEL_NEW
Definition at line 8438 of file TeamTalk.cs.
ChannelUpdate BearWare.TeamTalkBase.OnCmdChannelUpdate |
A channel's properties has been updated.
Event handler for #ClientEvent.CLIENTEVENT_CMD_CHANNEL_UPDATE
Definition at line 8444 of file TeamTalk.cs.
ChannelUpdate BearWare.TeamTalkBase.OnCmdChannelRemove |
A channel has been removed. Event handler for #ClientEvent.CLIENTEVENT_CMD_CHANNEL_REMOVE.
Definition at line 8449 of file TeamTalk.cs.
ServerUpdate BearWare.TeamTalkBase.OnCmdServerUpdate |
Server has updated its settings (server name, MOTD, etc.)
Event handler for #ClientEvent.CLIENTEVENT_CMD_SERVER_UPDATE
Definition at line 8459 of file TeamTalk.cs.
ServerStats BearWare.TeamTalkBase.OnCmdServerStatistics |
Server statistics available.
This is a response to TeamTalkBase.DoServerStatistics()
Definition at line 8468 of file TeamTalk.cs.
FileUpdate BearWare.TeamTalkBase.OnCmdFileNew |
A new file is added to a channel.
Event handler for #ClientEvent.CLIENTEVENT_CMD_FILE_NEW
Definition at line 8477 of file TeamTalk.cs.
FileUpdate BearWare.TeamTalkBase.OnCmdFileRemove |
A file has been removed from a channel.
Event handler for #ClientEvent.CLIENTEVENT_CMD_FILE_REMOVE
Definition at line 8483 of file TeamTalk.cs.
ListUserAccount BearWare.TeamTalkBase.OnCmdUserAccount |
A new user account has been listed by the server. Event handler for #ClientEvent.CLIENTEVENT_CMD_USERACCOUNT.
Definition at line 8490 of file TeamTalk.cs.
ListBannedUser BearWare.TeamTalkBase.OnCmdBannedUser |
A new banned user has been listed by the server. Event handler for #ClientEvent.CLIENTEVENT_CMD_BANNEDUSER.
Definition at line 8497 of file TeamTalk.cs.
UserStreamUpdate BearWare.TeamTalkBase.OnUserFirstVoiceStreamPacket |
The first voice packet of a new voice stream has been received.
Event handler for #ClientEvent.CLIENTEVENT_USER_FIRSTVOICESTREAMPACKET
Definition at line 8503 of file TeamTalk.cs.
UserUpdate BearWare.TeamTalkBase.OnUserStateChange |
A user's state has been updated.
Event handler for #ClientEvent.CLIENTEVENT_USER_STATECHANGE
Definition at line 8508 of file TeamTalk.cs.
UserVideoFrame BearWare.TeamTalkBase.OnUserVideoCapture |
A new video frame was received from a user.
Event handler for #ClientEvent.CLIENTEVENT_USER_VIDEOCAPTURE
Definition at line 8517 of file TeamTalk.cs.
UserVideoFrame BearWare.TeamTalkBase.OnUserMediaFileVideo |
A new video frame was received from a user.
Event handler for #ClientEvent.CLIENTEVENT_USER_MEDIAFILE_VIDEO
Definition at line 8523 of file TeamTalk.cs.
NewDesktopWindow BearWare.TeamTalkBase.OnUserDesktopWindow |
A new or updated desktop window has been received from a user.
Event handler for #ClientEvent.CLIENTEVENT_USER_DESKTOPWINDOW
Use TeamTalkBase.AcquireUserDesktopWindow() to retrieve the bitmap of the desktop window.
Definition at line 8543 of file TeamTalk.cs.
UserDesktopInput BearWare.TeamTalkBase.OnUserDesktopCursor |
A user has sent the position of the mouse cursor.
Use TeamTalkBase.SendDesktopCursorPosition() to send the position of the mouse cursor.
Definition at line 8553 of file TeamTalk.cs.
UserDesktopInput BearWare.TeamTalkBase.OnUserDesktopInput |
Desktop input (mouse or keyboard input) has been received from a user.
Event handler for #ClientEvent.CLIENTEVENT_USER_DESKTOPINPUT
Definition at line 8560 of file TeamTalk.cs.
UserRecordMediaFile BearWare.TeamTalkBase.OnUserRecordMediaFile |
An media file recording has changed status.
Event handler for #ClientEvent.CLIENTEVENT_USER_RECORD_MEDIAFILE
Definition at line 8569 of file TeamTalk.cs.
NewAudioBlock BearWare.TeamTalkBase.OnUserAudioBlock |
A new audio block can be extracted.
Event handler for #ClientEvent.CLIENTEVENT_USER_AUDIOBLOCK
This event is only generated if TeamTalkBase.EnableAudioBlockEvent() is first called.
Call TeamTalkBase.AcquireUserAudioBlock() to extract the BearWare.AudioBlock.
Definition at line 8583 of file TeamTalk.cs.
ErrorOccured BearWare.TeamTalkBase.OnInternalError |
A internal error occured.
Event handler for #ClientEvent.CLIENTEVENT_INTERNAL_ERROR
Definition at line 8592 of file TeamTalk.cs.
VoiceActivation BearWare.TeamTalkBase.OnVoiceActivation |
Voice activation has triggered transmission.
Event handler for #ClientEvent.CLIENTEVENT_VOICE_ACTIVATION
Definition at line 8602 of file TeamTalk.cs.
HotKeyToggle BearWare.TeamTalkBase.OnHotKeyToggle |
A hotkey has been acticated or deactivated.
Event handler for #ClientEvent.CLIENTEVENT_HOTKEY
Definition at line 8619 of file TeamTalk.cs.
HotKeyTest BearWare.TeamTalkBase.OnHotKeyTest |
A button was pressed or released on the user's keyboard or mouse.
Event handler for #ClientEvent.CLIENTEVENT_HOTKEY_TEST
When HotKey_InstallTestHook is called a hook is installed in Windows which intercepts all keyboard and mouse presses. Every time a key or mouse is pressed or released this event is posted.
Use HotKey_GetKeyString to get a key description of the pressed key.
Definition at line 8643 of file TeamTalk.cs.
FileTransferUpdate BearWare.TeamTalkBase.OnFileTransfer |
A file transfer is processing.
Event handler for #ClientEvent.CLIENTEVENT_FILETRANSFER
Use TeamTalkBase.GetFileTransferInfo() to get information about the file transfer. Ensure to check if the file transfer is completed, because the file transfer instance will be removed from the client instance when the user application reads the BearWare.FileTransfer object and it has completed the transfer.
Definition at line 8661 of file TeamTalk.cs.
DesktopTransferUpdate BearWare.TeamTalkBase.OnDesktopWindowTransfer |
Used for tracking when a desktop window has been transmitted to the server.
Event handler for #ClientEvent.CLIENTEVENT_DESKTOPWINDOW_TRANSFER
When the transmission has completed the flag #ClientFlag.CLIENT_TX_DESKTOP will be cleared from the local client instance.
Definition at line 8683 of file TeamTalk.cs.
StreamMediaFile BearWare.TeamTalkBase.OnStreamMediaFile |
Media file being streamed to a channel is processing.
Event handler for #ClientEvent.CLIENTEVENT_STREAM_MEDIAFILE
Definition at line 8692 of file TeamTalk.cs.
LocalMediaFile BearWare.TeamTalkBase.OnLocalMediaFile |
Media file is being played locally.
Event handler for #ClientEvent.CLIENTEVENT_LOCAL_MEDIAFILE
Definition at line 8701 of file TeamTalk.cs.
AudioInput BearWare.TeamTalkBase.OnAudioInput |
Audio input progress as result of TeamTalkBase.InsertAudioBlock()
Event handler for #ClientEvent.CLIENTEVENT_AUDIOINPUT
Definition at line 8710 of file TeamTalk.cs.