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

Events

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

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 ( )
delegate void BearWare.TeamTalk4.ConnectionP2P ( int  nUserID,
bool  bSuccess 
)

Delegate for event OnConnectionP2P.

Parameters
nUserIDUser ID
bSuccessTRUE if P2P connection was successful, FALSE if P2P connection failed.
delegate void BearWare.TeamTalk4.CommandProcessing ( int  nCmdID,
bool  bComplete 
)

Delegate for event OnCmdProcessing.

Parameters
nCmdIDCommand ID being processed (returned by Do* commands)
bCompleteIs 0 if command ID started processing and 1 if the command has finished processing.
delegate void BearWare.TeamTalk4.MyselfLoggedIn ( int  nMyUserID)

Delegate for event OnCmdMyselfLoggedIn.

Parameters
nMyUserIDThe client instance's user ID, i.e. what can now be retrieved through GetMyUserID.
delegate void BearWare.TeamTalk4.MyselfLoggedOut ( )

Delegate for event OnCmdMyselfLoggedOut.

delegate void BearWare.TeamTalk4.MyselfJoinedChannel ( int  nChannelID)

Delegate for event OnCmdMyselfJoinedChannel.

Parameters
nChannelIDChannel's ID
delegate void BearWare.TeamTalk4.MyselfLeftChannel ( int  nChannelID)

Delegate for event OnCmdMyselfLeftChannel.

Parameters
nChannelIDChannel's ID
delegate void BearWare.TeamTalk4.MyselfKickedFromChannel ( int  nUserID)

Delegate for event OnCmdMyselfKickedFromChannel.

Parameters
nUserIDUser ID of the kicker.
delegate void BearWare.TeamTalk4.UserAuth ( int  nUserID)

Delegate for events OnCmdUserLoggedIn and OnCmdUserLoggedOut.

Parameters
nUserIDThe user's ID.
delegate void BearWare.TeamTalk4.UserUpdate ( int  nUserID,
int  nChannelID 
)

Delegate for events OnCmdUserUpdate, OnCmdUserJoinedChannel and OnCmdUserLeftChannel.

Parameters
nUserIDUser's ID
nChannelIDChannel ID. 0 for no channel.
See Also
GetUser To retrieve user.
delegate void BearWare.TeamTalk4.UserTextMessage ( int  nUserID,
int  nMsgID 
)

Delegate for events OnCmdUserTextMessage.

Parameters
nUserIDThe user's user ID.
nMsgIDThe 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)

Delegate for OnCmdChannelNew, OnCmdChannelUpdate and OnCmdChannelRemove.

Parameters
nChannelIDChannel's ID.
See Also
GetChannel To retrieve channel.
delegate void BearWare.TeamTalk4.ServerUpdate ( )

Delegate for event OnCmdServerUpdate.

See Also
GetServerProperties To retrieve new Server Properties properties.
delegate void BearWare.TeamTalk4.FileUpdate ( int  nFileID,
int  nChannelID 
)

A delegate for events OnCmdFileNew and OnCmdFileRemove.

Parameters
nFileIDFile ID.
nChannelIDChannel ID.
See Also
GetChannelFileInfo To retrieve file.
delegate void BearWare.TeamTalk4.CommandError ( ClientError  nErrorNo,
int  nCmdID 
)

Delegate for event OnCmdError.

Parameters
nErrorNoError number
nCmdIDThe command ID returned from the Do* commands.
delegate void BearWare.TeamTalk4.CommandSuccess ( int  nCmdID)

Delegate for event CommandSuccess.

Parameters
nCmdIDThe command ID returned from the Do* commands.
delegate void BearWare.TeamTalk4.UserTalking ( int  nUserID,
bool  bTalking 
)

Delegate for event OnUserTalking.

Parameters
nUserIDUser's ID.
bTalkingTRUE if talking otherwise FALSE.
See Also
IsTransmitting To see if "myself" is transmitting.
delegate void BearWare.TeamTalk4.UserVideoFrame ( int  nUserID,
int  nFrameQueueSize 
)

A delegate for the event OnUserVideoFrame.

Parameters
nUserIDUser's ID.
nFrameQueueSizeNumber 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 
)

Delegate for event OnUserAudioFile.

Parameters
nUserIDThe user's ID.
nStatusThe status of the audio file.
delegate void BearWare.TeamTalk4.ErrorOccured ( ClientError  nErrorNo)

Delegate for event OnInternalError.

Parameters
nErrorNoAn error number based on ClientError. The value will be of the type ClientError INTERR_*.
delegate void BearWare.TeamTalk4.VoiceActivation ( bool  bVoiceActive)

Delegate for event OnVoiceActivation.

Parameters
bVoiceActiveTRUE if enabled, FALSE if disabled.
delegate void BearWare.TeamTalk4.StreamUserAudioFile ( int  nUserID,
AudioFileStatus  nStatus 
)

Delegate for event OnStreamAudioFileUser.

Parameters
nUserIDUser's ID of where the audio file is streamed to.
nStatusThe status of the audio file.
delegate void BearWare.TeamTalk4.StreamChannelAudioFile ( int  nChannelID,
AudioFileStatus  nStatus 
)

Delegate for event OnStreamAudioFileChannel.

Parameters
nChannelIDChannel's ID of where the audio file is being streamed to.
nStatusThe status of the audio file.
delegate void BearWare.TeamTalk4.HotKeyToggle ( int  nHotKeyID,
bool  bActive 
)

Delegate for event OnHotKeyToggle.

Parameters
nHotKeyIDThe hotkey ID passed to HotKey_Register
bActiveTRUE when hotkey is active and FALSE when it becomes inactive.
delegate void BearWare.TeamTalk4.HotKeyTest ( int  nVkCode,
bool  bActive 
)

Delegate for event OnHotKeyTest.

Parameters
nVkCodeThe virtual key code. Look here for a list of virtual key codes: http://msdn.microsoft.com/en-us/library/ms645540(VS.85).aspx
bActiveTRUE when key is down and FALSE when released.
delegate void BearWare.TeamTalk4.FileTransferUpdate ( int  nTransferID,
FileTransferStatus  nStatus 
)

Delegate for event OnFileTransfer.

Parameters
nTransferIDTransfer ID
nStatusThe BearWare.FileTransfer's status.
delegate void BearWare.TeamTalk4.NewAudioBlock ( int  nUserID)

Delegate for event OnUserAudioBlock.

Parameters
nUserIDThe user ID of the user who has an BearWare.AudioBlock.
delegate void BearWare.TeamTalk4.NewDesktopWindow ( int  nUserID,
int  nSessionID 
)

Delegate for event OnUserDesktopWindow.

Parameters
nUserIDThe user's ID.
nSessionIDThe 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 
)

Delegate for event OnDesktopWindowTransfer().

Parameters
nSessionIDThe desktop session's ID. If the desktop session ID becomes 0 it means the desktop session has been closed and/or cancelled.
nTransferRemainingThe 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 
)

Delegate for event OnUserDesktopCursorPosition().

Parameters
nSrcUserIDThe user ID of the owner of the mouse cursor.
nDestUserIDThe owner of the desktop session the mouse cursor is pointing to.
delegate void BearWare.TeamTalk4.MaxPayloadUpdate ( int  nUserID,
int  nMaxPayload 
)

Delegate for event OnMaxPayloadUpdate().

Parameters
nUserIDThe user's ID. 0 means server's maximum payload size.
nMaxPayloadThe 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()
delegate void BearWare.TeamTalk4.StreamChannelMediaFile ( AudioFileStatus  nStatus)

Delegate for event OnStreamMediaFileChannel.

Parameters
nStatusThe status of the audio file.

Events

Connection BearWare.TeamTalk4.OnConnectSuccess

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

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

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

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

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

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

The client instance logged out of a server.

A response to DoLogout.

See Also
MyselfLoggedOut Delegate for this event.
DoLogout
MyselfJoinedChannel BearWare.TeamTalk4.OnCmdMyselfJoinedChannel

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

The client instance left a channel.

See Also
MyselfLeftChannel Delegate for this event.
OnCmdMyselfJoinedChannel
DoLeaveChannel
MyselfKickedFromChannel BearWare.TeamTalk4.OnCmdMyselfKickedFromChannel

The client instance was kicked from a channel.

See Also
MyselfKickedFromChannel Delegate for this event.
UserAuth BearWare.TeamTalk4.OnCmdUserLoggedIn

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

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

User changed properties.

See Also
UserUpdate Delegate for this event.
UserUpdate BearWare.TeamTalk4.OnCmdUserJoinedChannel

A user has joined a channel.

See Also
UserUpdate Delegate for this event.
UserUpdate BearWare.TeamTalk4.OnCmdUserLeftChannel

User has left a channel.

See Also
UserUpdate Delegate for this event.
UserTextMessage BearWare.TeamTalk4.OnCmdUserTextMessage

A user has sent a text-message.

See Also
UserTextMessage Delegate for this event.
ChannelUpdate BearWare.TeamTalk4.OnCmdChannelNew

A new channel has been created.

See Also
ChannelUpdate Delegate for this event.
ChannelUpdate BearWare.TeamTalk4.OnCmdChannelUpdate

A channel's properties has been updated.

See Also
ChannelUpdate Delegate for this event.
ChannelUpdate BearWare.TeamTalk4.OnCmdChannelRemove

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

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

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

A file has been removed from a channel.

See Also
FileUpdate Delegate for this event.
CommandError BearWare.TeamTalk4.OnCmdError

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

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

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

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

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

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

Voice activation has triggered transmission.

See Also
VoiceActivation Delegate for this event.
SetVoiceActivationLevel
ClientFlag CLIENT_SNDINPUT_VOICEACTIVATED
EnableTransmission
StreamUserAudioFile BearWare.TeamTalk4.OnStreamAudioFileUser

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

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

A hotkey has been acticated or deactivated.

See Also
HotKeyToggle Delegate for this event.
HotKey_Register
HotKey_Unregister
HotKeyTest BearWare.TeamTalk4.OnHotKeyTest

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

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

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

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

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

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

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

See Also
TeamTalk4.QueryMaxPayload()
StreamChannelMediaFile BearWare.TeamTalk4.OnStreamMediaFileChannel

Media file being streamed to a channel is processing.

This event is called as a result of TeamTalk4.StartStreamingMediaFileToChannel().