VCX Library by Lake of Soft

Components reference

ConferenceServer

Designed to provide multi-user voice and text chat for up to 15 clients simultaneously. If you need more than 15 clients, please contact us.

While IpClient, IpServer and MediaGate components allow peer-to-peer or one-to-many audio conversations only, the ConferenceServer component gives the ability for more than two participants to talk with each other in real time.

Set Proto and Port properties to specify the socket parameters. Set Active to true to initiate the server.

We recommend to use GSM/8000/16 bit/mono or GSM/44100/16 bit/mono audio quality settings, but you can experiment. Client's audio quality settings must be similar as ConferenceServer's ones.

Implements

IConferenceServer	default
IvcproConferenceServerEvents	default	source

IvcproConferenceServerEvents (IDispatch)
Can be implemeted by client to hook events

Methods
void OnAcceptClient(long ConnId, bool* accept)	Fires when server accepts new client connection. Set the accept parameter to True to accept connection. Call GetClientParam method to receive client parameters, such as ip-address, port number, etc.
void OnClientConnect(long ConnId)	Fires when new client connects to server
void OnClientDisconnect(long ConnId)	Fires when client disconnects from server
void OnReceiveText(long ConnId, BSTR Text)	Fires when component receives a text from remote side.

IConferenceServer
Dispatch interface for ConferenceServer component

Methods
void DisconnectClient(long ConnId)	Disconnects client from server using client connection ID
long GetClientConnId(long ClientIndex)	Returns ClientId for given index. ClientIndex may be from 0 to ClientCount - 1
BSTR GetClientParam(long ConnId, vcClientParam ParamType)	Returns client parameter such as ip-address, port number etc. using client connection ID and param type
void SendText(long ConnId, BSTR text)	Sends text message to client indicated by ConnId parameter over network. If component is in client mode, ConnId parameter is ignored
Properties
bool Active	Set to true to activate (open) the component. All other properties should be set to proper values before activation. Set to false to deactivate (close) the component
BSTR BindTo	Specifies the IP address the socket should bind to. Default '0.0.0.0' means that the socket should bind to the first available network interface.
long ClientCount	Returns current number of clients connected
long FormatTag	Specifies audio format tag for the wave device
long MaxClients	Specifies maximum number of clients that can connect to server. "-1" value means no limit, "0" value means no clients
long PcmBitsPerSample	Specifies number of bits per sample for wave device
long PcmNumChannels	Specifies number of channels per sample for wave device
long PcmSamplesPerSec	Specifies number of samples per second for wave device
BSTR Port	Specifies port number for the client/server TCP/IP socket
unaProtoType Proto	Specifies Proto for the TCP/IP socket (TCP or UDP)
bool SyncEvents	Specifies whether events calls synchronized through main thread