BearWare.TeamTalk5 Class Reference

Class used to load TeamTalk5.dll and instantiate a TeamTalk client in TeamTalk 5 SDK Standard Edition. More...

Inherits BearWare.TeamTalkBase.

Public Member Functions
	TeamTalk5 (bool poll_based)
	Simply calls TeamTalkBase.TeamTalkBase()
Public Member Functions inherited from BearWare.TeamTalkBase
void	Dispose ()
bool	GetMessage (ref TTMessage pMsg, int nWaitMs)
	Poll for events in the client instance.
bool	PumpMessage (ClientEvent nClientEvent, int nIdentifier)
	Cause client instance event thread to schedule an update event.
BearWare.ClientFlag	GetFlags ()
	Get a bitmask describing the client's current state.
void	ProcessMsg (TTMessage msg)
	Event handler for BearWare.TTMessage.
bool	InitSoundInputDevice (int nInputDeviceID)
	Initialize the sound input device (for recording audio).
bool	InitSoundInputSharedDevice (int nSampleRate, int nChannels, int nFrameSize)
	Setup sample rate, channels and frame size of shared sound input device.
bool	InitSoundOutputDevice (int nOutputDeviceID)
	Initialize the sound output device (for audio playback).
bool	InitSoundOutputSharedDevice (int nSampleRate, int nChannels, int nFrameSize)
	Setup sample rate, channels and frame size of shared sound output device.
bool	InitSoundDuplexDevices (int nInputDeviceID, int nOutputDeviceID)
	Enable duplex mode where multiple audio streams are mixed into a single stream using software.
bool	CloseSoundInputDevice ()
	Shutdown the input sound device.
bool	CloseSoundOutputDevice ()
	Shutdown the output sound device.
bool	CloseSoundDuplexDevices ()
	Shut down sound devices running in duplex mode.
bool	SetSoundDeviceEffects (SoundDeviceEffects lpSoundDeviceEffect)
	Set up audio effects on a sound device.
bool	GetSoundDeviceEffects (ref SoundDeviceEffects lpSoundDeviceEffect)
	Get the audio effects that are currently enabled.
int	GetSoundInputLevel ()
	Get the volume level of the current recorded audio.
bool	SetSoundInputGainLevel (int nLevel)
	Set voice gaining of recorded audio.
int	GetSoundInputGainLevel ()
	Get voice gain level of outgoing audio.
bool	SetSoundInputPreprocess (SpeexDSP lpSpeexDSP)
	Enable sound preprocessor which should be used for processing audio recorded by the sound input device (voice input).
bool	GetSoundInputPreprocess (ref SpeexDSP lpSpeexDSP)
	Get the sound preprocessor settings which are currently in use for recorded sound input device (voice input).
bool	SetSoundInputPreprocess (AudioPreprocessor lpAudioPreprocessor)
	Enable sound preprocessor which should be used for processing audio recorded by the sound input device (voice input).
bool	GetSoundInputPreprocess (ref AudioPreprocessor lpAudioPreprocessor)
	Get the sound preprocessor settings which are currently in use for recorded sound input device (voice input).
bool	SetSoundOutputVolume (int nVolume)
	Set master volume.
int	GetSoundOutputVolume ()
	Get master volume.
bool	SetSoundOutputMute (bool bMuteAll)
	Set all users mute.
bool	Enable3DSoundPositioning (bool bEnable)
	Enable automatically position users using 3D-sound.
bool	AutoPositionUsers ()
	Automatically position users using 3D-sound.
bool	EnableAudioBlockEvent (int nUserID, StreamType uStreamTypes, bool bEnable)
	Enable/disable access to raw audio from individual users, local microphone input or muxed stream of all users.
bool	EnableAudioBlockEvent (int nUserID, StreamType uStreamTypes, AudioFormat lpAudioFormat, bool bEnable)
	Same as TeamTalkBase.EnableAudioBlockEvent() but option to specify audio output format.
bool	InsertAudioBlock (AudioBlock lpAudioBlock)
	Transmit application provided raw audio in BearWare.AudioBlock-structs as BearWare.StreamType.STREAMTYPE_VOICE, i.e. microphone input.
bool	EnableVoiceTransmission (bool bEnable)
	Start/stop transmitting of voice data from sound input.
bool	EnableVoiceActivation (bool bEnable)
	Enable voice activation.
bool	SetVoiceActivationLevel (int nLevel)
	Set voice activation level.
int	GetVoiceActivationLevel ()
	Get voice activation level.
bool	SetVoiceActivationStopDelay (int nDelayMSec)
	Set the delay of when voice activation should be stopped.
int	GetVoiceActivationStopDelay ()
	Get the delay of when voice active state should be disabled.
bool	StartRecordingMuxedAudioFile (AudioCodec lpAudioCodec, string szAudioFileName, AudioFileFormat uAFF)
	Store all audio conversations with specific BearWare.AudioCodec settings to a single file.
bool	StartRecordingMuxedAudioFile (int nChannelID, string szAudioFileName, AudioFileFormat uAFF)
	Store audio conversations from a specific channel into a single file.
bool	StartRecordingMuxedStreams (StreamType uStreamTypes, AudioCodec lpAudioCodec, string szAudioFileName, AudioFileFormat uAFF)
	Mix multiple BearWare.StreamType into a single audio file.
bool	StopRecordingMuxedAudioFile ()
	Stop an active muxed audio recording.
bool	StopRecordingMuxedAudioFile (int nChannelID)
	Stop recording conversations from a channel to a single file.
bool	StartVideoCaptureTransmission (VideoCodec lpVideoCodec)
	Start transmitting from video capture device.
bool	StopVideoCaptureTransmission ()
	Stop transmitting from video capture device.
bool	InitVideoCaptureDevice (string szDeviceID, VideoFormat lpVideoFormat)
	Initialize a video capture device.
bool	CloseVideoCaptureDevice ()
	Close a video capture device.
bool	PaintVideoFrame (int nUserID, System.IntPtr hDC, int XDest, int YDest, int nDestWidth, int nDestHeight, ref VideoFrame lpVideoFrame)
	Paint user's video frame using a Windows' DC (device context).
bool	PaintVideoFrameEx (int nUserID, System.IntPtr hDC, int XDest, int YDest, int nDestWidth, int nDestHeight, int XSrc, int YSrc, int nSrcWidth, int nSrcHeight, ref VideoFrame lpVideoFrame)
	Paint user's video frame using a Windows' DC (device context).
VideoFrame	AcquireUserVideoCaptureFrame (int nUserID, out Bitmap bmp)
	Extract a user's video frame for display.
bool	ReleaseUserVideoCaptureFrame (VideoFrame lpVideoFrame)
	Delete a user's video frame, acquired through TeamTalkBase.AcquireUserVideoCaptureFrame(), so its allocated resources can be released.
bool	StartStreamingMediaFileToChannel (string szMediaFilePath, VideoCodec lpVideoCodec)
	Stream media file to channel, e.g. avi-, wav- or MP3-file.
bool	StartStreamingMediaFileToChannel (string szMediaFilePath, MediaFilePlayback lpMediaFilePlayback, VideoCodec lpVideoCodec)
	Stream media file to channel, e.g. avi-, wav- or MP3-file.
bool	UpdateStreamingMediaFileToChannel (MediaFilePlayback lpMediaFilePlayback, VideoCodec lpVideoCodec)
	Update active media file being streamed to channel.
bool	StopStreamingMediaFileToChannel ()
	Stop streaming media file to channel.
int	InitLocalPlayback (string szMediaFilePath, MediaFilePlayback lpMediaFilePlayback)
	Play media file using settings from BearWare.TeamTalkBase instance.
bool	UpdateLocalPlayback (int nPlaybackSessionID, MediaFilePlayback lpMediaFilePlayback)
bool	StopLocalPlayback (int nPlaybackSessionID)
VideoFrame	AcquireUserMediaVideoFrame (int nUserID, out Bitmap bmp)
	Extract a user's media video frame for display.
bool	ReleaseUserMediaVideoFrame (VideoFrame lpVideoFrame)
	Delete a user's video frame, acquired through TeamTalkBase.AcquireUserMediaVideoFrame(), so its allocated resources can be released.
int	SendDesktopWindow (DesktopWindow lpDesktopWindow, BitmapFormat nConvertBmpFormat)
	Transmit a desktop window (bitmap) to users in the same channel.
bool	CloseDesktopWindow ()
	Close the current desktop session.
int	SendDesktopWindowFromHWND (System.IntPtr hWnd, BitmapFormat nBitmapFormat, DesktopProtocol nDesktopProtocol)
	Transmit the specified window in a desktop session.
bool	PaintDesktopWindow (int nUserID, System.IntPtr hDC, int XDest, int YDest, int nDestWidth, int nDestHeight)
	Paint user's desktop window using a Windows' DC (device context).
bool	PaintDesktopWindowEx (int nUserID, System.IntPtr hDC, int XDest, int YDest, int nDestWidth, int nDestHeight, int XSrc, int YSrc, int nSrcWidth, int nSrcHeight)
	Paint user's desktop window using a Windows' DC (device context).
bool	SendDesktopCursorPosition (ushort nPosX, ushort nPosY)
	Send the position of mouse cursor to users in the same channel.
bool	SendDesktopInput (int nUserID, DesktopInput[] lpDesktopInputs)
	Send a mouse or keyboard event to a shared desktop window.
DesktopWindow	AcquireUserDesktopWindow (int nUserID)
	Get a user's desktop window (bitmap image).
DesktopWindow	AcquireUserDesktopWindowEx (int nUserID, BitmapFormat nBitmapFormat)
	Same as TeamTalkBase.AcquireUserDesktopWindow() except an extra option for converting bitmap to a different format.
bool	ReleaseUserDesktopWindow (DesktopWindow lpDesktopWindow)
	Release memory allocated by the BearWare.DesktopWindow.
bool	SetEncryptionContext (EncryptionContext lpEncryptionContext)
	Setup encryption properties prior to Connect().
bool	Connect (string szHostAddress, int nTcpPort, int nUdpPort, int nLocalTcpPort, int nLocalUdpPort, bool bEncrypted)
	Connect to a server.
bool	ConnectSysID (string szHostAddress, int nTcpPort, int nUdpPort, int nLocalTcpPort, int nLocalUdpPort, bool bEncrypted, string szSystemID)
	Same as Connect() but the option of providing a unique system-ID.
bool	ConnectEx (string szHostAddress, int nTcpPort, int nUdpPort, string szBindIPAddr, int nLocalTcpPort, int nLocalUdpPort, bool bEncrypted)
	Bind to specific IP-address prior to connecting to server.
bool	Disconnect ()
	Disconnect from the server.
bool	QueryMaxPayload (int nUserID)
	Query the maximum size of UDP data packets to the user or server.
bool	GetClientStatistics (ref ClientStatistics lpClientStatistics)
	Retrieve client statistics of bandwidth usage and response times.
bool	SetClientKeepAlive (ClientKeepAlive lpClientKeepAlive)
	Update the client instance's default keep alive settings.
bool	GetClientKeepAlive (ref ClientKeepAlive lpClientKeepAlive)
	Get the client instance's current keep alive settings.
int	DoPing ()
	Ping server and wait for server to reply.
int	DoLogin (string szNickname, string szUsername, string szPassword)
	Same as DologinEx() but without the option to specify szClientName. Kept for backwards compatibility.
int	DoLoginEx (string szNickname, string szUsername, string szPassword, string szClientName)
	Logon to a server.
int	DoLogout ()
	Logout of the server.
int	DoJoinChannel (Channel lpChannel)
	Create a new channel and join it.
int	DoJoinChannelByID (int nChannelID, string szPassword)
	Join an existing channel.
int	DoLeaveChannel ()
	Leave the current channel.
int	DoChangeNickname (string szNewNick)
	Change the client instance's nick name.
int	DoChangeStatus (int nStatusMode, string szStatusMessage)
	Change the client instance's currect status.
int	DoTextMessage (TextMessage lpTextMessage)
	Send a text message to either a user or a channel.
int	DoChannelOp (int nUserID, int nChannelID, bool bMakeOperator)
	Make another user operator of a channel.
int	DoChannelOpEx (int nUserID, int nChannelID, string szOpPassword, bool bMakeOperator)
	Make another user operator of a channel using the szOpPassword of BearWare.Channel.
int	DoKickUser (int nUserID, int nChannelID)
	Kick user from either channel or server.
int	DoSendFile (int nChannelID, string szLocalFilePath)
	Send a file to the specified channel.
int	DoRecvFile (int nChannelID, int nFileID, string szLocalFilePath)
	Download a file from the specified channel.
int	DoDeleteFile (int nChannelID, int nFileID)
	Delete a file from a channel.
int	DoSubscribe (int nUserID, Subscription uSubscriptions)
	Subscribe to user events and/or data.
int	DoUnsubscribe (int nUserID, Subscription uSubscriptions)
	Unsubscribe to user events/data. This can be used to ignore messages or voice data from a specific user.
int	DoMakeChannel (Channel lpChannel)
	Make a new channel on the server.
int	DoUpdateChannel (Channel lpChannel)
	Update a channel's properties.
int	DoRemoveChannel (int nChannelID)
	Remove a channel from a server.
int	DoMoveUser (int nUserID, int nChannelID)
	Issue command to move a user from one channel to another.
int	DoUpdateServer (ServerProperties lpServerProperties)
	Update server properties.
int	DoListUserAccounts (int nIndex, int nCount)
	Issue command to list user accounts on the server.
int	DoNewUserAccount (UserAccount lpUserAccount)
	Issue command to create a new user account on the server.
int	DoDeleteUserAccount (string szUsername)
	Issue command to delete a user account on the server.
int	DoBanUser (int nUserID, int nChannelID)
	Issue a ban command on a user in a specific channel.
int	DoBanUserEx (int nUserID, BanType uBanTypes)
	Ban the user with nUserID using the ban types specified.
int	DoBan (BannedUser lpBannedUser)
	Ban the properties specified in lpBannedUser.
int	DoBanIPAddress (string szIPAddress, int nChannelID)
	Issue a ban command on an IP-address user.
int	DoUnBanUser (string szIPAddress, int nChannelID)
	Unban the user with the specified IP-address.
int	DoUnBanUserEx (BannedUser lpBannedUser)
	Unban the properties specified in BearWare.BannedUser.
int	DoListBans (int nChannelID, int nIndex, int nCount)
	Issue a command to list the banned users.
int	DoSaveConfig ()
	Save the server's current state to its settings file (typically the server's .xml file).
int	DoQueryServerStats ()
	Get the server's current statistics.
int	DoQuit ()
	Quit from server.
bool	GetServerProperties (ref ServerProperties lpServerProperties)
	Get the server's properties.
bool	GetServerUsers (out User[] lpUsers)
	Get all the users on the server.
int	GetRootChannelID ()
	Get the root channel's ID.
int	GetMyChannelID ()
	Get the channel which the local client instance is currently participating in.
bool	GetChannel (int nChannelID, ref Channel lpChannel)
	Get the channel with a specific ID.
bool	GetChannelPath (int nChannelID, ref string szChannelPath)
	Get the channel's path. Channels are separated by '/'.
int	GetChannelIDFromPath (string szChannelPath)
	Get the channel ID of the supplied path. Channels are separated by '/'.
bool	GetChannelUsers (int nChannelID, out User[] lpUsers)
	Get the IDs of all users in a channel.
bool	GetChannelFiles (int nChannelID, out RemoteFile[] lpRemoteFiles)
	Get the list of the files in a channel which can be downloaded.
bool	GetChannelFile (int nChannelID, int nFileID, ref RemoteFile lpRemoteFile)
	Get information about a file which can be downloaded.
bool	IsChannelOperator (int nUserID, int nChannelID)
	Check whether user is operator of a channel.
bool	GetServerChannels (out Channel[] lpChannels)
	Get all the channels on the server.
int	GetMyUserID ()
	Get the local client instance's user ID.
bool	GetMyUserAccount (ref UserAccount lpUserAccount)
	Get the local client instance's BearWare.UserAccount.
UserType	GetMyUserType ()
	Get the client instance's user type.
BearWare.UserRight	GetMyUserRights ()
	Convenience method for TeamTalkBase.GetMyUserAccount()
int	GetMyUserData ()
	If an account was used in TeamTalkBase.DoLogin() then this value will return the nUserData from the BearWare.UserAccount.
bool	GetUser (int nUserID, ref User lpUser)
	Get the user with the specified ID.
bool	GetUserStatistics (int nUserID, ref UserStatistics lpUserStatistics)
	Get statistics for data and packet reception from a user.
bool	GetUserByUsername (string szUsername, ref User lpUser)
	Get the user with the specified username.
bool	SetUserVolume (int nUserID, StreamType nStreamType, int nVolume)
	Set the volume of a user.
bool	SetUserMute (int nUserID, StreamType nStreamType, bool bMute)
	Mute a user.
bool	SetUserStoppedPlaybackDelay (int nUserID, StreamType nStreamType, int nDelayMSec)
	Set the delay of when a user should no longer be considered as playing audio (either voice or audio from media file).
bool	SetUserJitterControl (int nUserID, StreamType nStreamType, JitterConfig lpJitterConfig)
	Set the configuration for de-jitter measures for a user.
bool	GetUserJitterControl (int nUserID, StreamType nStreamType, ref JitterConfig lpJitterConfig)
	Get the de-jitter configuration for a user.
bool	SetUserPosition (int nUserID, StreamType nStreamType, float x, float y, float z)
	Set the position of a user.
bool	SetUserStereo (int nUserID, StreamType nStreamType, bool bLeftSpeaker, bool bRightSpeaker)
	Set whether a user should speak in the left, right or both speakers. This function only works if BearWare.AudioCodec has been set to use stereo.
bool	SetUserMediaStorageDir (int nUserID, string szFolderPath, string szFileNameVars, AudioFileFormat uAFF)
	Store user's audio to disk.
bool	SetUserMediaStorageDir (int nUserID, string szFolderPath, string szFileNameVars, AudioFileFormat uAFF, int nStopRecordingExtraDelayMSec)
	Store user's audio to disk.
bool	SetUserAudioStreamBufferSize (int nUserID, StreamType uStreamType, int nMSec)
	Change the amount of media data which can be buffered in the user's playback queue.
AudioBlock	AcquireUserAudioBlock (StreamType uStreamTypes, int nUserID)
	Extract the raw audio associated with the event TeamTalkBase.OnUserAudioBlock().
bool	ReleaseUserAudioBlock (AudioBlock lpAudioBlock)
	Release the shared memory of an BearWare.AudioBlock.
bool	GetFileTransferInfo (int nTransferID, ref FileTransfer lpFileTransfer)
	Get information about an active file transfer.
bool	CancelFileTranfer (int nTransferID)
	Cancel an active file transfer.
bool	HotKey_Register (int nHotKeyID, int[] lpnVKCodes)
	Register a global hotkey.
bool	HotKey_Unregister (int nHotKeyID)
	Unregister a registered hotkey.
int	HotKey_IsActive (int nHotKeyID)
	Check whether hotkey is active.
bool	HotKey_InstallTestHook ()
	Install a test hook which calls the event #OnHotKeyTest whenever a key or mouse button is pressed.
bool	HotKey_RemoveTestHook ()
	Remove the test hook again so the #OnHotKeyTest event will no longer be notified.
bool	HotKey_GetKeyString (int nVKCode, ref string szKeyName)
	Get a string description of the virtual-key code.
bool	DBG_SetSoundInputTone (StreamType uStreamTypes, int nFrequency)
bool	DBG_WriteAudioFileTone (MediaFileInfo lpMediaFileInfo, int nFrequency)
delegate void	Connection ()
	Delegate for events #OnConnectionSuccess, #OnConnectionFailed and #OnConnectionLost.
delegate void	MaxPayloadUpdate (int nPayloadSize)
	Delegate for event OnConnectionMaxPayloadUpdated().
delegate void	CommandProcessing (int nCmdID, bool bActive)
	Delegate for event #OnCmdProcessing.
delegate void	CommandError (int nCmdID, ClientErrorMsg clienterrormsg)
	Delegate for event #OnCmdError.
delegate void	CommandSuccess (int nCmdID)
	Delegate for event #CommandSuccess.
delegate void	MyselfLoggedIn (int nMyUserID, UserAccount useraccount)
	Delegate for event #OnCmdMyselfLoggedIn.
delegate void	MyselfLoggedOut ()
	Delegate for event #OnCmdMyselfLoggedOut.
delegate void	MyselfKicked (User user)
	Delegate for event #OnCmdMyselfKicked.
delegate void	UserUpdate (User user)
	Delegate for events #OnCmdUserLoggedIn, #OnCmdUserLoggedOut, #OnCmdUserUpdate, #OnCmdUserJoinedChannel and #OnCmdUserLeftChannel.
delegate void	UserStreamUpdate (User user, int nStreamID)
	Delegate for events #OnUserFirstVoiceStreamPacket.
delegate void	UserTextMessage (TextMessage textmessage)
	Delegate for events #OnCmdUserTextMessage.
delegate void	ChannelUpdate (Channel channel)
	Delegate for #OnCmdChannelNew, #OnCmdChannelUpdate and #OnCmdChannelRemove.
delegate void	ServerUpdate (ServerProperties serverproperties)
	Delegate for event #OnCmdServerUpdate.
delegate void	ServerStats (ServerStatistics serverstatistics)
	Delegate for event #OnCmdServerStatistics.
delegate void	FileUpdate (RemoteFile remotefile)
	A delegate for events #OnCmdFileNew and #OnCmdFileRemove.
delegate void	ListUserAccount (UserAccount useraccount)
	A delegate for event #OnCmdUserAccount.
delegate void	ListBannedUser (BannedUser banneduser)
	A delegate for event #OnCmdUserAccount.
delegate void	UserVideoFrame (int nUserID, int nStreamID)
	A delegate for the event #OnUserVideoCapture.
delegate void	NewDesktopWindow (int nUserID, int nStreamID)
	Delegate for event #OnUserDesktopWindow.
delegate void	UserDesktopInput (int nSrcUserID, DesktopInput desktopinput)
	Delegate for event OnUserDesktopCursor().
delegate void	UserRecordMediaFile (int nUserID, MediaFileInfo mediafileinfo)
	Delegate for event #OnUserRecordMediaFile.
delegate void	NewAudioBlock (int nUserID, StreamType nStreamType)
	Delegate for event #OnUserAudioBlock.
delegate void	ErrorOccured (ClientErrorMsg clienterrormsg)
	Delegate for event #OnInternalError.
delegate void	VoiceActivation (bool bVoiceActive)
	Delegate for event #OnVoiceActivation.
delegate void	HotKeyToggle (int nHotKeyID, bool bActive)
	Delegate for event #OnHotKeyToggle.
delegate void	HotKeyTest (int nVkCode, bool bActive)
	Delegate for event #OnHotKeyTest.
delegate void	FileTransferUpdate (FileTransfer filetransfer)
	Delegate for event #OnFileTransfer.
delegate void	DesktopTransferUpdate (int nSessionID, int nBytesRemain)
	Delegate for event OnDesktopWindowTransfer().
delegate void	StreamMediaFile (MediaFileInfo mediafileinfo)
	Delegate for event #OnStreamMediaFile.
delegate void	LocalMediaFile (MediaFileInfo mediafileinfo)
	Delegate for event #OnLocalMediaFile.
delegate void	AudioInput (AudioInputProgress aip)
	Delegate for event #OnAudioInput.

Static Public Attributes
const int	DEFAULT_TCPPORT = 10333
const int	DEFAULT_UDPPORT = 10333
Static Public Attributes inherited from BearWare.TeamTalkBase
const int	TT_STRLEN = 512
	The maximum length of all strings used in TeamTalkBase. This value includes the zero terminator, so 511 characters. Note that Unicode characters are converted to UTF-8 internally and limited once again to 512 if the string gets longer.
const int	TT_USERID_MAX = 0xFFF
	The highest user ID.
const int	TT_CHANNELID_MAX = 0xFFF
	The highest channel ID. Also used for BearWare.TeamTalkBase.TT_CLASSROOM_FREEFORALL.
const int	TT_VIDEOFORMATS_MAX = 1024
const int	TT_TRANSMITUSERS_MAX = 128
	The maximum number of users allowed to transmit when a BearWare.Channel is configured with BearWare.ChannelType.CHANNEL_CLASSROOM.
const int	TT_CLASSROOM_FREEFORALL = 0xFFF
const int	TT_CLASSROOM_USERID_INDEX = 0
const int	TT_CLASSROOM_STREAMTYPE_INDEX = 1
const int	TT_TRANSMITUSERS_FREEFORALL = 0xFFF
const int	TT_TRANSMITUSERS_USERID_INDEX = 0
const int	TT_TRANSMITUSERS_STREAMTYPE_INDEX = 1
const int	TT_LOCAL_USERID = 0
	User ID passed to TeamTalkBase.EnableAudioBlockEvent() in order to receive BearWare.AudioBlock directly from sound input device after joining a channel.
const int	TT_LOCAL_TX_USERID = 0x1002
	User ID passed to TeamTalkBase.EnableAudioBlockEvent() in order to receive BearWare.AudioBlock when voice transmission is activated.
const int	TT_MUXED_USERID = 0x1001
	User ID used to identify muxed audio that has been mixed into a single stream.
const int	TT_CHANNELS_OPERATOR_MAX = 16
const int	TT_TRANSMITQUEUE_MAX = 16
const int	TT_SAMPLERATES_MAX = 16
const int	TT_DESKTOPINPUT_MAX = 16
const uint	TT_MEDIAPLAYBACK_OFFSET_IGNORE = 0xFFFFFFFF

Additional Inherited Members
Static Public Member Functions inherited from BearWare.TeamTalkBase
static string	GetVersion ()
	Get the DLL's version number.
static bool	SetLicenseInformation (string szRegName, string szRegKey)
	Set license information to disable trial mode.
static bool	GetDefaultSoundDevices (ref int lpnInputDeviceID, ref int lpnOutputDeviceID)
	Get the default sound devices.
static bool	GetDefaultSoundDevicesEx (SoundSystem nSndSystem, ref int lpnInputDeviceID, ref int lpnOutputDeviceID)
	Get the default sound devices for the specified sound system.
static bool	GetSoundDevices (out SoundDevice[] lpSoundDevices)
	Retrieve list of sound devices for recording and playback.
static bool	RestartSoundSystem ()
	Reinitialize sound system (in order to detect new/removed devices).
static IntPtr	StartSoundLoopbackTest (int nInputDeviceID, int nOutputDeviceID, int nSampleRate, int nChannels, bool bDuplexMode, SpeexDSP lpSpeexDSP)
	Perform a record and playback test of specified sound devices along with an audio configuration and ability to try echo cancellation.
static IntPtr	StartSoundLoopbackTest (int nInputDeviceID, int nOutputDeviceID, int nSampleRate, int nChannels, bool bDuplexMode, AudioPreprocessor lpAudioPreprocessor, BearWare.SoundDeviceEffects lpSoundDeviceEffects)
	Perform a record and playback test of specified sound devices along with an audio configuration and ability to try echo cancellation.
static bool	CloseSoundLoopbackTest (IntPtr lpTTSoundLoop)
	Stop recorder and playback test.
static bool	GetVideoCaptureDevices (out VideoCaptureDevice[] lpVideoDevices)
	Get the list of devices available for video capture.
static bool	GetMediaFileInfo (string szMediaFilePath, ref MediaFileInfo lpMediaFileInfo)
	Get the properties of a media file.
static System.Drawing.Color	Palette_GetColorTable (BitmapFormat nBmpPalette, int nIndex)
	Get RGB values of the palette for the bitmap format.
static string	GetErrorMessage (ClientError nError)
	Get textual discription of an error message.
Protected Member Functions inherited from BearWare.TeamTalkBase
	TeamTalkBase (bool poll_based)
	Create a new TeamTalk client instance.
Properties inherited from BearWare.TeamTalkBase
ClientFlag	Flags [get]
	Same as GetFlags().
int	ChannelID [get]
	Same as GetMyChannelID().
int	UserID [get]
	Same as GetMyUserID().
BearWare.UserType	UserType [get]
	Same as GetMyUserType().
BearWare.UserRight	UserRights [get]
	Same as GetMyUserRights().
int	UserData [get]
	Same as GetMyUserData().
Events inherited from BearWare.TeamTalkBase
Connection	OnConnectionSuccess
	Connected successfully to the server.
Connection	OnConnectionFailed
	Failed to connect to server.
Connection	OnConnectionLost
	Connection to server has been lost.
MaxPayloadUpdate	OnConnectionMaxPayloadUpdated
	The maximum size of the payload put into UDP packets has been updated.
CommandProcessing	OnCmdProcessing
	A command issued by Do* methods is being processed.
CommandError	OnCmdError
	The server rejected a command issued by the local client instance.
CommandSuccess	OnCmdSuccess
	The server successfully processed a command issued by the local client instance.
MyselfLoggedIn	OnCmdMyselfLoggedIn
	The client instance successfully logged on to server.
MyselfLoggedOut	OnCmdMyselfLoggedOut
	The client instance logged out of a server.
MyselfKicked	OnCmdMyselfKicked
	The client instance was kicked from a channel.
UserUpdate	OnCmdUserLoggedIn
	A new user logged on to the server.
UserUpdate	OnCmdUserLoggedOut
	A user logged out of the server.
UserUpdate	OnCmdUserUpdate
	User changed properties.
UserUpdate	OnCmdUserJoinedChannel
	A user has joined a channel.
UserUpdate	OnCmdUserLeftChannel
	User has left a channel.
UserTextMessage	OnCmdUserTextMessage
	A user has sent a text-message.
ChannelUpdate	OnCmdChannelNew
	A new channel has been created.
ChannelUpdate	OnCmdChannelUpdate
	A channel's properties has been updated.
ChannelUpdate	OnCmdChannelRemove
	A channel has been removed. Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_CHANNEL_REMOVE.
ServerUpdate	OnCmdServerUpdate
	Server has updated its settings (server name, MOTD, etc.)
ServerStats	OnCmdServerStatistics
	Server statistics available.
FileUpdate	OnCmdFileNew
	A new file is added to a channel.
FileUpdate	OnCmdFileRemove
	A file has been removed from a channel.
ListUserAccount	OnCmdUserAccount
	A new user account has been listed by the server. Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_USERACCOUNT.
ListBannedUser	OnCmdBannedUser
	A new banned user has been listed by the server. Event handler for BearWare.ClientEvent.CLIENTEVENT_CMD_BANNEDUSER.
UserStreamUpdate	OnUserFirstVoiceStreamPacket
	The first voice packet of a new voice stream has been received.
UserUpdate	OnUserStateChange
	A user's state has been updated.
UserVideoFrame	OnUserVideoCapture
	A new video frame was received from a user.
UserVideoFrame	OnUserMediaFileVideo
	A new video frame was received from a user.
NewDesktopWindow	OnUserDesktopWindow
	A new or updated desktop window has been received from a user.
UserDesktopInput	OnUserDesktopCursor
	A user has sent the position of the mouse cursor.
UserDesktopInput	OnUserDesktopInput
	Desktop input (mouse or keyboard input) has been received from a user.
UserRecordMediaFile	OnUserRecordMediaFile
	An media file recording has changed status.
NewAudioBlock	OnUserAudioBlock
	A new audio block can be extracted.
ErrorOccured	OnInternalError
	A internal error occured.
VoiceActivation	OnVoiceActivation
	Voice activation has triggered transmission.
HotKeyToggle	OnHotKeyToggle
	A hotkey has been acticated or deactivated.
HotKeyTest	OnHotKeyTest
	A button was pressed or released on the user's keyboard or mouse.
FileTransferUpdate	OnFileTransfer
	A file transfer is processing.
DesktopTransferUpdate	OnDesktopWindowTransfer
	Used for tracking when a desktop window has been transmitted to the server.
StreamMediaFile	OnStreamMediaFile
	Media file being streamed to a channel is processing.
LocalMediaFile	OnLocalMediaFile
	Media file is being played locally.
AudioInput	OnAudioInput
	Audio input progress as result of TeamTalkBase.InsertAudioBlock()

Detailed Description

Class used to load TeamTalk5.dll and instantiate a TeamTalk client in TeamTalk 5 SDK Standard Edition.

Section TeamTalk SDK Contents outlines the location of the required DLL files.

Definition at line 8728 of file TeamTalk.cs.

Constructor & Destructor Documentation

TeamTalk5()

BearWare.TeamTalk5.TeamTalk5

(

bool

poll_based

)

Simply calls TeamTalkBase.TeamTalkBase()

Definition at line 8734 of file TeamTalk.cs.

Member Data Documentation

DEFAULT_TCPPORT

const int BearWare.TeamTalk5.DEFAULT_TCPPORT = 10333

static

Definition at line 8730 of file TeamTalk.cs.

DEFAULT_UDPPORT

const int BearWare.TeamTalk5.DEFAULT_UDPPORT = 10333

static

Definition at line 8731 of file TeamTalk.cs.