Vibrant Communicator ActiveX library version 3.0

vcproIpServerX

Initiates listening socket for clients to connect to. Receives and sends audio stream to/from client.

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

Implements

IvcproIpServerX	default
IvcproIpServerEvents	default	source
IvcproProvider
IvcproConsumer

IvcproIpServerEvents (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 OnDataAvailable()	This method is fired every time component has produced or received new chunk of data. Use this event to access the stream data
void OnReceiveText(long ConnId, BSTR Text)	Fires when component receives a text from remote side.

IvcproIpServerX (IDispatch)
Dispatch interface for vcproIpServerX 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
VARIANT GetData()	Reads available data from output stream. Usually used when OnDataAvailable event fires
void SetData(VARIANT* data)	Writes data to input stream
void SendText(long ConnId, BSTR text)	Sends text message to client indicated by ConnId parameter over network
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
bool AutoActivate	When true tells the component it must activate consumer (if any) before activating itself. Same applies for deactivation. When false the component does not change the consumer state
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 BytesReceived	Returns number or bytes component has received from the network
long BytesSent	Returns number or bytes component has sent to the network
long ClientCount	Returns current number of clients connected
long DataSizeIn	Returns data written into but not yet processed by the pipe
long DataSizeOut	Returns data size available to read from the pipe
BSTR DumpInput	File name to dump the component input data to
BSTR DumpOutput	File name to dump the component output data to
bool IsFormatProvider	When true the component will assign stream format to the consumer (if any). This simplifies the process of distributing stream format among linked components. For example WaveRiff component can assign PCM format to linked WaveOutDevice component, so WAVe file will be played back correctly
long MaxClients	Specifies maximum number of clients that can connect to server. "-1" value means no limit, "0" value means no clients
BSTR Port	Specifies port number for the client/server TCP/IP socket
unaProtoType Proto	Specifies Proto for the TCP/IP socket (TCP or UDP)
unaStreamingMode StreamingMode	Specifies whether component uses communication protocol (VC) or streams raw audio to the network (RAW). Use raw streaming for external network devices, such as Barix Exstreamer/Instreamer/Anuncicom.
bool SyncEvents	Specifies whether events calls synchronized through main thread