This document specifies functions supported by conaito VoIP Extended SDK Components:

Initialize (ListenPort As Long, CryptographyKey As String) As Boolean

Description:
This method is called to initialize the conaito VoIP control. It requires Port Number to listen for incoming connections and/or data. After initializing, conaito VoIP control starts listening for incoming Connections. It also requires the cryptography key or secret words to decrypt the incoming data and/or Encrypt the outgoing Voice/Text data. BLOW FISH cryptography is used for Encryption/Decryption. Two methods EnableCryptography and DisableCryptography can be used to enable/disable the encryption on outbound Voice Stream and Text Messages. Please see the sample source code for more details.

Parameters:
- Listening Port Number
- CryptographyKey or Secret Words

Return Value:
Non-zero on success, otherwise 0, and a appropriate error code can be retrieved by calling GetObjectError() method.


UnInitialize ()

Description:
To uninitialize the conaito VoIP control, this method can be used.


Connect (ToIP As String, ToPort As Long, UserData As String, TimeOut As Long) As Boolean

Description:
This method is called to send connection request to listening end.

Parameters:
- IP Address of listening end
- Port Number of listening end
- Any text data
- TimeOut to connect in seconds

Return Value:
Non-zero on success, otherwise 0, and a specific error code can be retrieved by calling GetObjectError() method.

Remarks:
This method tries to establish the connection to the remote listening end and the Status Event Codes triggers accordingly.
You can also send any text data along with the connection request and remote end will receive that text data into OnConnectionEvent event.


Disconnect () As Boolean

Description:
Calling this method closes the voice session.

Return Value:
Non-zero on success, otherwise 0, and a specific error code can be retrieved by calling GetObjectError() method.


EnableVoiceActivityDetection (Sensitivity As Long, SilenceDuration As Long) As Boolean

Description:
To enable the VAD (voice activity detection) feature. In this feature, conaito VoIP starts sending
voice digital data only when you speak.

Parameter:
- Mic Sensitivity, any value from 0 to 255.
- Silence Duration in seconds.

Return Value:
Non-zero on success, otherwise 0, and a specific error code can be retrieved by calling GetObjectError() method.

Remarks:
Normally, you can set value 170 for Mic Sensitivity and Silence Duration: 5 seconds.


DisableVoiceActivityDetection ()

Description:
To disable the VAD (voice activity detection) feature.


EnableCryptography () As Boolean

Description:
To enable the Encryption on outgoing Voice Stream and Text data. When this method is called, conaito VoIP component starts encrypting the outbound Voice Stream and Text messages before sending it to the Remote end over the internet.
Remote end receives the encrypted Voice Stream/Text messages and decrypt it using the provided Cryptography key. So on both ends the Cryptography keys must be the same.

BLOW FISH cryptography is used for Encryption/Decryption.


DisableCryptography () As Boolean

Description:
To disable the Cryptography feature on outgoing Voice Stream and Text data. When this method is called, conaito VoIP component stops encrypting the Voice Stream and Text messages and starts sending the plain data to the remote end over the internet.


AddInConf (IP As String, Port As Long, UserData As String, TimeOut As Long) As Boolean

Description:
To add more persons into the conversation, this method can be called.

Parameters:
- IP Address of listening end
- Port Number of listening end
- Any text data
- TimeOut in seconds

Return Value:
Non-zero on success, otherwise 0, and a specific error code can be retrieved by calling GetObjectError() method.

Remarks:
This method tries to the remote listening end into the conversation and the Status Event Codes triggers accordingly.
You can also send any text data along with the add conference request and remote end will receive that text data into OnAddConferenceEvent event.


AcceptAddInConf (IP As String, Port As Long, TimeOut As Long) As Boolean

Description:
This method is used to accept the incoming add conversation request

Parameter:
- Client IP
- Client Port
- Timeout to connect in seconds

Return Value:
Non-zero on success, otherwise 0, and a specific error code can be retrieved by calling GetObjectError() method.


CancelAddInConf (IP As String, Port As Long) As Boolean

Description:
This method is used to cancel the incoming add conversation request.

Parameter:
- Client IP
- Client Port

Return Value:
Non-zero on success, otherwise 0, and a specific error code can be retrieved by calling GetObjectError() method.


StartRecording () As Boolean

Description:
This method is used to start the conversation recording.

Remarks:
conaito VoIP component creates recording tmp file for buffering purposes or to store the digital data. When this method is called, conaito VoIP component starts storing data into the tmp file.


StopRecording () As Boolean

Description:
This method is used to stop the conversation recording.

Remarks:
Call to this method stops storing data into recording tmp file.


ResetRecording () As Boolean

Description:
This method can be call to reset/clear the recording buffer.

Remarks:
Call to this method clears all the saved digital data from the recording tmp file.


SaveRecordingToWaveFile (FileName As String) As Boolean

Description:
To save the recording tmp file voice data into wave (.wav) file this method can be use.

Parameter:
- File name (.wav)

Remarks:
Call to this method save the tmp voice data into wave (.wav) file.


SetSpkVolume (Volume As Long) As Boolean

Description:
To set the Output volume, this method can be called. the value range should between 0 to 255.

Parameter:
- Volume Value between [0 – 255] Range

Return Value:
Non-zero on success, otherwise 0, and a specific error code can be retrieved by calling GetObjectError() method.


GetSpkVolume () As Long

Description:
Call to this method returns the speaker volume value between Range [0 to 255], where
0 = Min Volume
255 = Max Volume

Return Value:
Speaker Volume value on success, otherwise –1 and a specific error code can be retrieved by calling GetObjectError() method.


SetMicVolume (Volume As Long) As Boolean

Description:
Call the method to set the Microphone Volume, the value range should between 0 to 255, where
0 = Min Volume
255 = Max Volume

Parameter:
- Volume Value between [0 – 255] Range

Return Value:
Non-zero on success, otherwise 0, and a specific error code can be retrieved by calling GetObjectError() method.


GetMicVolume () As Long

Description:
Call the method to get the Microphone Volume. Volume value is returned, in the range of [0 to 255], where
0 = Min Volume
255 = Max Volume

Return Value:
Microphone Volume value on success, otherwise –1 and a specific error code can be retrieved by calling GetObjectError() method.


EnableMicBoost () As Boolean

Description:
Call the method to increase the Microphone sensitivity.


DisableMicBoost () As Boolean

Description:
To disable the Mic Boost.


IsMicBoostEnable () As Boolean

Description:
Call the method to get Mic Boost is enabled or disabled.


AcceptIncomingCall (IP As String, Port As Long, TimeOut As Long) As Boolean

Description:
This method is used to accept the incoming connection.

Parameter:
- Client IP
- Client Port
- Timeout to connect in seconds

Return Value:
Non-zero on success, otherwise 0, and a specific error code can be retrieved by calling GetObjectError() method.


CancelIncomingCall (IP As String, Port As Long) As Boolean

Description:
This method is used to ignore the incoming connection.

Parameter:
- Client IP
- Client Port

Return Value:
Non-zero on success, otherwise 0, and a specific error code can be retrieved by calling GetObjectError() method.


SendTxtMsg (TextMsg As String, UserData As String) As Boolean

Description:
To broadcast text message along with any text data to all conference members. You can also send any text data along with the text message and remote end will receive that text data into OnTextEvent event.

Parameter:
- Text Message to broadcast
- Any text data

Return Value:
Non-zero on success, otherwise 0, and a specific error code can be retrieved by calling GetObjectError() method.


SendWhisperTextMsg (TextMsg As String, ToIP As String, ToPort As Long, UserData As String) As Boolean

Description:
To send text message along with any text data to a specific conference member. You can also send any text data along with the text message and remote end will receive that text data into OnWhisperTextEvent event.

Parameter:
- Text Message to Send
- Client IP
- Client Port
- Any text data

Return Value:
Non-zero on success, otherwise 0, and a specific error code can be retrieved by calling GetObjectError() method.


EnableBusyState ()

Description:
Call to this method enables the busy state.

Remarks:
Call to this method changes the current person status to busy. Suppose two people (A & B) are having voice conversation. During the conversation Person B sets his status to busy and then if another Remote Person C, tries to connect to Person B, Person C will get the STATUS CODE: 55, which represents the Person you are connecting to, is Busy.


DisableBusyState ()

Description:
Call to this method, disables the busy state.


EnableNotAvailableState ()

Description:
Call to this method enables the Not-Available state.

Remarks:
Call to this method, change the current Person’s state to UN-AVAILABLE. For example, Person A is listening on a specific port and call to this method will change his status to unavailable, if any Remote Person B connects for voice conversation, the connection will not be established and the Remote Person B will get the STATUS CODE: 56


DisableNotAvailableState ()

Description:
Call to this method, changes the state from UN-AVAILABLE to AVAILABLE.


MuteMic (Mute As Boolean) As Boolean

Description:
To mute the microphone, this method can be called. Muting the Microphone does not affect the Master Mute Control. It simply blocks the outbound voice streaming data.

Parameter:
- Boolean Value 0 or 1

Return Value:
Non-Zero on success, otherwise 0


MuteSpk (Mute As Boolean) As Boolean

Description:
To mute the speaker, this method can be called. Muting the speaker does not affect the Master Mute Control.

Parameter:
- Boolean Value 0 or 1

Return Value:
Non-Zero on success, otherwise 0


GetOutBoundDataRate () As Long

Return Value:
Outbound Bytes per second.


GetInBoundDataRate () As Long

Return Value:
Inbound Bytes per second.


GetOutBoundTotalBytes () As Long

Return Value:
Total Outbound bytes, since the conaito VoIP Object is initialized.


GetInBoundTotalBytes () As Long

Return Value:
Total Inbound bytes, since the conaito VoIP object is initialized.


SetLicenceKey (LicenceKey As String) As Boolean

Description:
Call this method for setting the conaito Licence Key. If you use the Trial Version then set 'EVALUATION'

Parameter:
- License Key Provided by conaito VoIP

Return Value:
Non-zero on success, otherwise 0, and a specific error code can be retrieved by calling GetObjectError() method.

Remarks:
You must pay one-time License fee in order to get the License Key. After getting the License key, you will set it using this method and it will remove the evaluation message box & expiry.


GetObjectError () As Long

Description:
Call this method, to get the error for the last operation that failed.

Return Value:
- Error Code Number




Any Questions?

please check conaito Support Forum or conaito Knowledge Base

Please feel free and contact the conaito Support Team.