TTMessage Struct Reference

A struct containing the properties of an event. More...

#include <TeamTalk.h>

Public Attributes
ClientEvent	nClientEvent
	The event's message number. More...
INT32	nSource
	The source of the event depends on wmMsg. More...
TTType	ttType
	Specifies which member to access in the union. More...
UINT32	uReserved
	Reserved. To preserve alignment. More...
union {
Channel   channel
	Valid if ttType is __CHANNEL. More...
ClientErrorMsg   clienterrormsg
	Valid if ttType is __CLIENTERRORMSG. More...
DesktopInput   desktopinput
	Valid if ttType is __DESKTOPINPUT. More...
FileTransfer   filetransfer
	Valid if ttType is __FILETRANSFER. More...
MediaFileInfo   mediafileinfo
	Valid if ttType is __MEDIAFILEINFO. More...
RemoteFile   remotefile
	Valid if ttType is __REMOTEFILE. More...
ServerProperties   serverproperties
	Valid if ttType is __SERVERPROPERTIES. More...
ServerStatistics   serverstatistics
	Valid if ttType is __SERVERSTATISTICS. More...
TextMessage   textmessage
	Valid if ttType is __TEXTMESSAGE. More...
User   user
	Valid if ttType is __USER. More...
UserAccount   useraccount
	Valid if ttType is __USERACCOUNT. More...
BannedUser   banneduser
	Valid if ttType is __BANNEDUSER. More...
TTBOOL   bActive
	Valid if ttType is __TTBOOL. More...
INT32   nBytesRemain
	Valid if ttType is __INT32. More...
INT32   nStreamID
	Valid if ttType is __INT32. More...
INT32   nPayloadSize
	Valid if ttType is __INT32. More...
StreamType   nStreamType
	Valid if ttType is __STREAMTYPE. More...
AudioInputProgress   audioinputprogress
	Valid if ttType is __AUDIOINPUTPROGRESS. More...
char   data [1]
};

Detailed Description

A struct containing the properties of an event.

The event can be retrieved by called TT_GetMessage. This struct is only required on non-Windows systems.

Section Client Event Handling explains event handling in the local client instance.

See also

TT_GetMessage

Definition at line 3806 of file TeamTalk.h.

Member Data Documentation

nClientEvent

ClientEvent TTMessage::nClientEvent

The event's message number.

See also

ClientEvent

Definition at line 3809 of file TeamTalk.h.

nSource

INT32 TTMessage::nSource

The source of the event depends on wmMsg.

Definition at line 3811 of file TeamTalk.h.

ttType

TTType TTMessage::ttType

Specifies which member to access in the union.

Definition at line 3813 of file TeamTalk.h.

uReserved

UINT32 TTMessage::uReserved

Reserved. To preserve alignment.

Definition at line 3815 of file TeamTalk.h.

channel

Channel TTMessage::channel

Valid if ttType is __CHANNEL.

Definition at line 3819 of file TeamTalk.h.

clienterrormsg

ClientErrorMsg TTMessage::clienterrormsg

Valid if ttType is __CLIENTERRORMSG.

Definition at line 3821 of file TeamTalk.h.

desktopinput

DesktopInput TTMessage::desktopinput

Valid if ttType is __DESKTOPINPUT.

Definition at line 3823 of file TeamTalk.h.

filetransfer

FileTransfer TTMessage::filetransfer

Valid if ttType is __FILETRANSFER.

Definition at line 3825 of file TeamTalk.h.

mediafileinfo

MediaFileInfo TTMessage::mediafileinfo

Valid if ttType is __MEDIAFILEINFO.

Definition at line 3827 of file TeamTalk.h.

remotefile

RemoteFile TTMessage::remotefile

Valid if ttType is __REMOTEFILE.

Definition at line 3829 of file TeamTalk.h.

serverproperties

ServerProperties TTMessage::serverproperties

Valid if ttType is __SERVERPROPERTIES.

Definition at line 3831 of file TeamTalk.h.

serverstatistics

ServerStatistics TTMessage::serverstatistics

Valid if ttType is __SERVERSTATISTICS.

Definition at line 3833 of file TeamTalk.h.

textmessage

TextMessage TTMessage::textmessage

Valid if ttType is __TEXTMESSAGE.

Definition at line 3835 of file TeamTalk.h.

user

User TTMessage::user

Valid if ttType is __USER.

Definition at line 3837 of file TeamTalk.h.

useraccount

UserAccount TTMessage::useraccount

Valid if ttType is __USERACCOUNT.

Definition at line 3839 of file TeamTalk.h.

banneduser

BannedUser TTMessage::banneduser

Valid if ttType is __BANNEDUSER.

Definition at line 3841 of file TeamTalk.h.

bActive

TTBOOL TTMessage::bActive

Valid if ttType is __TTBOOL.

Definition at line 3843 of file TeamTalk.h.

nBytesRemain

INT32 TTMessage::nBytesRemain

Valid if ttType is __INT32.

Definition at line 3845 of file TeamTalk.h.

nStreamID

INT32 TTMessage::nStreamID

Valid if ttType is __INT32.

Definition at line 3847 of file TeamTalk.h.

nPayloadSize

INT32 TTMessage::nPayloadSize

Valid if ttType is __INT32.

Definition at line 3849 of file TeamTalk.h.

nStreamType

StreamType TTMessage::nStreamType

Valid if ttType is __STREAMTYPE.

Definition at line 3851 of file TeamTalk.h.

audioinputprogress

AudioInputProgress TTMessage::audioinputprogress

Valid if ttType is __AUDIOINPUTPROGRESS.

Definition at line 3853 of file TeamTalk.h.

data

char TTMessage::data[1]

Definition at line 3855 of file TeamTalk.h.

union { ... }