BigSpeed Voice Chat SDK is a set of two COM objects (Client and Server) that lets you set up a private voice chat network for secure messaging. The transfered data are scrambled using on-the-fly 128-bit AES encryption, without need of SSL certificates. The security is provided in two different modes: symmetric encryption with shared secret key and asymmetric encryption with 1024-bit public/private keys.

The server is responsible for keeping information on and authentication of online peers. All peers connected to a particular server build a single private community.

Fine grained access control is realized by a group of user-oriented permissions. They grant access control privileges to system resources and services in a flexible and secure manner.

The voice stream is highly compressed to deliver the best possible sound over a limited-bandwidth connection. In addition, the average bitrate is reduced thanks to the silence compression. In the encoder, a voice activity detector with an adjustable threshold level is used to distinguish between regions with normal speech activity and those with silence or background noise.

Significant echo suppression is achieved using a robust double talk detector. Capability to mute recording and mute playback is implemented.

The incoming and outgoing audio data are available in raw PCM format for visualization in the application.

Two special events notify about signal overloading (possible distorsions) and transmission delays (network congestions).

Two different kind of text information can be exchanged between peers: alert and chat messages.

File transfer capability is implemented for direct file exchange between peers.

BigSpeed Voice Chat SDK utilizes an elegant event-driven paradigm for easy integration into Windows applications. A special attention is paid to provide responsive user interface while avoiding multithreading problems and maintaining maximum bandwidth efficiency.

Carefully designed set of properties, methods, and events offers great flexibility to develop voice chat applications quickly and easily.

Sample applications are included in Visual Basic 2005 and Delphi 7.

Installation

The BigSpeed Voice Chat SDK setup utility will copy all the necessary files into the installation directory you selected and will register the COM libraries on your Windows system. There are some additional steps you must take to complete the installation, based on which development language you are using.

Start Visual Basic 6.0
Create a new project or open an existing one.
Select References from the Project menu.
Entries named "BIGSPEED Voice Chat Client Component" and "BIGSPEED Voice Chat Server Component" should appear in the components list.
In the References dialog, make sure the "BIGSPEED Voice Chat Client Component" and "BIGSPEED Voice Chat Server Component" items are checked in the references list.
Click the OK button. This will make the COM objects available for use in your applications.

Start Delphi
Open an existing project or create a new project
From the Project menu, select the "Import Type Library" item
Select the "BIGSPEED Voice Chat Client Component" and "BIGSPEED Voice Chat Server Component" from the list of libraries
Check the "Generate Component Wrapper" checkbox
Enter the path for the new unit in the "Unit dir name" field.
Click on the "Create Unit" button that's on the Import Type Library dialog

Start Visual Basic .NET
Create a new project or open an existing one.
From the Project menu, select the "Add Reference" item
In the "Add Reference" dialog, click the tab named "COM" .
Entries named "BIGSPEED Voice Chat Client Component" and "BIGSPEED Voice Chat Server Component" should appear in the components list.
Make sure the "BIGSPEED Voice Chat Client Component" and "BIGSPEED Voice Chat Server Component" are selected in the components list.
Click the OK button. This will make the COM objects available for use in your applications.

LastError property

Integer (Read-only)

None

LastError property returns the error code for the last method invocation. Zero indicates no error (success).

SecurityMode property

Integer

Zero

SecurityMode property specifies what security mode to be used for the next connectuon sessions.
There are three possible values:

0 - Plain mode. No encryption is used.

1 - Symmetric encryption. The SecretKey property will be used by the component to calculate a unique session key for each connection. The incomming connections will be limited only to the peers which have assigned the same SecretKey.

2 - Asymmetric encryption. The PublicKey/PrivateKey properties will be used by the component to calculate a unique session key for each connection. The incomming connections can be limited only to a predefined list of peers by assigning the correct digital fingerprints to the property Fingerprints.

SecretKey property

String

Empty

SecretKey property holds the cryptographic key used to calculate the session key when a symmetric encyption is used. Only peers with the same secret key will be able to communicate to each other.

PublicKey property

String

Empty

PublicKey property holds the public key used to calculate the session key in the asymmetric encryption mode. It should be previously generated by the method GenerateKeypair.

PrivateKey property

String

Empty

PrivateKey property holds the private key used to calculate the session key in the asymmetric encryption mode. It should be previously generated by the method GenerateKeypair.

Fingerprints property

String

Empty

Fingerprints property optionally can be used to restrict the incomming connection only to certain peers. The expected format is a comma-delimited list of digital fingerprints, as calculated by the method TakeFingerprint.

BindAddress property

String

Empty

If the local machine has multiple network interfaces, this property can specify which one to be used. If the value is empty, the default IP address will be used.

SessionOpening property

Boolean (Read-only)

False

This property indicates if the Client is in a connecting state. There are three possible states: closed (the default), connecting, and connected. The component stays in a connecting state after the method OpenSession is called until either of the events OnSessionOpen or OnSessionRejected is fired.

SessionOpen property

Boolean (Read-only)

False

This property indicates if the Client is in a connected state. There are three possible states: closed (the default), connecting, and connected. The component stays in a connected state after the event OnSessionOpen is fired until the event OnSessionClosed is fired.

Username property

String

Empty

Username property specifies the sign-in ID of the user. If it's empty, a default (Guest) user will be used from the peers when they determine the access rights for local Client.

ServerAddress property

String

Empty

This property holds the IP address of the Server, when the session is open.

ServerPort property

Integer

0

This property holds the port of the Server, when the session is open.

SocksVersion property

Integer

4

This property specifies the version of the SOCKS protocol to be used. Valid values are "4" and "5".

SocksServer property

String

Empty

SocksServer property sets the address of the proxy server. It accepts dotted decimal format or domain name.

SocksPort property

Long

0

SocksPort property indicates the port of the proxy server.

SocksUsername property

String

Empty

SocksUsername property specifies the user name to be used for proxy server authentication.

SocksPassword property

String

Empty

SocksPassword property specifies the password to be used for proxy server authentication.

TransferSuffix property

String

"_bsfilelib_transfer"

TransferSuffix property holds the string constant to be appended to the name of the transferred upload files during the operation is in progress.

MuteRecording property

Boolean

False

If set to True, the input signal from the microphone will be muted.

MutePlayback property

Boolean

False

If set to True, the output signal to the speakers will be muted.

ActivationLevel property

Integer

2

A threshold sound level, at which the voice recording will be activated. It's a relative value, from 0 to 10.

CompressionLevel property

Integer

3

Use CompressionLevel to set the compression ratio of the voice data before sending it to the peer. Higher compression results in a poorer sound quality, but a smaller size. It's a relative value, from 0 to 15.

RecordingDevice property

Integer

0

This number is the ID of the wave in device to be used for recording.

PlaybackDevice property

Integer

0

This number is the ID of the wave out device to be used for playback.

GenerateKeypair method

GenerateKeypair( ByRef aPublicKey As String, ByRef aPrivateKey As String ) As Boolean

This method generates a new random key pair of public and private keys. They can be used for the properties PublicKey and PrivateKey.

aPublicKey The Base64 encoded value of the generated public key is returned here

aPublicKey The Base64 encoded value of the generated private key is returned here

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Ok = GenerateKeypair( PubKey, PvtKey )

TakeFingerprint method

TakeFingerprint( aPublicKey As String ) As String

This method calculates a digital fingerprint (MD5 checksum) of a public key.

aPublicKey Base64 encode value of the public key.

The return value is the Base64 encoded MD5 checksum. It can be used in the property Fingerprints on the remote peers.

FP = TakeFingerprint( PubKey )

GetMoniker method

GetMoniker( ByVal aHandle As Long ) As Long

GetMoniker method provides the moniker ID associated with the peer object. It should be previously set with SetMoniker method.

aHandle Handle of the desired peer object.

Integer value representing the moniker ID.

SetMoniker method

SetMoniker( ByVal aHandle As Long ,ByVal aMoniker As Long )

SetMoniker method assigns a moniker ID (4 byte integer) to a peer object. This could be helpful for easy reference to some application data associated with the client.

aHandle Handle of the desired peer object.

aMoniker The moniker ID value

None.

OpenSession method

OpenSession( ByVal aHost As String , ByVal aPort As Long , ByVal aUsername As String , ByVal aPassword As String ) As Boolean

OpenSession method issues a request to establish a connection to the Server. The Client moves from closed to the connecting state. The application will be notified later on for the result of the operation. If the Client is connected successfully the event OnSessionOpen will be fired, otherwise the event OnSessionRejected will be fired.

aHost The address of the Server. It can be in dotted decimal format or domain name.

aPort The listening port number of the Server.

aUsername The username for logging in to the Server. If it's empty, the default (Guest) account will be used

aPassword The password needed for the login operation. Should be empty for Guest login.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Ok = P2pClient.OpenSession(edHost.Text, Val(edServerPort.Text), edUsername.Text, edPassword.Text)

CloseSession method

CloseSession As Boolean

CloseSession method issues a reguest to the Client to break the connection with the Server. The event OnSessionClosed will notify the application about the result of the operation.

None

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

GetSessionState method

GetSessionState() As Long

GetSessionState method provides information about the current status of the connection to the server.

None

An integer code with the following meaning:

0 Disconnected

1 Connecting

2 Connected

DisconnectPeer method

DisconnectPeer( ByVal aHandle As Long ) As Boolean

DisconnectPeer method disconnects and destroys a peer object.

aHandle Handle of the desired peer object.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

GetClientName method

GetClientName( ByVal aHandle As Long ) As String

GetClientName method provides the user name associated with a peer object.

aHandle Handle of the desired peer object.

Name of the logged in user.

GetClientAddress method

GetClientAddress( ByVal aHandle As Long ) As String

GetClientAddress gives the peer IP address.

aHandle Handle of the desired peer object.

Peer address in IP dotted format.

GetClientPort method

GetClientPort( ByVal aHandle As Long ) As Long

GetClientPort method gives the peer port number.

aHandle Handle of the desired peer object.

Peer port number.

SendAlertMessage method

SendAlertMessage( ByVal aHandle As Long ByVal aMessage As String ) As Boolean

SendAlertMessage method sends an alert message to a connected peer.

aHandle Handle of the desired peer object.

aMessage Text of the message to be sent

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

SendChatMessage method

SendChatMessage( ByVal aHandle As Long ByVal aMessage As String ) As Boolean

SendChatMessage method sends a chat message to a connected peer.

aHandle Handle of the desired peer object.

aMessage Text of the message to be sent

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

SendBinaryMessage method

SendBinaryMessage( ByVal aHandle As Long , ByRef aMessage As Variant ) As Boolean

SendBinaryMessage method sends a binary message (byte array) to a peer or the server.

aHandle Handle of the desired peer object. If it's zero, the message is sent to the server.

aMessage Variant array of bytes holding the message data

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

GetCaller method

GetCaller( ) As Long

GetCaller method provides the handle of the peer object which is requested to initiate a talk.

Integer value representing the handle of the peer object.

GetTalkerCount method

GetTalkerCount( ) As Long

GetTalkerCount method returns the number of peers currently involved in a talk.

Number of the talking peers.

GetTalker method

GetTalker( ByVal aIndex As Long ) As Long

GetTalker method provides the handle of the peer object which is currently involved in a call.

aIndex Index of the peer object, must be from 0 to GetTalkerCount-1.

Integer value representing the handle of the peer object.

GetTalkState method

GetTalkState( ByVal aHandle As Long ) As Long

GetTalkState method provides information about the current talk state of a peer.

aHandle Handle of the desired peer object.

An integer value with the following meaning:

0 Idle

1 Outgoing invitation

2 Established talk

3 Incoming invitation

GetRecordingDeviceCount method

GetRecordingDeviceCount( ) As Long

GetRecordingDeviceCount method returns the number of sound recording devices installed on the system.

None

Number of devices

GetRecordingDeviceName method

GetRecordingDeviceName( ByVal aIndex As Long ) As String

GetRecordingDeviceName method provides the name describing a sound recording device.

aIndex Index of the device in interest

A device name

GetPlaybackDeviceCount method

GetPlaybackDeviceCount( ) As Long

GetPlaybackDeviceCount method returns the number of sound playing devices installed on the system.

None

Number of devices

GetPlaybackDeviceName method

GetPlaybackDeviceName( ByVal aIndex As Long ) As String

GetPlaybackDeviceName method provides the name describing a sound playing device.

aIndex Index of the device in interest

A device name

BeginTalk method

BeginTalk( ByVal aHandle As Long ) As Boolean

BeginTalk method sends an invitation to a peer to participiate in a talk. The response will be available through the events OnTalkBegan or OnTalkRefused.

aHandle Handle of the desired peer object.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

EndTalk method

EndTalk()

EndTalk method terminates the currently established talk.

None

RequestOutFile method

RequestOutFile( ByVal aHandle As Long ByVal aFilename As String ) As Boolean

RequestOutFile method issues a request to send a file to a connected peer.

aHandle Handle of the desired peer object.

aFilename The full path and name of the file to be sent

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

CancelOutFile method

CancelOutFile( ByVal aHandle As Long ) As Boolean

CancelOutFile method cancel a running outgoing file transfer.

aHandle Handle of the peer with the outgoing file transfer.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

CancelInFile method

CancelInFile( ByVal aHandle As Long ) As Boolean

CancelInFile method cancel a running incoming file transfer.

aHandle Handle of the peer with the incoming file transfer.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

GetOutgoingFile method

GetOutgoingFile( ByVal aHandle As Long ) As String

GetOutgoingFile method provides the file path and name for the currently running outgoing file transfer.

aHandle Handle of the desired peer object.

Path and name of the transferred file.

OnSessionOpen event

OnSessionOpen

OnSessionOpen event is generated when the Client has just been connected to the Server after a call to "OpenSession()". At this moment the Client is ready to accept connections from other peers. The component moves from connecting to connected state.

None

OnSessionClosed event

OnSessionClosed()

This event is generated when the connection to the Server has just been broken. All currently connected peers are automatically disconnected. The Client moves from connected to the closed state.

None

OnSessionRejected event

OnSessionRejected

OnSessionRejected event is generated when a connection attempt to the Server (call to OpenSession() method) has been failed. The Client moves from connecting to the closed state. The LastError property holds the error code.

None

OnClientConnected event

OnClientConnected(ByVal aHandle As Long)

OnClientConnected event is generated when a new peer object has just been created. It is fired when the peer information is received from the server.

aHandle The handle of the newly created peer. It should be stored for future references.

OnClientDisconnected event

OnClientDisconnected(ByVal aHandle As Long)

OnClientDisconnected event is generated when a connected peer has just been disconnected from the Client. The handle of the peer is no more valid for future references.

aHandle The handle of the peer firing the event

OnAlertMessage event

OnAlertMessage( ByVal aHandle As Long ,ByVal aMessage As String )

OnAlertMessage event delivers an alert message from a peer.

aHandle The handle of the peer firing the event

aMessage The text of the message

OnChatMessage event

OnChatMessage( ByVal aHandle As Long ,ByVal aMessage As String )

OnChatMessage event delivers a chat message from a peer.

aHandle The handle of the peer firing the event

aMessage The text of the message

OnBinaryMessage event

OnBinaryMessage( ByVal aHandle As Long ,ByRef aMessage As Variant)

OnBinaryMessage event delivers binary message received from a peer or the server.

aHandle The handle of the peer firing the event. If it's zero, sender is the server

aMessage Byte array holding the message data

OnTalkInvited event

OnTalkInvited( ByVal aHandle As Long ,ByRef aOkay As Boolean )

OnTalkInvited event notifies about a talk request from a peer. The application should display a prompt to the user asking for a permission.

aHandle Handle of the peer object firing the event.

aOkay If the user wants to accept the call, this parameter must be set to True

OnTalkBegan event

OnTalkBegan( ByVal aHandle As Long )

OnTalkBegan event notifies about a successful establishment of a talk. It is fired after a positive answer to OnTalkInvited.

aHandle Handle of the peer object firing the event.

OnTalkRefused event

OnTalkRefused( ByVal aHandle As Long , ByVal aCode As Long )

OnTalkRefused event notifies about a failed outgoing call request with BeginTalk. It is fired after a negative response to OnTalkInvited at the remote side.

aHandle Handle of the peer object firing the event.

aCode The error code

OnTalkFailed event

OnTalkFailed( ByVal aHandle As Long , ByVal aCode As Long )

OnTalkFailed event notifies about a failed incoming call. It is fired after OnTalkInvited if by some reason the talk cannot be started.

aHandle Handle of the peer object firing the event.

aCode The error code

OnTalkEnded event

OnTalkEnded( ByVal aHandle As Long )

OnTalkEnded event notifies about an ended call previously signaled with OnTalkBegan.

aHandle Handle of the peer object firing the event.

OnWaveRecorded event

OnWaveRecorded( ByRef aWave As Variant )

OnWaveRecorded event delivers the last recorded chunk of voice data.

aWave Variant array of bytes containing audio data in PCM format

OnWavePlayed event

OnWavePlayed( ByVal aHandle As Long ,ByRef aData As Variant )

OnWavePlayed event notifies about the last played chunk of voice data.

aHandle Handle of the player sending the event

aData Audio data in PCM format

OnWaveEncoded event

OnWaveEncoded( ByRef aWave As Variant ,ByRef aCode As Variant )

OnWaveEncoded event delivers the last compressed frame of voice data.

aWave Variant array of bytes containing raw data in PCM format

aCode Variant array of bytes containing compressed data

OnWaveDecoded event

OnWaveDecoded( ByVal aHandle As Long ,ByRef aCode As Variant ,ByRef aWave As Variant )

OnWaveDecoded event delivers the last decompressed frame of voice data.

aHandle Handle of the player sending the event

aCode Variant array of bytes containing compressed data

aWave Variant array of bytes containing raw data in PCM format

OnStartRecording event

OnStartRecording

OnStartRecording event is generated when high sound level is detected and the client is switching to recording state.

None

OnStopRecording event

OnStopRecording

OnStopRecording event is generated when lower sound level is detected and the client is switching to paused state.

None

OnStartDelaying event

OnStartDelaying

OnStartDelaying event is generated when a packet delay is detected because of network slowdown.

None

OnStopDelaying event

OnStopDelaying

OnStopDelaying event is generated when the network performance is good enough to compensate the packet delay.

None

OnStartOverloading event

OnStartOverloading

OnStartOverloading event is generated when the input signal has too high level and there is a risk for audio distorsions.

None

OnStopOverloading event

OnStopOverloading

OnStopOverloading event is generated when the input signal is back to a normal level.

None

OnOutFileProgress event

OnOutFileProgress( ByVal aHandle As Long ,ByVal aCountLo As Long ,ByVal aCountHi As Long ,ByVal aSizeLo As Long ,ByVal aSizeHi As Long )

OnOutFileProgress provides progress information about outgoing file transfer.

aHandle Handle of the peer object firing the event.

aCountLo The low 32 bits of the current byte count.

aCountHi The high 32 bits of the current byte count.

aSizeLo The low 32 bits of the total byte size.

aSizeHi The high 32 bits of the total byte size.

OnOutFileDone event

OnOutFileDone( ByVal aHandle As Long ByVal aCode As Long )

OnOutFileDone event notifies about a completion of an outgoing file transfer.

aHandle Handle of the peer object firing the event.

aHandle Error code for the operation, zero on success

OnInFileRequested event

OnInFileRequested( ByVal aHandle As Long ,ByRef aPath As String ,ByRef aOkay As Boolean )

OnInFileRequested event notifies about a request for incoming file transfer from a peer. The application should ask the user for permission and accept or reject the request.

aHandle Handle of the peer object firing the event.

aPath Here the application must return the full path for the requested file to be placed.

aOkay If the aplication wants to accept the transfer, this parameter must be set to True

OnInFileProgress event

OnInFileProgress( ByVal aHandle As Long ,ByVal aCountLo As Long ,ByVal aCountHi As Long ,ByVal aSizeLo As Long ,ByVal aSizeHi As Long )

OnInFileProgress provides progress information about incoming file transfer.

aHandle Handle of the peer object firing the event.

aCountLo The low 32 bits of the current byte count.

aCountHi The high 32 bits of the current byte count.

aSizeLo The low 32 bits of the total byte size.

aSizeHi The high 32 bits of the total byte size.

OnInFileDone event

OnInFileDone( ByVal aHandle As Long ByVal aCode As Long )

OnInFileDone event notifies about a completion of an incoming file transfer.

aHandle Handle of the peer object firing the event.

aHandle Error code for the operation, zero on success

LocalIPList property

String (Read-only)

N/A

Returns a comma-delimited list of available IP addresses on the local machine.

LastError property

Integer (Read-only)

None

LastError property returns the error code for the last method invocation. Zero indicates no error (success).

SecurityMode property

Integer

Zero

SecurityMode property specifies what security mode to be used for the next connectuon sessions.
There are three possible values:

0 - Plain mode. No encryption is used.

1 - Symmetric encryption. The SecretKey property will be used by the component to calculate a unique session key for each connection. The incomming connections will be limited only to the peers which have assigned the same SecretKey.

2 - Asymmetric encryption. The PublicKey/PrivateKey properties will be used by the component to calculate a unique session key for each connection. The incomming connections can be limited only to a predefined list of peers by assigning the correct digital fingerprints to the property Fingerprints.

SecretKey property

String

Empty

SecretKey property holds the cryptographic key used to calculate the session key when a symmetric encyption is used. Only peers with the same secret key will be able to communicate to each other.

PublicKey property

String

Empty

PublicKey property holds the public key used to calculate the session key in the asymmetric encryption mode. It should be previously generated by the method GenerateKeypair.

PrivateKey property

String

Empty

PrivateKey property holds the private key used to calculate the session key in the asymmetric encryption mode. It should be previously generated by the method GenerateKeypair.

Fingerprints property

String

Empty

Fingerprints property optionally can be used to restrict the incomming connection only to certain peers. The expected format is a comma-delimited list of digital fingerprints, as calculated by the method TakeFingerprint.

BindAddress property

String

Empty

If the local machine has multiple network interfaces, this property can specify which one to be used. If the value is empty, the default IP address will be used.

ListeningPort property

Long

0

ListeningPort property holds the port number on which the Server is listening for incoming connections. If it's set to 0, the Server will use a random value. If the PC is behind a firewall/NAT/router, you need to forward/open this port. The website www.portforward.com may help in that case.

LocalIPList property

String (Read-only)

Empty

LocalIPList property holds a comma-delimited list of available IP addresses of the local machine.

Running property

Boolean (Read-only)

False

Running property indicates if the Server is currently listening for incoming connections.

Start method

Start( ) As Boolean

Start method instructs the Server to start listening for incoming connections.

None.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Stop method

Stop( ) As Boolean

Stop method instructs the Server to stop listening for incoming connections. All currently connected clients will be disconnected as well.

None.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

GetMoniker method

GetMoniker( ByVal aHandle As Long ) As Long

GetMoniker method provides the moniker ID associated with the client object. It should be previously set with SetMoniker method.

aHandle Handle of the desired client object.

Integer value representing the moniker ID.

SetMoniker method

SetMoniker( ByVal aHandle As Long ,ByVal aMoniker As Long )

SetMoniker method assigns a moniker ID (4 byte integer) to a client object. This could be helpful for easy reference to some application data associated with the client.

aHandle Handle of the desired client object.

aMoniker The moniker ID value

None.

GenerateKeypair method

GenerateKeypair( ByRef aPublicKey As String, ByRef aPrivateKey As String ) As Boolean

This method generates a new random key pair of public and private keys. They can be used for the properties PublicKey and PrivateKey.

aPublicKey The Base64 encoded value of the generated public key is returned here

aPublicKey The Base64 encoded value of the generated private key is returned here

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Ok = GenerateKeypair( PubKey, PvtKey )

TakeFingerprint method

TakeFingerprint( aPublicKey As String ) As String

This method calculates a digital fingerprint (MD5 checksum) of a public key.

aPublicKey Base64 encode value of the public key.

The return value is the Base64 encoded MD5 checksum. It can be used in the property Fingerprints on the remote peers.

FP = TakeFingerprint( PubKey )

DisconnectPeer method

DisconnectPeer( ByVal aHandle As Long )

DisconnectPeer method disconnects and destroys a client object.

aHandle Handle of the desired client object.

None.

GetClientAddress method

GetClientAddress( ByVal aHandle As Long ) As String

GetClientAddress gives the client IP address.

aHandle Handle of the desired client object.

client address in IP dotted format.

GetClientPort method

GetClientPort( ByVal aHandle As Long ) As String

GetClientPort method gives the client's port number.

aHandle Handle of the desired client object.

client's port number.

GetClientName method

GetClientName( ByVal aHandle As Long ) As String

GetClientName method provides the user name associated with a client object.

aHandle Handle of the desired client object.

Name of the signed-in user.

SendBinaryMessage method

SendBinaryMessage( ByVal aHandle As Long , ByRef aMessage As Variant ) As Boolean

SendBinaryMessage method sends a binary message (byte array) to a client.

aHandle Handle of the desired client object.

aMessage Variant array of bytes holding the message data

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

OnConnectionRequest event

OnConnectionRequest( ByVal aReserved As Long ,ByVal aUsername As String ,ByRef aPassword As String ,ByRef aAccept As Boolean )

OnConnectionRequest event notifies about a login request from a client. The application should check the user profile and return the value of the password.

aReserved Reserved for future use.

aUsername Name of the desired user.

aPassword This is an out parameter. If the username is found in user profile, the application must pass here the password value set for the asked username previously by the administrator.

aAccept If the aplication wants to grant an access to the client, this value must be set to True

OnClientConnected event

OnClientConnected( ByVal aHandle As Long )

OnClientConnected event is generated when a new client has just been connected to the Server. The application should store the handle to the newly created client object for later use.

aHandle Handle of the newly created client object. It should be saved for future reference to it.

OnClientDisconnected event

OnClientDisconnected( ByVal aHandle As Long ,ByVal aCode As Long )

OnClientDisconnected event is generated when a connected client has just been disconnected from the Server. The handle of the client is no more valid for future references.

aHandle The handle of the client firing the event

aCode Indicates the error code.

OnClientRejected event

OnClientRejected( ByVal aUsername As String ,ByVal aAddress As String ,ByVal aPort As Long ,ByVal aCode As Long )

OnClientRejected event is generated when a client connection has just been refused.

aUsername The username of the client.

aAddress The IP address of the client.

aPort The client port.

aCode Indicates the error code.

OnBinaryMessage event

OnBinaryMessage( ByVal aHandle As Long ,ByRef aMessage As Variant)

OnBinaryMessage event delivers binary message received from a client.

aHandle Handle of the client firing the event

aMessage Byte array holding the message data

Error codes

0 No error

1 User action

2 Unknown error

3 Invalid handle

4 Invalid data

5 There is no assigned event handler

6 Illegal operation

7 Event handler error

8 Bad encryption key

10 Connection is refused

11 Connection timeout

12 Broken connection

13 Not connected

14 Too many connections

20 Cannot start server

21 Cannot connect to SOCKS server

22 Wrong username or password

23 Access is denied

24 Client is not signed-in

30 Operation is already running

31 Operation is not running

100 Cannot create folder

101 Cannot delete folder

102 Cannot delete file

103 Cannot rename folder

104 Cannot rename file

105 Cannot open file

106 Cannot create file

107 Cannot read from file

108 Cannot write to file

109 Cannot rename temporary file

110 Non-supported format

111 Error searching file

112 Wrong checksum

Description

If the error code is negative, the cause is on the remote side.

License Agreement

License for using BigSpeed Voice Chat SDK (hereinafter referred to as this Software) from BigSpeed Computing Inc.

By using the information contained in this document you agree to be and are hereby bound by the terms of this License Agreement. If you do not agree to the terms of this Agreement, do not use the information contained in this document.

BigSpeed Computing grants Licensee the non-exclusive license to use this Software on a single computer at any given time for the sole purpose of developing any number of end user applications, providing that each application adheres to the following conditions:
(a) The application may not compete with this Software.
(b) The application may not expose the functionality of this Software through a programmable interface.

It is forbidden to use the library for the production of developer tools, components or libraries.

There are two licensing options available depending on your needs.

If you have not paid for this Software, you are hereby granted a Freeware License to use the Free Edition as described below.

If you have paid the appropriate fee for this Software, you are hereby granted a Registered license to use the Base/Plus Editions as described below.

You may use the Free Edition of BigSpeed Voice Chat SDK for the purpose of developing end user applications, providing that each application shall only be used for purposes that neither directly nor indirectly have any commercial implications. You may redistribute the binary code of the Free Edition with your completed application. The application MUST acknowledge this Software in a reasonable place (Help file, About box etc).

If this Software is to be used in a commercial product, or incorporated into anything that is to be sold to a third party, then a Registered License must be purchased from BigSpeed Computing.

The Free Edition distribution package may be freely distributed, provided it is not modified in any way. No person or company may charge a fee for the distribution of BigSpeed Voice Chat SDK without written permission from the copyright holder.

You may use the Base/Plus Editions of BigSpeed Voice Chat SDK for the purpose of developing end user commercial applications. A Registered License is issued to a specific company or organization, and entitles that organization to incorporate the binary code of this Software into commercial applications under the Licensee's brand name. There is no restriction on the number of products, or product types, incorporating the library binary code.

If Licensee has purchased a "multi-developer" license, this Software may be used on more than one computer at Licensee's premises by the number of software developers associated with the multi-developer license.

BigSpeed Computing Inc. cannot be held responsible under any circumstances for damages of any character (including, but not limited to, direct or indirect damages resulting from the loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use or inability to use this product.

This software is provided under license on an "AS IS" basis, without warranty of any kind, expressed or implied, including without limitation, implied warranties of merchantability and fitness for a particular purpose. BigSpeed Computing Inc. or any third party involved in the creation, production, or delivery of the program, cannot be held responsible under any circumstances, for any direct or indirect damage, including loss of profits, interruption of business activities, or other, faced by the user of this program, even in the case that BigSpeed Computing Inc. has been advised of such damages.

The user assumes responsibility for the result or performance of the program. BigSpeed Computing Inc. may, at any time, revoke this license by notifying the user of the software. The user may cancel his license to use the product by destroying or erasing all copies of the software.

You acknowledge that this Software licensed hereunder is subject to the Wassenaar Arrangement regulations, and any amendments thereof. You confirm that with respect to this Software, you will not export or re-export it, directly or indirectly, to any countries that are subject to Wassenaar Arrangement export restrictions. You further acknowledge that this software may include technical data subject to export and re-export restrictions imposed by Wassenaar Arrangement.

BigSpeed Voice Chat SDK, including its code, documentation, appearance, structure, and organization is an exclusive product of BigSpeed Computing Inc., who retains the property rights to the software, its copies, modifications, or merged parts.

System requirements

Windows 9x, Me, NT4 or Windows 2000, XP or higher version
Pentium Processor recommended
16 MB RAM; 32 MB RAM under NT4 or Windows 2000 platforms, 128 MB for XP
Any programming language supporting COM automation

(c) BigSpeed Computing Inc. 1998-. Mastering algorithms.