Client Event Handling

When events occur in the client instance, like e.g. if a new user joins a channel, the client instance queues a message which the user application must retrieve. More...

Functions

delegate void BearWare::TeamTalk4.Connection ()
 Delegate for events OnConnectSuccess, OnConnectFailed and OnConnectionLost.
delegate void BearWare::TeamTalk4.ConnectionP2P (int nUserID, bool bSuccess)
 Delegate for event OnConnectionP2P.
delegate void BearWare::TeamTalk4.CommandProcessing (int nCmdID, bool bComplete)
 Delegate for event OnCmdProcessing.
delegate void BearWare::TeamTalk4.MyselfLoggedIn (int nMyUserID)
 Delegate for event OnCmdMyselfLoggedIn.
delegate void BearWare::TeamTalk4.MyselfLoggedOut ()
 Delegate for event OnCmdMyselfLoggedOut.
delegate void BearWare::TeamTalk4.MyselfJoinedChannel (int nChannelID)
 Delegate for event OnCmdMyselfJoinedChannel.
delegate void BearWare::TeamTalk4.MyselfLeftChannel (int nChannelID)
 Delegate for event OnCmdMyselfLeftChannel.
delegate void BearWare::TeamTalk4.MyselfKickedFromChannel (int nUserID)
 Delegate for event OnCmdMyselfKickedFromChannel.
delegate void BearWare::TeamTalk4.UserAuth (int nUserID)
 Delegate for events OnCmdUserLoggedIn and OnCmdUserLoggedOut.
delegate void BearWare::TeamTalk4.UserUpdate (int nUserID, int nChannelID)
 Delegate for events OnCmdUserUpdate, OnCmdUserJoinedChannel and OnCmdUserLeftChannel.
delegate void BearWare::TeamTalk4.UserTextMessage (int nUserID, int nMsgID)
 Delegate for events OnCmdUserTextMessage.
delegate void BearWare::TeamTalk4.ChannelUpdate (int nChannelID)
 Delegate for OnCmdChannelNew, OnCmdChannelUpdate and OnCmdChannelRemove.
delegate void BearWare::TeamTalk4.ServerUpdate ()
 Delegate for event OnCmdServerUpdate.
delegate void BearWare::TeamTalk4.FileUpdate (int nFileID, int nChannelID)
 A delegate for events OnCmdFileNew and OnCmdFileRemove.
delegate void BearWare::TeamTalk4.CommandError (ClientError nErrorNo, int nCmdID)
 Delegate for event OnCmdError.
delegate void BearWare::TeamTalk4.CommandSuccess (int nCmdID)
 Delegate for event CommandSuccess.
delegate void BearWare::TeamTalk4.UserTalking (int nUserID, bool bTalking)
 Delegate for event OnUserTalking.
delegate void BearWare::TeamTalk4.UserVideoFrame (int nUserID, int nFrameQueueSize)
 A delegate for the event OnUserVideoFrame.
delegate void BearWare::TeamTalk4.UserAudioFile (int nUserID, AudioFileStatus nStatus)
 Delegate for event OnUserAudioFile.
delegate void BearWare::TeamTalk4.ErrorOccured (ClientError nErrorNo)
 Delegate for event OnInternalError.
delegate void BearWare::TeamTalk4.VoiceActivation (bool bVoiceActive)
 Delegate for event OnVoiceActivation.
delegate void BearWare::TeamTalk4.StreamUserAudioFile (int nUserID, AudioFileStatus nStatus)
 Delegate for event OnStreamAudioFileUser.
delegate void BearWare::TeamTalk4.StreamChannelAudioFile (int nChannelID, AudioFileStatus nStatus)
 Delegate for event OnStreamAudioFileChannel.
delegate void BearWare::TeamTalk4.HotKeyToggle (int nHotKeyID, bool bActive)
 Delegate for event OnHotKeyToggle.
delegate void BearWare::TeamTalk4.HotKeyTest (int nVkCode, bool bActive)
 Delegate for event OnHotKeyTest.
delegate void BearWare::TeamTalk4.FileTransferUpdate (int nTransferID, FileTransferStatus nStatus)
 Delegate for event OnFileTransfer.
delegate void BearWare::TeamTalk4.NewAudioBlock (int nUserID)
 Delegate for event OnUserAudioBlock.
delegate void BearWare::TeamTalk4.NewDesktopWindow (int nUserID, int nSessionID)
 Delegate for event OnUserDesktopWindow.
delegate void BearWare::TeamTalk4.DesktopTransferUpdate (int nSessionID, int nTransferRemaining)
 Delegate for event OnDesktopWindowTransfer().
delegate void BearWare::TeamTalk4.UserDesktopCursorPosition (int nSrcUserID, int nDestUserID)
 Delegate for event OnUserDesktopCursorPosition().
delegate void BearWare::TeamTalk4.MaxPayloadUpdate (int nUserID, int nMaxPayload)
 Delegate for event OnMaxPayloadUpdate().

Events

Connection BearWare::TeamTalk4.OnConnectSuccess
 Connected successfully to the server.
Connection BearWare::TeamTalk4.OnConnectFailed
 Failed to connect to server.
Connection BearWare::TeamTalk4.OnConnectionLost
 Connection to server has been lost.
ConnectionP2P BearWare::TeamTalk4.OnConnectionP2P
 Peer to peer (p2p) status changed.
CommandProcessing BearWare::TeamTalk4.OnCmdProcessing
 A command issued by Do* methods is being processed.
MyselfLoggedIn BearWare::TeamTalk4.OnCmdMyselfLoggedIn
 The client instance successfully logged on to server.
MyselfLoggedOut BearWare::TeamTalk4.OnCmdMyselfLoggedOut
 The client instance logged out of a server.
MyselfJoinedChannel BearWare::TeamTalk4.OnCmdMyselfJoinedChannel
 The client instance has joined a new channel.
MyselfLeftChannel BearWare::TeamTalk4.OnCmdMyselfLeftChannel
 The client instance left a channel.
MyselfKickedFromChannel BearWare::TeamTalk4.OnCmdMyselfKickedFromChannel
 The client instance was kicked from a channel.
UserAuth BearWare::TeamTalk4.OnCmdUserLoggedIn
 A new user logged on to the server.
UserAuth BearWare::TeamTalk4.OnCmdUserLoggedOut
 A client logged out of the server.
UserUpdate BearWare::TeamTalk4.OnCmdUserUpdate
 User changed properties.
UserUpdate BearWare::TeamTalk4.OnCmdUserJoinedChannel
 A user has joined a channel.
UserUpdate BearWare::TeamTalk4.OnCmdUserLeftChannel
 User has left a channel.
UserTextMessage BearWare::TeamTalk4.OnCmdUserTextMessage
 A user has sent a text-message.
ChannelUpdate BearWare::TeamTalk4.OnCmdChannelNew
 A new channel has been created.
ChannelUpdate BearWare::TeamTalk4.OnCmdChannelUpdate
 A channel's properties has been updated.
ChannelUpdate BearWare::TeamTalk4.OnCmdChannelRemove
 A channel has been removed.
ServerUpdate BearWare::TeamTalk4.OnCmdServerUpdate
 Server has updated its settings (server name, MOTD, etc.).
FileUpdate BearWare::TeamTalk4.OnCmdFileNew
 A new file is added to a channel.
FileUpdate BearWare::TeamTalk4.OnCmdFileRemove
 A file has been removed from a channel.
CommandError BearWare::TeamTalk4.OnCmdError
 The server rejected a command issued by the local client instance.
CommandSuccess BearWare::TeamTalk4.OnCmdSuccess
 The server successfully processed a command issued by the local client instance.
UserTalking BearWare::TeamTalk4.OnUserTalking
 A user is talking.
UserVideoFrame BearWare::TeamTalk4.OnUserVideoFrame
 A new video frame was received from a user.
UserAudioFile BearWare::TeamTalk4.OnUserAudioFile
 An audio file recording has changed status.
ErrorOccured BearWare::TeamTalk4.OnInternalError
 A sound device failed to initialize.
VoiceActivation BearWare::TeamTalk4.OnVoiceActivation
 Voice activation has triggered transmission.
StreamUserAudioFile BearWare::TeamTalk4.OnStreamAudioFileUser
 An audio file being streamed to a user is processing.
StreamChannelAudioFile BearWare::TeamTalk4.OnStreamAudioFileChannel
 Audio file being stream to a channel is processing.
HotKeyToggle BearWare::TeamTalk4.OnHotKeyToggle
 A hotkey has been acticated or deactivated.
HotKeyTest BearWare::TeamTalk4.OnHotKeyTest
 A button was pressed or released on the user's keyboard or mouse.
FileTransferUpdate BearWare::TeamTalk4.OnFileTransfer
 A file transfer is processing.
NewAudioBlock BearWare::TeamTalk4.OnUserAudioBlock
 A new audio block can be extracted.
NewDesktopWindow BearWare::TeamTalk4.OnUserDesktopWindow
 A new or updated desktop window has been received from a user.
DesktopTransferUpdate BearWare::TeamTalk4.OnDesktopTransferUpdate
 Used for tracking when a desktop window has been transmitted to the server.
UserDesktopCursorPosition BearWare::TeamTalk4.OnUserDesktopCursorPosition
 A user has sent the position of the mouse cursor.
MaxPayloadUpdate BearWare::TeamTalk4.OnMaxPayloadUpdate
 The maximum size of the payload put into UDP packets has been updated.

Detailed Description

When events occur in the client instance, like e.g. if a new user joins a channel, the client instance queues a message which the user application must retrieve.

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 text-message cannot be retrieved 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.


Function Documentation

delegate void BearWare.TeamTalk4.Connection (  )  [inherited]
delegate void BearWare.TeamTalk4.ConnectionP2P ( int  nUserID,
bool  bSuccess 
) [inherited]

Delegate for event OnConnectionP2P.

Parameters:
nUserID User ID
bSuccess TRUE if P2P connection was successful, FALSE if P2P connection failed.
delegate void BearWare.TeamTalk4.CommandProcessing ( int  nCmdID,
bool  bComplete 
) [inherited]

Delegate for event OnCmdProcessing.

Parameters:
nCmdID Command ID being processed (returned by Do* commands)
bComplete Is 0 if command ID started processing and 1 if the command has finished processing.
delegate void BearWare.TeamTalk4.MyselfLoggedIn ( int  nMyUserID  )  [inherited]

Delegate for event OnCmdMyselfLoggedIn.

Parameters:
nMyUserID The client instance's user ID, i.e. what can now be retrieved through GetMyUserID.
delegate void BearWare.TeamTalk4.MyselfLoggedOut (  )  [inherited]

Delegate for event OnCmdMyselfLoggedOut.

delegate void BearWare.TeamTalk4.MyselfJoinedChannel ( int  nChannelID  )  [inherited]

Delegate for event OnCmdMyselfJoinedChannel.

Parameters:
nChannelID Channel's ID
delegate void BearWare.TeamTalk4.MyselfLeftChannel ( int  nChannelID  )  [inherited]

Delegate for event OnCmdMyselfLeftChannel.

Parameters:
nChannelID Channel's ID
delegate void BearWare.TeamTalk4.MyselfKickedFromChannel ( int  nUserID  )  [inherited]

Delegate for event OnCmdMyselfKickedFromChannel.

Parameters:
nUserID User ID of the kicker.
delegate void BearWare.TeamTalk4.UserAuth ( int  nUserID  )  [inherited]

Delegate for events OnCmdUserLoggedIn and OnCmdUserLoggedOut.

Parameters:
nUserID The user's ID.
delegate void BearWare.TeamTalk4.UserUpdate ( int  nUserID,
int  nChannelID 
) [inherited]

Delegate for events OnCmdUserUpdate, OnCmdUserJoinedChannel and OnCmdUserLeftChannel.

Parameters:
nUserID User's ID
nChannelID Channel ID. 0 for no channel.
See also:
GetUser To retrieve user.
delegate void BearWare.TeamTalk4.UserTextMessage ( int  nUserID,
int  nMsgID 
) [inherited]

Delegate for events OnCmdUserTextMessage.

Parameters:
nUserID The user's user ID.
nMsgID The message's ID.
See also:
GetTextMessage To retrieve message.
GetUser To retrieve user.
DoTextMessage() To send a text message.
delegate void BearWare.TeamTalk4.ChannelUpdate ( int  nChannelID  )  [inherited]

Delegate for OnCmdChannelNew, OnCmdChannelUpdate and OnCmdChannelRemove.

Parameters:
nChannelID Channel's ID.
See also:
GetChannel To retrieve channel.
delegate void BearWare.TeamTalk4.ServerUpdate (  )  [inherited]

Delegate for event OnCmdServerUpdate.

See also:
GetServerProperties To retrieve new Server Properties properties.
delegate void BearWare.TeamTalk4.FileUpdate ( int  nFileID,
int  nChannelID 
) [inherited]

A delegate for events OnCmdFileNew and OnCmdFileRemove.

Parameters:
nFileID File ID.
nChannelID Channel ID.
See also:
GetChannelFileInfo To retrieve file.
delegate void BearWare.TeamTalk4.CommandError ( ClientError  nErrorNo,
int  nCmdID 
) [inherited]

Delegate for event OnCmdError.

Parameters:
nErrorNo Error number
nCmdID The command ID returned from the Do* commands.
delegate void BearWare.TeamTalk4.CommandSuccess ( int  nCmdID  )  [inherited]

Delegate for event CommandSuccess.

Parameters:
nCmdID The command ID returned from the Do* commands.
delegate void BearWare.TeamTalk4.UserTalking ( int  nUserID,
bool  bTalking 
) [inherited]

Delegate for event OnUserTalking.

Parameters:
nUserID User's ID.
bTalking TRUE if talking otherwise FALSE.
See also:
IsTransmitting To see if "myself" is transmitting.
delegate void BearWare.TeamTalk4.UserVideoFrame ( int  nUserID,
int  nFrameQueueSize 
) [inherited]

A delegate for the event OnUserVideoFrame.

Parameters:
nUserID User's ID.
nFrameQueueSize Number of video frames currently in queue for display. The client uses a cyclic buffer for video frame in order to prevent resources from being drained. Therefore the OnUserVideoFrame event might be posted more times than there actually are frames available. So use the frame count to ensure the lastest frame is always displayed.
See also:
GetUserVideoFrame To retrieve video frame.
delegate void BearWare.TeamTalk4.UserAudioFile ( int  nUserID,
AudioFileStatus  nStatus 
) [inherited]

Delegate for event OnUserAudioFile.

Parameters:
nUserID The user's ID.
nStatus The status of the audio file.
delegate void BearWare.TeamTalk4.ErrorOccured ( ClientError  nErrorNo  )  [inherited]

Delegate for event OnInternalError.

Parameters:
nErrorNo An error number based on ClientError. The value will be of the type ClientError INTERR_*.
delegate void BearWare.TeamTalk4.VoiceActivation ( bool  bVoiceActive  )  [inherited]

Delegate for event OnVoiceActivation.

Parameters:
bVoiceActive TRUE if enabled, FALSE if disabled.
delegate void BearWare.TeamTalk4.StreamUserAudioFile ( int  nUserID,
AudioFileStatus  nStatus 
) [inherited]

Delegate for event OnStreamAudioFileUser.

Parameters:
nUserID User's ID of where the audio file is streamed to.
nStatus The status of the audio file.
delegate void BearWare.TeamTalk4.StreamChannelAudioFile ( int  nChannelID,
AudioFileStatus  nStatus 
) [inherited]

Delegate for event OnStreamAudioFileChannel.

Parameters:
nChannelID Channel's ID of where the audio file is being streamed to.
nStatus The status of the audio file.
delegate void BearWare.TeamTalk4.HotKeyToggle ( int  nHotKeyID,
bool  bActive 
) [inherited]

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.
delegate void BearWare.TeamTalk4.HotKeyTest ( int  nVkCode,
bool  bActive 
) [inherited]

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.
delegate void BearWare.TeamTalk4.FileTransferUpdate ( int  nTransferID,
FileTransferStatus  nStatus 
) [inherited]

Delegate for event OnFileTransfer.

Parameters:
nTransferID Transfer ID
nStatus The BearWare.FileTransfer's status.
delegate void BearWare.TeamTalk4.NewAudioBlock ( int  nUserID  )  [inherited]

Delegate for event OnUserAudioBlock.

Parameters:
nUserID The user ID of the user who has an BearWare.AudioBlock.
delegate void BearWare.TeamTalk4.NewDesktopWindow ( int  nUserID,
int  nSessionID 
) [inherited]

Delegate for event OnUserDesktopWindow.

Parameters:
nUserID The user's ID.
nSessionID 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:
TeamTalk4.SendDesktopWindow()
delegate void BearWare.TeamTalk4.DesktopTransferUpdate ( int  nSessionID,
int  nTransferRemaining 
) [inherited]

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.
nTransferRemaining The number of bytes remaining before transmission of last desktop window completes. When remaining bytes is 0 TeamTalk4.SendDesktopWindow() can be called again.
delegate void BearWare.TeamTalk4.UserDesktopCursorPosition ( int  nSrcUserID,
int  nDestUserID 
) [inherited]

Delegate for event OnUserDesktopCursorPosition().

Parameters:
nSrcUserID The user ID of the owner of the mouse cursor.
nDestUserID The owner of the desktop session the mouse cursor is pointing to.
delegate void BearWare.TeamTalk4.MaxPayloadUpdate ( int  nUserID,
int  nMaxPayload 
) [inherited]

Delegate for event OnMaxPayloadUpdate().

Parameters:
nUserID The user's ID. 0 means server's maximum payload size.
nMaxPayload The maximum size in bytes of the payload data which is put in UDP packets. 0 means the max payload query failed.
See also:
TeamTalk4.QueryMaxPayload()

Events

Connection BearWare.TeamTalk4.OnConnectSuccess [inherited]

Connected successfully to the server.

This event is posted if Connect was successful.

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

See also:
Connection Delegate for this event.
Connect
DoLogin
Connection BearWare.TeamTalk4.OnConnectFailed [inherited]

Failed to connect to server.

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

See also:
Connection Delegate for this event.
Connect
Connection BearWare.TeamTalk4.OnConnectionLost [inherited]

Connection to server has been lost.

The server is not responding to requests from the local client instance and the connection has been dropped. To change when the client instance should regard the server as unavailable call SetServerTimeout.

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

Ensure to call Disconnect before calling Connect again.

See also:
Connection Delegate for this event.
Connect
ConnectionP2P BearWare.TeamTalk4.OnConnectionP2P [inherited]

Peer to peer (p2p) status changed.

Audio and video packets can be sent to the user without forwarding through the server. This is done by enabling P2P network using EnablePeerToPeer. Once the client instance joins a new channel it will try and create a peer to peer connection to each user in the channel. The client instance will try to create a peer to peer connection for 5 seconds.

Read section Forward Through Server Transmission Mode and section Peer to Peer Transmission Mode on the different ways of transmitting data.

See also:
ConnectionP2P Delegate for this event.
UserRight.USERRIGHT_FORWARD_AUDIO
UserRight.USERRIGHT_FORWARD_VIDEO
CommandProcessing BearWare.TeamTalk4.OnCmdProcessing [inherited]

A command issued by Do* methods is being processed.

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

See also:
CommandProcessing Delegate for this event.
MyselfLoggedIn BearWare.TeamTalk4.OnCmdMyselfLoggedIn [inherited]

The client instance successfully logged on to server.

The call to DoLogin was successful and all channels on the server will be posted in the event OnCmdChannelNew immediately following this event. If UserRight.USERRIGHT_VIEW_ALL_USERS is enabled the client instance will also receive the events OnCmdUserLoggedIn and OnCmdUserJoinedChannel for every user on the server.

See also:
MyselfLoggedIn Delegate for this event.
DoLogin
MyselfLoggedOut BearWare.TeamTalk4.OnCmdMyselfLoggedOut [inherited]

The client instance logged out of a server.

A response to DoLogout.

See also:
MyselfLoggedOut Delegate for this event.
DoLogout
MyselfJoinedChannel BearWare.TeamTalk4.OnCmdMyselfJoinedChannel [inherited]

The client instance has joined a new channel.

Result of command DoJoinChannel or DoJoinChannelByID. Can also be a result of an administrator calling DoMoveUser.

If UserRight.USERRIGHT_VIEW_ALL_USERS is disabled the client instance will afterwards receive the OnCmdUserJoinedChannel event for each of the users in the channel.

See also:
MyselfJoinedChannel Delegate for this event.
OnCmdMyselfLeftChannel
MyselfLeftChannel BearWare.TeamTalk4.OnCmdMyselfLeftChannel [inherited]

The client instance left a channel.

See also:
MyselfLeftChannel Delegate for this event.
OnCmdMyselfJoinedChannel
DoLeaveChannel
MyselfKickedFromChannel BearWare.TeamTalk4.OnCmdMyselfKickedFromChannel [inherited]

The client instance was kicked from a channel.

See also:
MyselfKickedFromChannel Delegate for this event.
UserAuth BearWare.TeamTalk4.OnCmdUserLoggedIn [inherited]

A new user logged on to the server.

Use GetUser to get the properties of the user.

See also:
UserAuth Delegate for this event.
DoLogin
GetUser To retrieve user.
OnCmdUserLoggedOut
UserAuth BearWare.TeamTalk4.OnCmdUserLoggedOut [inherited]

A client logged out of the server.

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

See also:
UserAuth Delegate for this event.
DoLogout
Disconnect
OnCmdUserLoggedIn
UserUpdate BearWare.TeamTalk4.OnCmdUserUpdate [inherited]

User changed properties.

See also:
UserUpdate Delegate for this event.
UserUpdate BearWare.TeamTalk4.OnCmdUserJoinedChannel [inherited]

A user has joined a channel.

See also:
UserUpdate Delegate for this event.
UserUpdate BearWare.TeamTalk4.OnCmdUserLeftChannel [inherited]

User has left a channel.

See also:
UserUpdate Delegate for this event.
UserTextMessage BearWare.TeamTalk4.OnCmdUserTextMessage [inherited]

A user has sent a text-message.

See also:
UserTextMessage Delegate for this event.
ChannelUpdate BearWare.TeamTalk4.OnCmdChannelNew [inherited]

A new channel has been created.

See also:
ChannelUpdate Delegate for this event.
ChannelUpdate BearWare.TeamTalk4.OnCmdChannelUpdate [inherited]

A channel's properties has been updated.

See also:
ChannelUpdate Delegate for this event.
ChannelUpdate BearWare.TeamTalk4.OnCmdChannelRemove [inherited]

A channel has been removed.

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

See also:
ChannelUpdate Delegate for this event.
ServerUpdate BearWare.TeamTalk4.OnCmdServerUpdate [inherited]

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

Use GetServerProperties to get the new server properties.

See also:
ServerUpdate Delegate for this event.
FileUpdate BearWare.TeamTalk4.OnCmdFileNew [inherited]

A new file is added to a channel.

Use GetChannelFileInfo to get information about the file.

See also:
FileUpdate Delegate for this event.
FileUpdate BearWare.TeamTalk4.OnCmdFileRemove [inherited]

A file has been removed from a channel.

See also:
FileUpdate Delegate for this event.
CommandError BearWare.TeamTalk4.OnCmdError [inherited]

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

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

See also:
CommandError Delegate for this event.
GetErrorMessage
CommandSuccess BearWare.TeamTalk4.OnCmdSuccess [inherited]

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 Do* command. Section Client/Server Command Processing explains how to use command ID.

See also:
CommandError Delegate for this event.
UserTalking BearWare.TeamTalk4.OnUserTalking [inherited]

A user is talking.

Playback using the sound output device has started for a user.

See also:
SetUserStoppedTalkingDelay()
UserTalking Delegate for this event.
UserVideoFrame BearWare.TeamTalk4.OnUserVideoFrame [inherited]

A new video frame was received from a user.

Use GetUserVideoFrame to display the image.

See also:
UserVideoFrame Delegate for this event.
UserAudioFile BearWare.TeamTalk4.OnUserAudioFile [inherited]

An audio file recording has changed status.

SetUserAudioFolder() 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.

See also:
UserAudioFile Delegate for this event.
ErrorOccured BearWare.TeamTalk4.OnInternalError [inherited]

A sound device failed to initialize.

This can e.g. happen if a new user joins a channel and there is no sound output channels available. nMaxOutputChannels of BearWare.SoundDevice struct tells how many streams can be active simultaneously.

See also:
ErrorOccured Delegate for this event.
OnCmdMyselfJoinedChannel If sound input device fails it will be when joining a new channel.
GetSoundOutputDevices
SoundDevice
VoiceActivation BearWare.TeamTalk4.OnVoiceActivation [inherited]

Voice activation has triggered transmission.

See also:
VoiceActivation Delegate for this event.
SetVoiceActivationLevel
ClientFlag.CLIENT_SNDINPUT_VOICEACTIVATION
EnableTransmission
StreamUserAudioFile BearWare.TeamTalk4.OnStreamAudioFileUser [inherited]

An audio file being streamed to a user is processing.

This event is called as a result of StartStreamingAudioFileToUser.

See also:
StreamUserAudioFile Delegate for this event.
StreamChannelAudioFile BearWare.TeamTalk4.OnStreamAudioFileChannel [inherited]

Audio file being stream to a channel is processing.

This event is called as a result of StartStreamingAudioFileToChannel.

See also:
StreamChannelAudioFile Delegate for this event.
StartStreamingAudioFileToChannel
HotKeyToggle BearWare.TeamTalk4.OnHotKeyToggle [inherited]

A hotkey has been acticated or deactivated.

See also:
HotKeyToggle Delegate for this event.
HotKey_Register
HotKey_Unregister
HotKeyTest BearWare.TeamTalk4.OnHotKeyTest [inherited]

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

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
FileTransferUpdate BearWare.TeamTalk4.OnFileTransfer [inherited]

A file transfer is processing.

Use 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.

See also:
FileTransferUpdate Delegate for this event.
GetFileTransferInfo To retrieve BearWare.FileTransfer.
NewAudioBlock BearWare.TeamTalk4.OnUserAudioBlock [inherited]

A new audio block can be extracted.

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

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

NewDesktopWindow BearWare.TeamTalk4.OnUserDesktopWindow [inherited]

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

Use TeamTalk4.GetUserDesktopWindow() to retrieve the bitmap of the desktop window.

DesktopTransferUpdate BearWare.TeamTalk4.OnDesktopTransferUpdate [inherited]

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

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

UserDesktopCursorPosition BearWare.TeamTalk4.OnUserDesktopCursorPosition [inherited]

A user has sent the position of the mouse cursor.

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

MaxPayloadUpdate BearWare.TeamTalk4.OnMaxPayloadUpdate [inherited]

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

See also:
TeamTalk4.QueryMaxPayload()
Generated on Sun Mar 18 17:16:14 2012 for TeamTalk 4 .NET DLL by  doxygen 1.6.3