TeamTalk 5 Java DLL: Client Event Handling

TeamTalk 5 Java DLL Version 5.18A

Loading...
Searching...
No Matches
Classes | Enumerations | Functions | Events
Client Event Handling

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 {
BearWare.ClientEvent.CLIENTEVENT_NONE = 0 , BearWare.ClientEvent.CLIENTEVENT_CON_SUCCESS = CLIENTEVENT_NONE + 10 , BearWare.ClientEvent.CLIENTEVENT_CON_FAILED = CLIENTEVENT_NONE + 20 , BearWare.ClientEvent.CLIENTEVENT_CON_LOST = CLIENTEVENT_NONE + 30 ,
BearWare.ClientEvent.CLIENTEVENT_CON_MAX_PAYLOAD_UPDATED = CLIENTEVENT_NONE + 40 , BearWare.ClientEvent.CLIENTEVENT_CMD_PROCESSING = CLIENTEVENT_NONE + 200 , BearWare.ClientEvent.CLIENTEVENT_CMD_ERROR = CLIENTEVENT_NONE + 210 , BearWare.ClientEvent.CLIENTEVENT_CMD_SUCCESS = CLIENTEVENT_NONE + 220 ,
BearWare.ClientEvent.CLIENTEVENT_CMD_MYSELF_LOGGEDIN = CLIENTEVENT_NONE + 230 , BearWare.ClientEvent.CLIENTEVENT_CMD_MYSELF_LOGGEDOUT = CLIENTEVENT_NONE + 240 , BearWare.ClientEvent.CLIENTEVENT_CMD_MYSELF_KICKED = CLIENTEVENT_NONE + 250 , BearWare.ClientEvent.CLIENTEVENT_CMD_USER_LOGGEDIN = CLIENTEVENT_NONE + 260 ,
BearWare.ClientEvent.CLIENTEVENT_CMD_USER_LOGGEDOUT = CLIENTEVENT_NONE + 270 , BearWare.ClientEvent.CLIENTEVENT_CMD_USER_UPDATE = CLIENTEVENT_NONE + 280 , BearWare.ClientEvent.CLIENTEVENT_CMD_USER_JOINED = CLIENTEVENT_NONE + 290 , BearWare.ClientEvent.CLIENTEVENT_CMD_USER_LEFT = CLIENTEVENT_NONE + 300 ,
BearWare.ClientEvent.CLIENTEVENT_CMD_USER_TEXTMSG = CLIENTEVENT_NONE + 310 , BearWare.ClientEvent.CLIENTEVENT_CMD_CHANNEL_NEW = CLIENTEVENT_NONE + 320 , BearWare.ClientEvent.CLIENTEVENT_CMD_CHANNEL_UPDATE = CLIENTEVENT_NONE + 330 , BearWare.ClientEvent.CLIENTEVENT_CMD_CHANNEL_REMOVE = CLIENTEVENT_NONE + 340 ,
BearWare.ClientEvent.CLIENTEVENT_CMD_SERVER_UPDATE = CLIENTEVENT_NONE + 350 , BearWare.ClientEvent.CLIENTEVENT_CMD_SERVERSTATISTICS = CLIENTEVENT_NONE + 360 , BearWare.ClientEvent.CLIENTEVENT_CMD_FILE_NEW = CLIENTEVENT_NONE + 370 , BearWare.ClientEvent.CLIENTEVENT_CMD_FILE_REMOVE = CLIENTEVENT_NONE + 380 ,
BearWare.ClientEvent.CLIENTEVENT_CMD_USERACCOUNT = CLIENTEVENT_NONE + 390 , BearWare.ClientEvent.CLIENTEVENT_CMD_BANNEDUSER = CLIENTEVENT_NONE + 400 , BearWare.ClientEvent.CLIENTEVENT_USER_STATECHANGE = CLIENTEVENT_NONE + 500 , BearWare.ClientEvent.CLIENTEVENT_USER_VIDEOCAPTURE = CLIENTEVENT_NONE + 510 ,
BearWare.ClientEvent.CLIENTEVENT_USER_MEDIAFILE_VIDEO = CLIENTEVENT_NONE + 520 , BearWare.ClientEvent.CLIENTEVENT_USER_DESKTOPWINDOW = CLIENTEVENT_NONE + 530 , BearWare.ClientEvent.CLIENTEVENT_USER_DESKTOPCURSOR = CLIENTEVENT_NONE + 540 , BearWare.ClientEvent.CLIENTEVENT_USER_DESKTOPINPUT = CLIENTEVENT_NONE + 550 ,
BearWare.ClientEvent.CLIENTEVENT_USER_RECORD_MEDIAFILE = CLIENTEVENT_NONE + 560 , BearWare.ClientEvent.CLIENTEVENT_USER_AUDIOBLOCK = CLIENTEVENT_NONE + 570 , BearWare.ClientEvent.CLIENTEVENT_INTERNAL_ERROR = CLIENTEVENT_NONE + 1000 , BearWare.ClientEvent.CLIENTEVENT_VOICE_ACTIVATION = CLIENTEVENT_NONE + 1010 ,
BearWare.ClientEvent.CLIENTEVENT_HOTKEY = CLIENTEVENT_NONE + 1020 , BearWare.ClientEvent.CLIENTEVENT_HOTKEY_TEST = CLIENTEVENT_NONE + 1030 , BearWare.ClientEvent.CLIENTEVENT_FILETRANSFER = CLIENTEVENT_NONE + 1040 , BearWare.ClientEvent.CLIENTEVENT_DESKTOPWINDOW_TRANSFER = CLIENTEVENT_NONE + 1050 ,
BearWare.ClientEvent.CLIENTEVENT_STREAM_MEDIAFILE = CLIENTEVENT_NONE + 1060 , BearWare.ClientEvent.CLIENTEVENT_LOCAL_MEDIAFILE = CLIENTEVENT_NONE + 1070 , BearWare.ClientEvent.CLIENTEVENT_AUDIOINPUT = CLIENTEVENT_NONE + 1080 , BearWare.ClientEvent.CLIENTEVENT_USER_FIRSTVOICESTREAMPACKET = CLIENTEVENT_NONE + 1090
}

| TeamTalk client event messages. More...

enum

BearWare.TTType : uint {
BearWare.TTType.__NONE = 0 , BearWare.TTType.__AUDIOCODEC = 1 , BearWare.TTType.__BANNEDUSER = 2 , BearWare.TTType.__VIDEOFORMAT = 3 ,
BearWare.TTType.__OPUSCODEC = 4 , BearWare.TTType.__CHANNEL = 5 , BearWare.TTType.__CLIENTSTATISTICS = 6 , BearWare.TTType.__REMOTEFILE = 7 ,
BearWare.TTType.__FILETRANSFER = 8 , BearWare.TTType.__MEDIAFILESTATUS = 9 , BearWare.TTType.__SERVERPROPERTIES = 10 , BearWare.TTType.__SERVERSTATISTICS = 11 ,
BearWare.TTType.__SOUNDDEVICE = 12 , BearWare.TTType.__SPEEXCODEC = 13 , BearWare.TTType.__TEXTMESSAGE = 14 , BearWare.TTType.__WEBMVP8CODEC = 15 ,
BearWare.TTType.__TTMESSAGE = 16 , BearWare.TTType.__USER = 17 , BearWare.TTType.__USERACCOUNT = 18 , BearWare.TTType.__USERSTATISTICS = 19 ,
BearWare.TTType.__VIDEOCAPTUREDEVICE = 20 , BearWare.TTType.__VIDEOCODEC = 21 , BearWare.TTType.__AUDIOCONFIG = 22 , BearWare.TTType.__SPEEXVBRCODEC = 23 ,
BearWare.TTType.__VIDEOFRAME = 24 , BearWare.TTType.__AUDIOBLOCK = 25 , BearWare.TTType.__AUDIOFORMAT = 26 , BearWare.TTType.__MEDIAFILEINFO = 27 ,
BearWare.TTType.__CLIENTERRORMSG = 28 , BearWare.TTType.__TTBOOL = 29 , BearWare.TTType.__INT32 = 30 , BearWare.TTType.__DESKTOPINPUT = 31 ,
BearWare.TTType.__SPEEXDSP = 32 , BearWare.TTType.__STREAMTYPE = 33 , BearWare.TTType.__AUDIOPREPROCESSORTYPE = 34 , BearWare.TTType.__AUDIOPREPROCESSOR = 35 ,
BearWare.TTType.__TTAUDIOPREPROCESSOR = 36 , BearWare.TTType.__MEDIAFILEPLAYBACK = 37 , BearWare.TTType.__CLIENTKEEPALIVE = 38 , BearWare.TTType.__UINT32 = 39 ,
BearWare.TTType.__AUDIOINPUTPROGRESS = 40 , BearWare.TTType.__JITTERCONFIG = 41 , BearWare.TTType.__WEBRTCAUDIOPREPROCESSOR = 42 , BearWare.TTType.__ENCRYPTIONCONTEXT = 43 ,
BearWare.TTType.__SOUNDDEVICEEFFECTS = 44 , BearWare.TTType.__DESKTOPWINDOW = 45 , BearWare.TTType.__ABUSEPREVENTION = 46
}

## Functions

delegate void | BearWare.TeamTalkBase.Connection ()
| Delegate for events #OnConnectionSuccess, #OnConnectionFailed and #OnConnectionLost.
delegate void | BearWare.TeamTalkBase.MaxPayloadUpdate (int nPayloadSize)
| Delegate for event OnConnectionMaxPayloadUpdated().
delegate void | BearWare.TeamTalkBase.CommandProcessing (int nCmdID, bool bActive)
| Delegate for event #OnCmdProcessing.
delegate void | BearWare.TeamTalkBase.CommandError (int nCmdID, ClientErrorMsg clienterrormsg)
| Delegate for event #OnCmdError.
delegate void | BearWare.TeamTalkBase.CommandSuccess (int nCmdID)
| Delegate for event #CommandSuccess.
delegate void | BearWare.TeamTalkBase.MyselfLoggedIn (int nMyUserID, UserAccount useraccount)
| Delegate for event #OnCmdMyselfLoggedIn.
delegate void | BearWare.TeamTalkBase.MyselfLoggedOut ()
| Delegate for event #OnCmdMyselfLoggedOut.
delegate void | BearWare.TeamTalkBase.MyselfKicked (User user)
| Delegate for event #OnCmdMyselfKicked.
delegate void | BearWare.TeamTalkBase.UserUpdate (User user)
| Delegate for events #OnCmdUserLoggedIn, #OnCmdUserLoggedOut, #OnCmdUserUpdate, #OnCmdUserJoinedChannel and #OnCmdUserLeftChannel.
delegate void | BearWare.TeamTalkBase.UserStreamUpdate (User user, int nStreamID)
| Delegate for events #OnUserFirstVoiceStreamPacket.
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.
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.
delegate void | BearWare.TeamTalkBase.HotKeyToggle (int nHotKeyID, bool bActive)
| Delegate for event #OnHotKeyToggle.
delegate void | BearWare.TeamTalkBase.HotKeyTest (int nVkCode, bool bActive)
| Delegate for event #OnHotKeyTest.
delegate void | BearWare.TeamTalkBase.FileTransferUpdate (FileTransfer filetransfer)
| Delegate for event #OnFileTransfer.
delegate void | BearWare.TeamTalkBase.DesktopTransferUpdate (int nSessionID, int nBytesRemain)
| Delegate for event OnDesktopWindowTransfer().
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.

## Events

Connection | BearWare.TeamTalkBase.OnConnectionSuccess
| Connected successfully to the server.
Connection | BearWare.TeamTalkBase.OnConnectionFailed
| Failed to connect to server.
Connection | BearWare.TeamTalkBase.OnConnectionLost
| Connection to server has been lost.
MaxPayloadUpdate | BearWare.TeamTalkBase.OnConnectionMaxPayloadUpdated
| The maximum size of the payload put into UDP packets has been updated.
CommandProcessing | BearWare.TeamTalkBase.OnCmdProcessing
| A command issued by `Do*` methods is being processed.
CommandError | BearWare.TeamTalkBase.OnCmdError
| The server rejected a command issued by the local client instance.
CommandSuccess | BearWare.TeamTalkBase.OnCmdSuccess
| The server successfully processed a command issued by the local client instance.
MyselfLoggedIn | BearWare.TeamTalkBase.OnCmdMyselfLoggedIn
| The client instance successfully logged on to server.
MyselfLoggedOut | BearWare.TeamTalkBase.OnCmdMyselfLoggedOut
| The client instance logged out of a server.
MyselfKicked | BearWare.TeamTalkBase.OnCmdMyselfKicked
| The client instance was kicked from a channel.
UserUpdate | BearWare.TeamTalkBase.OnCmdUserLoggedIn
| A new user logged on to the server.
UserUpdate | BearWare.TeamTalkBase.OnCmdUserLoggedOut
| A user logged out of the server.
UserUpdate | BearWare.TeamTalkBase.OnCmdUserUpdate
| User changed properties.
UserUpdate | BearWare.TeamTalkBase.OnCmdUserJoinedChannel
| A user has joined a channel.
UserUpdate | BearWare.TeamTalkBase.OnCmdUserLeftChannel
| User has left a channel.
UserTextMessage | BearWare.TeamTalkBase.OnCmdUserTextMessage
| A user has sent a text-message.
ChannelUpdate | BearWare.TeamTalkBase.OnCmdChannelNew
| A new channel has been created.
ChannelUpdate | BearWare.TeamTalkBase.OnCmdChannelUpdate
| A channel's properties has been updated.
ChannelUpdate | BearWare.TeamTalkBase.OnCmdChannelRemove
| A channel has been removed. Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_CHANNEL_REMOVE.
ServerUpdate | BearWare.TeamTalkBase.OnCmdServerUpdate
| Server has updated its settings (server name, MOTD, etc.)
ServerStats | BearWare.TeamTalkBase.OnCmdServerStatistics
| Server statistics available.
FileUpdate | BearWare.TeamTalkBase.OnCmdFileNew
| A new file is added to a channel.
FileUpdate | BearWare.TeamTalkBase.OnCmdFileRemove
| A file has been removed from a channel.
ListUserAccount | BearWare.TeamTalkBase.OnCmdUserAccount
| A new user account has been listed by the server. Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_USERACCOUNT.
ListBannedUser | BearWare.TeamTalkBase.OnCmdBannedUser
| A new banned user has been listed by the server. Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_BANNEDUSER.
UserStreamUpdate | BearWare.TeamTalkBase.OnUserFirstVoiceStreamPacket
| The first voice packet of a new voice stream has been received.
UserUpdate | BearWare.TeamTalkBase.OnUserStateChange
| A user's state has been updated.
UserVideoFrame | BearWare.TeamTalkBase.OnUserVideoCapture
| A new video frame was received from a user.
UserVideoFrame | BearWare.TeamTalkBase.OnUserMediaFileVideo
| A new video frame was received from a user.
NewDesktopWindow | BearWare.TeamTalkBase.OnUserDesktopWindow
| A new or updated desktop window has been received from a user.
UserDesktopInput | BearWare.TeamTalkBase.OnUserDesktopCursor
| A user has sent the position of the mouse cursor.
UserDesktopInput | BearWare.TeamTalkBase.OnUserDesktopInput
| Desktop input (mouse or keyboard input) has been received from a user.
UserRecordMediaFile | BearWare.TeamTalkBase.OnUserRecordMediaFile
| An media file recording has changed status.
NewAudioBlock | BearWare.TeamTalkBase.OnUserAudioBlock
| A new audio block can be extracted.
ErrorOccured | BearWare.TeamTalkBase.OnInternalError
| A internal error occured.
VoiceActivation | BearWare.TeamTalkBase.OnVoiceActivation
| Voice activation has triggered transmission.
HotKeyToggle | BearWare.TeamTalkBase.OnHotKeyToggle
| A hotkey has been acticated or deactivated.
HotKeyTest | BearWare.TeamTalkBase.OnHotKeyTest
| A button was pressed or released on the user's keyboard or mouse.
FileTransferUpdate | BearWare.TeamTalkBase.OnFileTransfer
| A file transfer is processing.
DesktopTransferUpdate | BearWare.TeamTalkBase.OnDesktopWindowTransfer
| Used for tracking when a desktop window has been transmitted to the server.
StreamMediaFile | BearWare.TeamTalkBase.OnStreamMediaFile
| Media file being streamed to a channel is processing.
LocalMediaFile | BearWare.TeamTalkBase.OnLocalMediaFile
| Media file is being played locally.
AudioInput | BearWare.TeamTalkBase.OnAudioInput
| Audio input progress as result of TeamTalkBase.InsertAudioBlock()

## Detailed Description

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.

## Enumeration Type Documentation

## ◆ ClientEvent

enum BearWare.ClientEvent : uint

TeamTalk client event messages.

Events are retrieved using TeamTalkBase.GetMessage().

Enumerator
CLIENTEVENT_NONE |

CLIENTEVENT_CON_SUCCESS

Connected successfully to the server.

This event is posted if TeamTalkBase.Connect() was successful.

TeamTalkBase.DoLogin() can now be called in order to logon to the server.

Parameters

  nSource | 0
  ttType | BearWare.TTType.__NONE

See also
  TeamTalkBase.Connect

CLIENTEVENT_CON_FAILED

Failed to connect to server.

This event is posted if TeamTalkBase.Connect() fails. Ensure to call TeamTalkBase.Disconnect() before calling TeamTalkBase.Connect() again.

Parameters

  nSource | 0
  ttType | BearWare.TTType.__NONE

See also
  TeamTalkBase.Connect

CLIENTEVENT_CON_LOST

Connection to server has been lost.

The server is not responding to requests from the local client instance and the connection has been dropped.

TeamTalkBase.GetClientStatistics() can be used to check when data was last received from the server.

Ensure to call TeamTalkBase.Disconnect() before calling TeamTalkBase.Connect() again.

Parameters

  nSource | 0
  ttType | BearWare.TTType.__NONE

See also
  TeamTalkBase.Connect

CLIENTEVENT_CON_MAX_PAYLOAD_UPDATED

The maximum size of the payload put into UDP packets has been updated.

Parameters

  nSource | Ignored
  ttType | TTType.__INT32
  nPayloadSize | Placed in union of BearWare.TTMessage. The maximum size in bytes of the payload data which is put in UDP packets. 0 means the max payload query failed.

See also
  TeamTalkBase.QueryMaxPayload()

CLIENTEVENT_CMD_PROCESSING

A command issued by `TeamTalkBase.Do*` methods is being processed.

Read section Client/Server Command Processing on how to use command processing in the user application.

Parameters

  nSource | Command ID being processed (returned by TeamTalkBase.Do* commands)
  ttType | TTType.__TTBOOL
  bActive | Placed in union of BearWare.TTMessage. Is TRUE if command ID started processing and FALSE if the command has finished processing.

CLIENTEVENT_CMD_ERROR

The server rejected a command issued by the local client instance.

To figure out which command failed use the command ID returned by the TeamTalkBase.Do* command. Section Client/Server Command Processing explains how to use command ID.

Parameters

  nSource | The command ID returned from the TeamTalkBase.Do* commands.
  ttType | TTType.__CLIENTERRORMSG
  clienterrormsg | Placed in union of BearWare.TTMessage. Contains error description.

CLIENTEVENT_CMD_SUCCESS

The server successfully processed a command issued by the local client instance.

To figure out which command succeeded use the command ID returned by the TeamTalkBase.Do* command. Section Client/Server Command Processing explains how to use command ID.

Parameters

  nSource | The command ID returned from the TeamTalkBase.Do* commands.
  ttType | TTType.__NONE

CLIENTEVENT_CMD_MYSELF_LOGGEDIN

The client instance successfully logged on to server.

The call to TeamTalkBase.DoLogin() was successful and all channels on the server will be posted in the event BearWare.ClientEvent.CLIENTEVENT_CMD_CHANNEL_NEW immediately following this event. If BearWare.UserRight.USERRIGHT_VIEW_ALL_USERS is enabled the client instance will also receive the events BearWare.ClientEvent.CLIENTEVENT_CMD_USER_LOGGEDIN and BearWare.ClientEvent.CLIENTEVENT_CMD_USER_JOINED for every user on the server.

Parameters

  nSource | The client instance's user ID, i.e. what can now be retrieved through TeamTalkBase.GetMyUserID().
  ttType | TTType.__USERACCOUNT
  useraccount | Placed in union of BearWare.TTMessage.

See also
  TeamTalkBase.DoLogin

CLIENTEVENT_CMD_MYSELF_LOGGEDOUT

The client instance logged out of the server.

A response to TeamTalkBase.DoLogout().

Parameters

  nSource | User ID of local client instance.
  ttType | TTType.__NONE

See also
  TeamTalkBase.DoLogout

CLIENTEVENT_CMD_MYSELF_KICKED

The client instance was kicked from a channel.

Parameters

  nSource | If greater than zero indicates local client instance was kicked from a channel. Otherwise kicked from server.
  ttType | TTType.__USER if kicked by a user otherwise TTType.__NONE.
  user | Placed in union of BearWare.TTMessage if ttType equals TTType.__USER otherwise TTType.__NONE.

CLIENTEVENT_CMD_USER_LOGGEDIN

A new user logged on to the server.

Parameters

  nSource | 0
  ttType | TTType.__USER
  user | Placed in union of BearWare.TTMessage.

See also
  TeamTalkBase.DoLogin
  TeamTalkBase.GetUser To retrieve user.
  CLIENTEVENT_CMD_USER_LOGGEDOUT

CLIENTEVENT_CMD_USER_LOGGEDOUT

A client logged out of the server.

This event is called when a user logs out with TeamTalkBase.DoLogout() or disconnects with TeamTalkBase.Disconnect().

Parameters

  nSource | 0
  ttType | TTType.__USER
  user | Placed in union of BearWare.TTMessage.

See also
  TeamTalkBase.DoLogout
  TeamTalkBase.Disconnect
  CLIENTEVENT_CMD_USER_LOGGEDIN

CLIENTEVENT_CMD_USER_UPDATE

User changed properties.

Parameters

  nSource | 0
  ttType | TTType.__USER
  user | Placed in union of BearWare.TTMessage.

See also
  TeamTalkBase.GetUser To retrieve user.

CLIENTEVENT_CMD_USER_JOINED

A user has joined a channel.

Parameters

  nSource | 0
  ttType | TTType.__USER
  user | Placed in union of BearWare.TTMessage.

See also
  TeamTalkBase.GetUser To retrieve user.

CLIENTEVENT_CMD_USER_LEFT

User has left a channel.

Parameters

  nSource | Channel ID of previous channel.
  ttType | TTType.__USER
  user | Placed in union of BearWare.TTMessage.

CLIENTEVENT_CMD_USER_TEXTMSG

A user has sent a text-message.

Parameters

  nSource | 0
  ttType | TTType.__TEXTMESSAGE
  textmessage | Placed in union of BearWare.TTMessage.

See also
  TeamTalkBase.GetUser() To retrieve user.
  TeamTalkBase.DoTextMessage() to send text message.

CLIENTEVENT_CMD_CHANNEL_NEW

A new channel has been created.

Parameters

  nSource | 0
  ttType | TTType.__CHANNEL
  channel | Placed in union of BearWare.TTMessage.

See also
  TeamTalkBase.GetChannel To retrieve channel.

CLIENTEVENT_CMD_CHANNEL_UPDATE

A channel's properties has been updated.

Parameters

  nSource | 0
  ttType | TTType.__CHANNEL
  channel | Placed in union of BearWare.TTMessage.

See also
  TeamTalkBase.GetChannel To retrieve channel.

CLIENTEVENT_CMD_CHANNEL_REMOVE

A channel has been removed.

Note that calling the TeamTalkBase.GetChannel() with the channel ID will fail because the channel is no longer there.

Parameters

  nSource | 0
  ttType | TTType.__CHANNEL
  channel | Placed in union of BearWare.TTMessage.

CLIENTEVENT_CMD_SERVER_UPDATE

Server has updated its settings (server name, MOTD, etc.)

Use TeamTalkBase.GetServerProperties() to get the new server properties.

Parameters

  nSource | 0
  ttType | TTType.__SERVERPROPERTIES
  serverproperties | Placed in union of BearWare.TTMessage.

CLIENTEVENT_CMD_SERVERSTATISTICS

Server statistics available.

This is a response to TeamTalkBase.DoServerStatistics()

Parameters

  nSource | 0
  ttType | TTType.__SERVERSTATISTICS
  serverstatistics | Placed in union of BearWare.TTMessage.

CLIENTEVENT_CMD_FILE_NEW

A new file is added to a channel.

Use TeamTalkBase.GetChannelFile() to get information about the file.

Parameters

  nSource | Channel ID where file is located.
  ttType | TTType.__REMOTEFILE
  remotefile | Placed in union of BearWare.TTMessage.

See also
  TeamTalkBase.GetChannelFile To retrieve file.

CLIENTEVENT_CMD_FILE_REMOVE

A file has been removed from a channel.

Parameters

  nSource | Channel ID where file was located.
  ttType | TTType.__REMOTEFILE
  remotefile | Placed in union of BearWare.TTMessage.

CLIENTEVENT_CMD_USERACCOUNT

A user account has been received from the server.

This message is posted as a result of TeamTalkBase.DoListUserAccounts()

Parameters

  nSource | 0
  ttType | TTType.__USERACCOUNT
  useraccount | Placed in union of BearWare.TTMessage.

CLIENTEVENT_CMD_BANNEDUSER

A banned user has been received from the server.

This message is posted as a result of TeamTalkBase.DoListBans()

Parameters

  nSource | 0
  ttType | TTType.__BANNEDUSER
  useraccount | Placed in union of BearWare.TTMessage.

CLIENTEVENT_USER_STATECHANGE

A user state has changed.

The uUserState has changed for a user due to playback of an incoming stream.

The user state changes if:

- A user has started/stopped voice stream, i.e. BearWare.UserState.USERSTATE_VOICE
- A user has started/stopped a video capture stream, i.e. BearWare.UserState.USERSTATE_VIDEOCAPTURE
- A user has started/stopped a media file stream, i.e. i.e. BearWare.UserState.USERSTATE_MEDIAFILE_AUDIO or BearWare.UserState.USERSTATE_MEDIAFILE_VIDEO

Parameters

  nSource | 0
  ttType | TTType.__USER.
  user | Placed in union of BearWare.TTMessage.

See also
  TeamTalkBase.SetUserStoppedTalkingDelay()

CLIENTEVENT_USER_VIDEOCAPTURE

A new video frame from a video capture device was received from a user.

Use TeamTalkBase.AcquireUserVideoCaptureFrame() to display the video frame.

Parameters

  nSource | User's ID.
  ttType | TTType.__INT32
  nStreamID | Placed in union of BearWare.TTMessage. The ID of the video stream currently active for this user. If stream ID becomes 0 it means the current stream has been closed.

CLIENTEVENT_USER_MEDIAFILE_VIDEO

A new video frame from a video media file was received from a user.

Use TeamTalkBase.AcquireUserMediaVideoFrame() to display the video frame.

Parameters

  nSource | User's ID.
  ttType | TTType.__INT32
  nStreamID | Placed in union of BearWare.TTMessage. The ID of the video stream currently active for this user. If stream ID becomes 0 it means the current stream has been closed.

CLIENTEVENT_USER_DESKTOPWINDOW

A new or updated desktop window has been received from a user.

Use TeamTalkBase.AcquireUserDesktopWindow() to retrieve the bitmap of the desktop window.

Parameters

  nSource | The user's ID.
  ttType | TTType.__INT32
  nStreamID | Placed in union of BearWare.TTMessage. 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.

See also
  TeamTalkBase.SendDesktopWindow()

CLIENTEVENT_USER_DESKTOPCURSOR

A user has sent the position of the mouse cursor.

Use TeamTalkBase.SendDesktopCursorPosition() to send the position of the mouse cursor.

Parameters

  nSource | The user ID of the owner of the mouse cursor.
  ttType | TTType.__DESKTOPINPUT
  desktopinput | Placed in union of BearWare.TTMessage. Contains the coordinates of the mouse cursor.

CLIENTEVENT_USER_DESKTOPINPUT

Desktop input (mouse or keyboard input) has been received from a user.

Desktop input is used in combination with a shared desktop window, see Desktop Sharing.

This event is generated if a remote user has called TeamTalkBase.SendDesktopInput(). In order for the local client instance to receive desktop input it must have enabled the subscription BearWare.Subscription.SUBSCRIBE_DESKTOPINPUT.

Due to different keyboard layout it might be a good idea to look into the key-translation function WindowsHelper.DesktopInputKeyTranslate().

See Receive Desktop Input for more information on receiving desktop input.

Parameters

  nSource | User ID
  ttType | TTType.__DESKTOPINPUT
  desktopinput | Placed in union of BearWare.TTMessage.

CLIENTEVENT_USER_RECORD_MEDIAFILE

A media file recording has changed status.

TeamTalkBase.SetUserMediaStorageDir() makes the client instance store all audio from a user to a specified folder. Every time an audio file is being processed this event is posted.

Parameters

  nSource | The user's ID.
  ttType | TTType.__MEDIAFILEINFO
  mediafileinfo | Placed in union of BearWare.TTMessage. Properties for the media file currently being recorded

CLIENTEVENT_USER_AUDIOBLOCK

A new audio block can be extracted.

The BearWare.AudioBlock can either be of BearWare.StreamType.STREAMTYPE_VOICE or BearWare.StreamType.STREAMTYPE_MEDIAFILE_AUDIO.

This event is only generated if TeamTalkBase.EnableAudioBlockEvent() is first called.

Call TeamTalkBase.AcquireUserAudioBlock() to extract the BearWare.AudioBlock.

Parameters

  nSource | The user ID.

See also
  TeamTalkBase.TT_LOCAL_USERID
  TeamTalkBase.TT_MUXED_USERID

Parameters

  ttType | TTType.__STREAMTYPE

CLIENTEVENT_INTERNAL_ERROR

An internal error occurred in the client instance.

This can e.g. happen if a new user joins a channel and a sound output device fails to start a new audio stream.

For at list of internal error messages check out BearWare.ClientError with errors prefixed `INTERR_*`

Parameters

  nSource | 0
  ttType | TTType.__CLIENTERRORMSG
  clienterrormsg | Placed in union of BearWare.TTMessage. Contains information on what caused an error.

CLIENTEVENT_VOICE_ACTIVATION

Voice activation has triggered transmission.

Parameters

  nSource | 0
  ttType | TTType.__TTBOOL
  bActive | Placed in union of BearWare.TTMessage. TRUE if voice is being transmitted due to voice level high than activation level.

See also
  TeamTalkBase.GetSoundInputLevel()
  TeamTalkBase.SetVoiceActivationLevel()
  CLIENT_SNDINPUT_VOICEACTIVATED
  TeamTalkBase.EnableVoiceActivation()

CLIENTEVENT_HOTKEY

A hotkey has been acticated or deactivated.

Parameters

  nSource | The hotkey ID passed to TeamTalkBase.HotKey_Register().
  ttType | TTType.__TTBOOL
  bActive | Placed in union of BearWare.TTMessage. TRUE when hotkey is active and FALSE when it becomes inactive.

See also
  TeamTalkBase.HotKey_Register()
  TeamTalkBase.HotKey_Unregister()

CLIENTEVENT_HOTKEY_TEST

A button was pressed or released on the user's keyboard or mouse.

When TeamTalkBase.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 TeamTalkBase.HotKey_GetKeyString() to get a key description of the pressed key.

Parameters

  nSource | The virtual key code. Look here for a list of virtual key codes: http://msdn.microsoft.com/en-us/library/ms645540(VS.85).aspx
  ttType | TTType.__TTBOOL
  bActive | Placed in union of BearWare.TTMessage. TRUE when key is down and FALSE when released.

See also
  TeamTalkBase.HotKey_InstallTestHook()

CLIENTEVENT_FILETRANSFER

A file transfer is processing.

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.

Parameters

  nSource | 0
  ttType | TTType.__FILETRANSFER
  filetransfer | Placed in union of BearWare.TTMessage. Properties and status information about the file transfer.

See also
  TeamTalkBase.GetFileTransferInfo To retrieve BearWare.FileTransfer.

CLIENTEVENT_DESKTOPWINDOW_TRANSFER

Used for tracking when a desktop window has been transmitted to the server.

When the transmission has completed the flag BearWare.ClientFlag.CLIENT_TX_DESKTOP will be cleared from the local client instance.

Parameters

  nSource | The desktop session's ID. If the desktop session ID becomes 0 it means the desktop session has been closed and/or cancelled.
  ttType | TTType.__INT32
  nBytesRemain | Placed in union of BearWare.TTMessage. The number of bytes remaining before transmission of last desktop window completes. When remaining bytes is 0 TeamTalkBase.SendDesktopWindow() can be called again.

CLIENTEVENT_STREAM_MEDIAFILE

Media file being streamed to a channel is processing.

This event is called as a result of TeamTalkBase.StartStreamingMediaFileToChannel() to monitor progress of streaming.

Parameters

  nSource | 0
  ttType | TTType.__MEDIAFILEINFO
  mediafileinfo | Placed in union of BearWare.TTMessage. Contains properties and status information about the media file being streamed.

CLIENTEVENT_LOCAL_MEDIAFILE

Media file played locally is procesing.

This event is called as a result of TeamTalkBase.InitLocalPlayback() to monitor progress of playback.

Parameters

  nSource | Session ID returned by TeamTalkBase.InitLocalPlayback()
  ttType | TTType.__MEDIAFILEINFO
  mediafileinfo | Placed in union of BearWare.TTMessage. Contains properties and status information about the media file being played.

CLIENTEVENT_AUDIOINPUT

Progress is audio being injected as BearWare.StreamType.STREAMTYPE_VOICE.

`nStreamID` of BearWare.AudioInputProgress is the stream ID provided in the BearWare.AudioBlock when calling TeamTalkBase.InsertAudioBlock().

When `uElapsedMSec` and `uQueueMSec` of BearWare.AudioInputProgress are zero then the stream ID (session) has ended. An audio input session has ended when an empty BearWare.AudioBlock has been inserted using TeamTalkBase.InsertAudioBlock().

Parameters

  nSource | Stream ID used for sending audio input. The stream ID will appear in BearWare.AudioBlock's `nStreamID` on the receiving side.
  ttType | TTType.__AUDIOINPUTPROGRESS
  audioinputprogress | Placed in union of BearWare.TTMessage. Tells how much audio remains in queue. The queue should be refilled as long as the audio input should remain active.

CLIENTEVENT_USER_FIRSTVOICESTREAMPACKET

The first voice packet of a new voice stream has been received.

This time of this event may differ significantly from the start of the voice playout that is notified via TeamTalkBase.OnUserStateChange() due to jitter buffering.

The time between TeamTalkBase.OnUserFirstVoiceStreamPacket() and TeamTalkBase.OnUserStateChange() is the fixed jitter delay configuration plus the currently active adaptive jitter buffering in the `nActiveAdaptiveDelayMSec` member of the BearWare.User-struct

Parameters

  nSource | Stream ID. This can be mapped to BearWare.AudioBlock.
  ttType | TTType.__USER.
  user | Placed in union of BearWare.TTMessage.

See also
  TeamTalkBase.SetUserJitterControl

Definition at line 3343 of file TeamTalk.cs.

## ◆ TTType

enum BearWare.TTType : uint

Enumerator
__NONE |
__AUDIOCODEC |
__BANNEDUSER |
__VIDEOFORMAT |
__OPUSCODEC |
__CHANNEL |
__CLIENTSTATISTICS |
__REMOTEFILE |
__FILETRANSFER |
__MEDIAFILESTATUS |
__SERVERPROPERTIES |
__SERVERSTATISTICS |
__SOUNDDEVICE |
__SPEEXCODEC |
__TEXTMESSAGE |
__WEBMVP8CODEC |
__TTMESSAGE |
__USER |
__USERACCOUNT |
__USERSTATISTICS |
__VIDEOCAPTUREDEVICE |
__VIDEOCODEC |
__AUDIOCONFIG |
__SPEEXVBRCODEC |
__VIDEOFRAME |
__AUDIOBLOCK |
__AUDIOFORMAT |
__MEDIAFILEINFO |
__CLIENTERRORMSG |
__TTBOOL |
__INT32 |
__DESKTOPINPUT |
__SPEEXDSP |
__STREAMTYPE |
__AUDIOPREPROCESSORTYPE |
__AUDIOPREPROCESSOR |
__TTAUDIOPREPROCESSOR |
__MEDIAFILEPLAYBACK |
__CLIENTKEEPALIVE |
__UINT32 |
__AUDIOINPUTPROGRESS |
__JITTERCONFIG |
__WEBRTCAUDIOPREPROCESSOR |
__ENCRYPTIONCONTEXT |
__SOUNDDEVICEEFFECTS |
__DESKTOPWINDOW |
__ABUSEPREVENTION |

Definition at line 3901 of file TeamTalk.cs.

## Function Documentation

## ◆ Connection()

delegate void BearWare.TeamTalkBase.Connection | ( |  | ) |

Delegate for events #OnConnectionSuccess, #OnConnectionFailed and #OnConnectionLost.

## ◆ MaxPayloadUpdate()

delegate void BearWare.TeamTalkBase.MaxPayloadUpdate | ( | int | nPayloadSize | ) |

Delegate for event OnConnectionMaxPayloadUpdated().

Parameters

  nPayloadSize | The maximum size in bytes of the payload data which is put in UDP packets. 0 means the max payload query failed.

See also
  TeamTalkBase.QueryMaxPayload()

## ◆ CommandProcessing()

delegate void BearWare.TeamTalkBase.CommandProcessing | ( | int | nCmdID,
|  | bool | bActive )

Delegate for event #OnCmdProcessing.

Parameters

  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.

## ◆ CommandError()

delegate void BearWare.TeamTalkBase.CommandError | ( | int | nCmdID,
|  | ClientErrorMsg | clienterrormsg )

Delegate for event #OnCmdError.

Parameters

  nCmdID | The command ID returned from the `Do*` commands.
  clienterrormsg | Contains error description.

## ◆ CommandSuccess()

delegate void BearWare.TeamTalkBase.CommandSuccess | ( | int | nCmdID | ) |

Delegate for event #CommandSuccess.

Parameters

  nCmdID | The command ID returned from the `Do*` commands.

## ◆ MyselfLoggedIn()

delegate void BearWare.TeamTalkBase.MyselfLoggedIn | ( | int | nMyUserID,
|  | UserAccount | useraccount )

Delegate for event #OnCmdMyselfLoggedIn.

Parameters

  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.

## ◆ MyselfLoggedOut()

delegate void BearWare.TeamTalkBase.MyselfLoggedOut | ( |  | ) |

Delegate for event #OnCmdMyselfLoggedOut.

## ◆ MyselfKicked()

delegate void BearWare.TeamTalkBase.MyselfKicked | ( | User | user | ) |

Delegate for event #OnCmdMyselfKicked.

Parameters

  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.

## ◆ UserUpdate()

delegate void BearWare.TeamTalkBase.UserUpdate | ( | User | user | ) |

Delegate for events #OnCmdUserLoggedIn, #OnCmdUserLoggedOut, #OnCmdUserUpdate, #OnCmdUserJoinedChannel and #OnCmdUserLeftChannel.

Parameters

  user | The user.

## ◆ UserStreamUpdate()

delegate void BearWare.TeamTalkBase.UserStreamUpdate | ( | User | user,
|  | int | nStreamID )

Delegate for events #OnUserFirstVoiceStreamPacket.

Parameters

  user | The user.
  nStreamID | Stream ID of the newly opened stream.

## ◆ UserTextMessage()

delegate void BearWare.TeamTalkBase.UserTextMessage | ( | TextMessage | textmessage | ) |

Delegate for events #OnCmdUserTextMessage.

See also
  GetTextMessage To retrieve message.
  GetUser To retrieve user.
  DoTextMessage() To send a text message.

## ◆ ChannelUpdate()

delegate void BearWare.TeamTalkBase.ChannelUpdate | ( | Channel | channel | ) |

Delegate for #OnCmdChannelNew, #OnCmdChannelUpdate and #OnCmdChannelRemove.

## ◆ ServerUpdate()

delegate void BearWare.TeamTalkBase.ServerUpdate | ( | ServerProperties | serverproperties | ) |

Delegate for event #OnCmdServerUpdate.

## ◆ ServerStats()

delegate void BearWare.TeamTalkBase.ServerStats | ( | ServerStatistics | serverstatistics | ) |

Delegate for event #OnCmdServerStatistics.

## ◆ FileUpdate()

delegate void BearWare.TeamTalkBase.FileUpdate | ( | RemoteFile | remotefile | ) |

A delegate for events #OnCmdFileNew and #OnCmdFileRemove.

## ◆ ListUserAccount()

delegate void BearWare.TeamTalkBase.ListUserAccount | ( | UserAccount | useraccount | ) |

A delegate for event #OnCmdUserAccount.

## ◆ ListBannedUser()

delegate void BearWare.TeamTalkBase.ListBannedUser | ( | BannedUser | banneduser | ) |

A delegate for event #OnCmdUserAccount.

## ◆ UserVideoFrame()

delegate void BearWare.TeamTalkBase.UserVideoFrame | ( | int | nUserID,
|  | int | nStreamID )

A delegate for the event #OnUserVideoCapture.

## ◆ NewDesktopWindow()

delegate void BearWare.TeamTalkBase.NewDesktopWindow | ( | int | nUserID,
|  | int | nStreamID )

Delegate for event #OnUserDesktopWindow.

Parameters

  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.

See also
  TeamTalkBase.SendDesktopWindow()

## ◆ UserDesktopInput()

delegate void BearWare.TeamTalkBase.UserDesktopInput | ( | int | nSrcUserID,
|  | DesktopInput | desktopinput )

Delegate for event OnUserDesktopCursor().

## ◆ UserRecordMediaFile()

delegate void BearWare.TeamTalkBase.UserRecordMediaFile | ( | int | nUserID,
|  | MediaFileInfo | mediafileinfo )

Delegate for event #OnUserRecordMediaFile.

## ◆ NewAudioBlock()

delegate void BearWare.TeamTalkBase.NewAudioBlock | ( | int | nUserID,
|  | StreamType | nStreamType )

Delegate for event #OnUserAudioBlock.

## ◆ ErrorOccured()

delegate void BearWare.TeamTalkBase.ErrorOccured | ( | ClientErrorMsg | clienterrormsg | ) |

Delegate for event #OnInternalError.

## ◆ VoiceActivation()

delegate void BearWare.TeamTalkBase.VoiceActivation | ( | bool | bVoiceActive | ) |

Delegate for event #OnVoiceActivation.

Parameters

  bVoiceActive | TRUE if enabled, FALSE if disabled.

## ◆ HotKeyToggle()

delegate void BearWare.TeamTalkBase.HotKeyToggle | ( | int | nHotKeyID,
|  | bool | bActive )

Delegate for event #OnHotKeyToggle.

Parameters

  nHotKeyID | The hotkey ID passed to #HotKey_Register
  bActive | TRUE when hotkey is active and FALSE when it becomes inactive.

## ◆ HotKeyTest()

delegate void BearWare.TeamTalkBase.HotKeyTest | ( | int | nVkCode,
|  | bool | bActive )

Delegate for event #OnHotKeyTest.

Parameters

  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.

## ◆ FileTransferUpdate()

delegate void BearWare.TeamTalkBase.FileTransferUpdate | ( | FileTransfer | filetransfer | ) |

Delegate for event #OnFileTransfer.

Parameters

  filetransfer | Properties and status information about the file transfer.

## ◆ DesktopTransferUpdate()

delegate void BearWare.TeamTalkBase.DesktopTransferUpdate | ( | int | nSessionID,
|  | int | nBytesRemain )

Delegate for event OnDesktopWindowTransfer().

Parameters

  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.

## ◆ StreamMediaFile()

delegate void BearWare.TeamTalkBase.StreamMediaFile | ( | MediaFileInfo | mediafileinfo | ) |

Delegate for event #OnStreamMediaFile.

## ◆ LocalMediaFile()

delegate void BearWare.TeamTalkBase.LocalMediaFile | ( | MediaFileInfo | mediafileinfo | ) |

Delegate for event #OnLocalMediaFile.

## ◆ AudioInput()

delegate void BearWare.TeamTalkBase.AudioInput | ( | AudioInputProgress | aip | ) |

Delegate for event #OnAudioInput.

## Events

## ◆ OnConnectionSuccess

Connection BearWare.TeamTalkBase.OnConnectionSuccess

Connected successfully to the server.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CON_SUCCESS

See also
  Connection Delegate for this event.
  Connect
  DoLogin

Definition at line 8240 of file TeamTalk.cs.

## ◆ OnConnectionFailed

Connection BearWare.TeamTalkBase.OnConnectionFailed

Failed to connect to server.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CON_FAILED

See also
  Connection Delegate for this event.
  Connect

Definition at line 8248 of file TeamTalk.cs.

## ◆ OnConnectionLost

Connection BearWare.TeamTalkBase.OnConnectionLost

Connection to server has been lost.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CON_LOST

See also
  Connection Delegate for this event.
  Connect

Definition at line 8256 of file TeamTalk.cs.

## ◆ OnConnectionMaxPayloadUpdated

MaxPayloadUpdate BearWare.TeamTalkBase.OnConnectionMaxPayloadUpdated

The maximum size of the payload put into UDP packets has been updated.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CON_MAX_PAYLOAD_UPDATED

See also
  TeamTalkBase.QueryMaxPayload()

Definition at line 8272 of file TeamTalk.cs.

## ◆ OnCmdProcessing

CommandProcessing BearWare.TeamTalkBase.OnCmdProcessing

A command issued by `Do*` methods is being processed.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_PROCESSING

Read section Client/Server Command Processing on how to use command processing in the user application.

See also
  CommandProcessing Delegate for this event.

Definition at line 8293 of file TeamTalk.cs.

## ◆ OnCmdError

CommandError BearWare.TeamTalkBase.OnCmdError

The server rejected a command issued by the local client instance.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_ERROR

See also
  CommandError Delegate for this event.
  GetErrorMessage

Definition at line 8309 of file TeamTalk.cs.

## ◆ OnCmdSuccess

CommandSuccess BearWare.TeamTalkBase.OnCmdSuccess

The server successfully processed a command issued by the local client instance.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_SUCCESS

See also
  CommandError Delegate for this event.

Definition at line 8323 of file TeamTalk.cs.

## ◆ OnCmdMyselfLoggedIn

MyselfLoggedIn BearWare.TeamTalkBase.OnCmdMyselfLoggedIn

The client instance successfully logged on to server.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_MYSELF_LOGGEDIN

See also
  MyselfLoggedIn Delegate for this event.
  DoLogin

Definition at line 8340 of file TeamTalk.cs.

## ◆ OnCmdMyselfLoggedOut

MyselfLoggedOut BearWare.TeamTalkBase.OnCmdMyselfLoggedOut

The client instance logged out of a server.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_MYSELF_LOGGEDOUT

See also
  MyselfLoggedOut Delegate for this event.
  DoLogout

Definition at line 8351 of file TeamTalk.cs.

## ◆ OnCmdMyselfKicked

MyselfKicked BearWare.TeamTalkBase.OnCmdMyselfKicked

The client instance was kicked from a channel.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_MYSELF_KICKED

Definition at line 8364 of file TeamTalk.cs.

## ◆ OnCmdUserLoggedIn

UserUpdate BearWare.TeamTalkBase.OnCmdUserLoggedIn

A new user logged on to the server.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_USER_LOGGEDIN

See also
  DoLogin
  OnCmdUserLoggedOut

Definition at line 8384 of file TeamTalk.cs.

## ◆ OnCmdUserLoggedOut

UserUpdate BearWare.TeamTalkBase.OnCmdUserLoggedOut

A user logged out of the server.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_USER_LOGGEDOUT

See also
  DoLogout
  Disconnect
  OnCmdUserLoggedIn

Definition at line 8394 of file TeamTalk.cs.

## ◆ OnCmdUserUpdate

UserUpdate BearWare.TeamTalkBase.OnCmdUserUpdate

User changed properties.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_USER_UPDATE

Definition at line 8400 of file TeamTalk.cs.

## ◆ OnCmdUserJoinedChannel

UserUpdate BearWare.TeamTalkBase.OnCmdUserJoinedChannel

A user has joined a channel.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_USER_JOINED

Definition at line 8406 of file TeamTalk.cs.

## ◆ OnCmdUserLeftChannel

UserUpdate BearWare.TeamTalkBase.OnCmdUserLeftChannel

User has left a channel.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_USER_LEFT

Definition at line 8412 of file TeamTalk.cs.

## ◆ OnCmdUserTextMessage

UserTextMessage BearWare.TeamTalkBase.OnCmdUserTextMessage

A user has sent a text-message.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_USER_TEXTMSG

Definition at line 8425 of file TeamTalk.cs.

## ◆ OnCmdChannelNew

ChannelUpdate BearWare.TeamTalkBase.OnCmdChannelNew

A new channel has been created.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_CHANNEL_NEW

See also
  ChannelUpdate Delegate for this event.

Definition at line 8438 of file TeamTalk.cs.

## ◆ OnCmdChannelUpdate

ChannelUpdate BearWare.TeamTalkBase.OnCmdChannelUpdate

A channel's properties has been updated.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_CHANNEL_UPDATE

Definition at line 8444 of file TeamTalk.cs.

## ◆ OnCmdChannelRemove

ChannelUpdate BearWare.TeamTalkBase.OnCmdChannelRemove

A channel has been removed. Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_CHANNEL_REMOVE.

Definition at line 8449 of file TeamTalk.cs.

## ◆ OnCmdServerUpdate

ServerUpdate BearWare.TeamTalkBase.OnCmdServerUpdate

Server has updated its settings (server name, MOTD, etc.)

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_SERVER_UPDATE

Definition at line 8459 of file TeamTalk.cs.

## ◆ OnCmdServerStatistics

ServerStats BearWare.TeamTalkBase.OnCmdServerStatistics

Server statistics available.

This is a response to TeamTalkBase.DoServerStatistics()

Definition at line 8468 of file TeamTalk.cs.

## ◆ OnCmdFileNew

FileUpdate BearWare.TeamTalkBase.OnCmdFileNew

A new file is added to a channel.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_FILE_NEW

Definition at line 8477 of file TeamTalk.cs.

## ◆ OnCmdFileRemove

FileUpdate BearWare.TeamTalkBase.OnCmdFileRemove

A file has been removed from a channel.

Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_FILE_REMOVE

Definition at line 8483 of file TeamTalk.cs.

## ◆ OnCmdUserAccount

ListUserAccount BearWare.TeamTalkBase.OnCmdUserAccount

A new user account has been listed by the server. Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_USERACCOUNT.

Definition at line 8490 of file TeamTalk.cs.

## ◆ OnCmdBannedUser

ListBannedUser BearWare.TeamTalkBase.OnCmdBannedUser

A new banned user has been listed by the server. Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_BANNEDUSER.

Definition at line 8497 of file TeamTalk.cs.

## ◆ OnUserFirstVoiceStreamPacket

UserStreamUpdate BearWare.TeamTalkBase.OnUserFirstVoiceStreamPacket

The first voice packet of a new voice stream has been received.

Event handler for BearWare.ClientEvent.CLIENTEVENT_USER_FIRSTVOICESTREAMPACKET

Definition at line 8503 of file TeamTalk.cs.

## ◆ OnUserStateChange

UserUpdate BearWare.TeamTalkBase.OnUserStateChange

A user's state has been updated.

Event handler for BearWare.ClientEvent.CLIENTEVENT_USER_STATECHANGE

Definition at line 8508 of file TeamTalk.cs.

## ◆ OnUserVideoCapture

UserVideoFrame BearWare.TeamTalkBase.OnUserVideoCapture

A new video frame was received from a user.

Event handler for BearWare.ClientEvent.CLIENTEVENT_USER_VIDEOCAPTURE

Definition at line 8517 of file TeamTalk.cs.

## ◆ OnUserMediaFileVideo

UserVideoFrame BearWare.TeamTalkBase.OnUserMediaFileVideo

A new video frame was received from a user.

Event handler for BearWare.ClientEvent.CLIENTEVENT_USER_MEDIAFILE_VIDEO

Definition at line 8523 of file TeamTalk.cs.

## ◆ OnUserDesktopWindow

NewDesktopWindow BearWare.TeamTalkBase.OnUserDesktopWindow

A new or updated desktop window has been received from a user.

Event handler for BearWare.ClientEvent.CLIENTEVENT_USER_DESKTOPWINDOW

Use TeamTalkBase.AcquireUserDesktopWindow() to retrieve the bitmap of the desktop window.

Definition at line 8543 of file TeamTalk.cs.

## ◆ OnUserDesktopCursor

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.

## ◆ OnUserDesktopInput

UserDesktopInput BearWare.TeamTalkBase.OnUserDesktopInput

Desktop input (mouse or keyboard input) has been received from a user.

Event handler for BearWare.ClientEvent.CLIENTEVENT_USER_DESKTOPINPUT

Definition at line 8560 of file TeamTalk.cs.

## ◆ OnUserRecordMediaFile

UserRecordMediaFile BearWare.TeamTalkBase.OnUserRecordMediaFile

An media file recording has changed status.

Event handler for BearWare.ClientEvent.CLIENTEVENT_USER_RECORD_MEDIAFILE

Definition at line 8569 of file TeamTalk.cs.

## ◆ OnUserAudioBlock

NewAudioBlock BearWare.TeamTalkBase.OnUserAudioBlock

A new audio block can be extracted.

Event handler for BearWare.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.

## ◆ OnInternalError

ErrorOccured BearWare.TeamTalkBase.OnInternalError

A internal error occured.

Event handler for BearWare.ClientEvent.CLIENTEVENT_INTERNAL_ERROR

Definition at line 8592 of file TeamTalk.cs.

## ◆ OnVoiceActivation

VoiceActivation BearWare.TeamTalkBase.OnVoiceActivation

Voice activation has triggered transmission.

Event handler for BearWare.ClientEvent.CLIENTEVENT_VOICE_ACTIVATION

Definition at line 8602 of file TeamTalk.cs.

## ◆ OnHotKeyToggle

HotKeyToggle BearWare.TeamTalkBase.OnHotKeyToggle

A hotkey has been acticated or deactivated.

Event handler for BearWare.ClientEvent.CLIENTEVENT_HOTKEY

See also
  HotKeyToggle Delegate for this event.
  HotKey_Register
  HotKey_Unregister

Definition at line 8619 of file TeamTalk.cs.

## ◆ OnHotKeyTest

HotKeyTest BearWare.TeamTalkBase.OnHotKeyTest

A button was pressed or released on the user's keyboard or mouse.

Event handler for BearWare.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.

See also
  HotKeyTest Delegate for this event.
  HotKey_InstallTestHook

Definition at line 8643 of file TeamTalk.cs.

## ◆ OnFileTransfer

FileTransferUpdate BearWare.TeamTalkBase.OnFileTransfer

A file transfer is processing.

Event handler for BearWare.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.

## ◆ OnDesktopWindowTransfer

DesktopTransferUpdate BearWare.TeamTalkBase.OnDesktopWindowTransfer

Used for tracking when a desktop window has been transmitted to the server.

Event handler for BearWare.ClientEvent.CLIENTEVENT_DESKTOPWINDOW_TRANSFER

When the transmission has completed the flag BearWare.ClientFlag.CLIENT_TX_DESKTOP will be cleared from the local client instance.

Definition at line 8683 of file TeamTalk.cs.

## ◆ OnStreamMediaFile

StreamMediaFile BearWare.TeamTalkBase.OnStreamMediaFile

Media file being streamed to a channel is processing.

Event handler for BearWare.ClientEvent.CLIENTEVENT_STREAM_MEDIAFILE

Definition at line 8692 of file TeamTalk.cs.

## ◆ OnLocalMediaFile

LocalMediaFile BearWare.TeamTalkBase.OnLocalMediaFile

Media file is being played locally.

Event handler for BearWare.ClientEvent.CLIENTEVENT_LOCAL_MEDIAFILE

Definition at line 8701 of file TeamTalk.cs.

## ◆ OnAudioInput

AudioInput BearWare.TeamTalkBase.OnAudioInput

Audio input progress as result of TeamTalkBase.InsertAudioBlock()

Event handler for BearWare.ClientEvent.CLIENTEVENT_AUDIOINPUT

Definition at line 8710 of file TeamTalk.cs.