IPPhone Class

Properties Methods Events Config Settings Errors

The IPPhone class can be used to implement a software-based phone.

Syntax

IPPhone

Remarks

The IPPhone class can be used to implement a software-based phone utilizing modern Voice over Internet Protocol (VoIP) technology. This softphone is able to perform many different functions of a traditional telephone, such as making and receiving calls, performing blind and attended transfers, placing calls on hold, establishing and joining conferences, and more.

Registration

To begin, the first step is activating, or registering, the class. The Server, Port, User, and Password properties must be set to the appropriate values to register with your SIP server/provider. After these values are set, call Activate. If the class has successfully activated/registered, the Activated event will fire and Active will be set to true. The class will now be able to make/receive phone calls. For example:

component.OnActivated += (o, e) => { Console.WriteLine("Activation Successful"); }; component.User = "sip_user"; component.Password = "sip_password"; component.Server = "sip_server"; component.Port = 5060 // Default, 5061 is typical for SSL/TLS component.Activate(); Additionally, it's important to note that the registration of a SIP client will expire if not refreshed. The expiration time is negotiated with the server when registering. By default, the class will attempt to negotiate a value of 60 seconds. This value can be changed via the RegistrationInterval configuration. Note this is merely a suggestion to the server, and the server can change this accordingly. If the server does change this, RegistrationInterval will be updated after successful registration. By default, the class will attempt to refresh the registration every RegistrationInterval seconds.

Clients may wish to refresh the registration a few seconds prior to this interval to ensure the registration does not expire. To do so, the RefreshInterval configuration can be set after successful registration. If set, this value should be less than or equal to RegistrationInterval. For example, to refresh the registration 5 seconds prior to it's expiration, the following can be performed after activation:

component.Activate(); int lifetime = component.Config("RegistrationInterval"); // Refresh the registration 5 seconds prior to expiration component.Config("RefreshInterval=" + (lifetime - 5));

To prevent the registration from expiring, the class will refresh the registration within DoEvents according to the value of RegistrationInterval or RefreshInterval. To ensure this occurs, we recommend calling DoEvents frequently. For example, this could look something like:

private void timer1_Tick(object sender, EventArgs e) { component.DoEvents(); } private System.Windows.Forms.Timer timer1; timer1.Interval = 1000; timer1.Tick += new System.EventHandler(this.timer1_Tick); timer1.Enabled = true;

Note the above solution does not apply to console applications, as DoEvents should already be called in a loop to provide efficient message processing.

Security

By default, the class operates in plaintext for both SIP signaling and RTP (audio) communication. To enable completely secure communication using the class, both SIPS (Secure SIP) and SRTP (Secure RTP) must be enabled.

Enable SIPS

To enable SIPS (Secure SIP, or SIP over SSL/TLS), the SIPTransportProtocol property must be set to 2 (TLS). The Port property will typically need to be set to 5061 (this may vary). Additionally, the SSLServerAuthentication event must be handled, allowing users to check the server identity and other security attributes related to server authentication. Once this is complete, the class can then be activated. All subsequent SIP signaling will now be secured. For example:

component.OnSSLServerAuthentication += (o, e) => { if (!e.Accept) { if (e.CertSubject == "SIPS_SAMPLE_SUBJECT" && e.CertIssuer == "SIPS_CERT_ISSUER") { e.Accept = true; } } }; // Enable SIPS component.SIPTransportProtocol = 2; // TLS component.User = "sip_user"; component.Password = "sip_password"; component.Server = "sip_server"; component.Port = 5061; // 5061 is typical for SSL/TLS component.Activate();

Information related to the SSL/TLS handshake will be available within the SSLStatus event with the prefix [SIP TLS].

Enable SRTP

While the above process secures SIP signaling, it does not secure RTP (audio) communication. The RTPSecurityMode property can be used to specify the security mode that will be used when transmitting RTP packets. By default, this property is 0 (None), and RTP packets will remain unencrypted during communication with the remote party.

To ensure the audio data is encrypted and SRTP is enabled, the RTPSecurityMode must be set to either of the following modes: 1 (SDES), or 2 (DTLS-SRTP). The selected mode will be used to securely derive a key used to encrypt and decrypt RTP packets, enabling secure audio communication with the remote party. The appropriate mode to use may depend on the service provider and configuration of a particular User. For example:

component.OnSSLServerAuthentication += (o, e) => { if (!e.Accept) { if (e.CertSubject == "SIPS_SAMPLE_SUBJECT" && e.CertIssuer == "SIPS_CERT_ISSUER") { e.Accept = true; } } }; component.RTPSecurityMode = 1; // Enable SRTP (SDES) //component.RTPSecurityMode = 2; // Enable SRTP (DTLS-SRTP) component.SIPTransportProtocol = 2; // TLS component.User = "sip_user"; component.Password = "sip_password"; component.Server = "sip_server"; component.Port = 5061; // 5061 is typical for SSL/TLS component.Activate(); component.Dial("123456789", "", true);

Note it is highly recommended that SIPTransportProtocol is set to TLS when enabling SRTP. Additionally, if SRTP is enabled, the remote party must support the selected mode, otherwise no call will be established.

Audio Setup

While not required to function, you may set the microphone and speaker for the class to use during calls. First, you must call ListMicrophones and ListSpeakers. Doing so will populate the Microphones collection and the Speakers collection. Once this is done, you can set these devices via SetMicrophone and SetSpeaker given their device name. For example:

ipphone1.ListMicrophones(); ipphone1.ListSpeakers(); foreach (Speaker s in ipphone1.Speakers) { Console.WriteLine("Speaker Name: " + s.Name); } foreach (Microphone m in ipphone1.Microphones) { Console.WriteLine("Microphone Name: " + m.Name); } ipphone1.SetSpeaker(ipphone1.Speakers[0].Name); ipphone1.SetMicrophone(ipphone1.Microphones[0].Name);

Managing Calls

All incoming and outgoing calls currently recognized by the class will be stored in the Calls collection. These connections will be initiated or accepted through the interface identified by LocalHost and LocalPort.

Incoming Calls

After successful activation, incoming calls will be detected, and IncomingCall will fire for each call. Within this event, Answer, Decline, or Forward can be used to handle these calls. For example:

ipphone1.OnIncomingCall += (o, e) => { ipphone1.Answer(e.CallId); };

Outgoing Calls

To make an outgoing call, you must use Dial. This method takes three parameters: the user you wish to call, your caller ID (optional), and a boolean that determines whether the method will connect synchronously (True) or asynchronously (False). If set, the second parameter will cause P-Asserted-Identity headers (RFC 3325) to be sent in requests to the server. If left as an empty string, this header will not be sent. Dial will return a call identification string (CallId) that is unique to the call. After the method returns successfully, the call will be added to the Calls collection.

Please see the method description for detailed examples on using Dial synchronously and asynchronously.

Transferring Calls

Ongoing calls can be transferred using Transfer. The class supports two types of transfers:

Basic (Blind) Transfers

Basic transfers are very simple to perform. First, the user establishes a call with the number they will be transferring (transferee). After the call is established, the user can transfer the call to the appropriate number (transfer target). The call will then be removed. For example:

string callId = ipphone1.Dial("123456789", "", true); // Establish call with transferee, hold if needed //ipphone1.Hold(callId); ipphone1.Transfer(callId, "number");

Attended Transfers

Typically, attended transfers are used to manually check if the "number" they are transferring to (transfer target) is available for a call, provide extra information about the call, etc., before transferring. In addition to establishing a call with the transferee, the class must also establish a call with the transfer target. Once both calls are active, you may perform an attended transfer by calling Transfer at any moment. Afterwards, a session will be established between both calls, and they will be removed. Note that Transfer must be used with the CallId of the call you wish to transfer (transferee) and the Number of the call you wish to transfer to (transfer target). For example:

string callId1 = ipphone1.Dial("123456789", "", true); // Establish call with Transferee, hold if needed //ipphone1.Hold(callId1); string callId2 = ipphone1.Dial("number", "", true); // Establish call with Transfer Target, hold if needed //ipphone1.Hold(callId2); ipphone1.Transfer(callId1, "number");

Note in these examples, Hold can be used to place a call on hold before a transfer. This is optional.

Audio Playback

The class supports three methods of playing audio to a call, being PlayFile, PlayText, or PlayBytes. Note for each of these methods, audio transmission will only occur when the call has connected and CallReady has fired. Additionally, only audio data with a sampling rate of 8 kHz and a bit depth of 16 bits per sample can be played (PCM 8 kHz 16-bit format). Also note that these methods are non-blocking, and will return immediately. The class can also handle playing audio to concurrent calls.

PlayFile can be used to play audio from a WAV file to a specific call. PlayText can also be used to play audio, but will do so using Text-to-Speech. Once audio has finished playing, Played will fire.

PlayBytes can be used to play audio, but will do so in an event-based manner. The behavior of PlayBytes is very different from the previous two methods. For a detailed description on how to use this method with the Played event, please see the method and event descriptions.

Recording Audio

Ongoing calls can be recorded using StartRecording. The audio can be recorded directly to a WAV file by specifying the Filename parameter. Additionally, if the Filename parameter is not specified, the audio will be recorded internally, and made available once the recording is finished. The recorded data will be available within the Record event.

Note in both scenarios, the recording will end either when the call is terminated, or StopRecording is called. The recorded audio will have a sampling rate of 8 kHz and a bit depth of 16 bits per sample (PCM 8 kHz 16-bit format).

Example: Using the 'Record' event

MemoryStream recordStream = new MemoryStream(); phone.StartRecording("CallId", ""); phone.OnRecord += (o, e) => { recordStream.Write(e.RecordedDataB, 0, e.RecordedDataB.Length); File.WriteAllBytes(recordFile, recordStream.ToArray()); };

Conferencing

The class also supports conferencing. A call can join a conference using the JoinConference method, passing in the CallId of the call and the custom ConferenceId. If the ConferenceId does not exist, then a new conference will be created given this ID. Other calls can then join the existing conference with this same ID.

To monitor existing conferences, the ListConferences method will return a string containing all ongoing conferences and calls within each conference. This value will have the following format:

ConferenceId_1: CallId_1, CallId_2

...

ConferenceId_n: CallId_3, CallId_4, CallId_5, ...

At any moment, a call can be removed from a conference using LeaveConference. If the user is the last call within the conference, then the conference will be removed.

Call Termination

Ongoing calls are terminated by passing the appropriate CallId to Hangup. All ongoing calls can be terminated with HangupAll. When a call has been terminated (by either party), CallTerminated will fire. It's important to note that in the case where an outgoing call is never answered, the class will attempt to leave a voicemail. The voicemail will end once Hangup or HangupAll is called, and CallTerminated will fire.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


Active	The current activation status of the class.
Calls	A collection of calls.
LocalHost	This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds.
Microphones	A collection of microphones.
Password	The password that is used when connecting to the SIP Server.
Port	The port on the SIP server the class is connecting to.
RTPSecurityMode	Specifies the security mode that will be used when transmitting RTP.
Server	The address of the SIP Server.
SIPTransportProtocol	Specifies the transport protocol the class will use for SIP signaling.
Speakers	A collection of speakers.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
User	The username that is used when connecting to the SIP Server.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


Activate	Activates the class.
Answer	Answers an incoming phone call.
Config	Sets or retrieves a configuration setting.
Deactivate	Deactivates the class.
Decline	Declines an incoming phone call.
Dial	Used to make a call.
DoEvents	This method processes events from the internal message queue.
Forward	Used to forward an incoming call.
Hangup	Used to hang up a specific call.
HangupAll	Used to hang up all calls.
Hold	Places a call on hold.
JoinConference	Adds a call to a conference call.
LeaveConference	Removes a call from a conference call.
ListConferences	Lists ongoing conference calls.
ListMicrophones	Lists all microphones detected on the system.
ListSpeakers	Lists all speakers detected on the system.
MuteMicrophone	Used to mute or unmute the microphone for a specified call.
MuteSpeaker	Used to mute or unmute the speaker for a specified call.
Ping	Used to ping the server.
PlayBytes	This method is used to play bytes to a call.
PlayFile	Plays audio from a WAV file to a call.
PlayText	Plays audio from a string to a call using Text-to-Speech.
Reset	This method will reset the class.
SetMicrophone	Sets the microphone used by the class.
SetSpeaker	Sets the speaker used by the class.
StartRecording	Used to start recording the audio of a call.
StopPlaying	Stops audio from playing to a call.
StopRecording	Stops recording the audio of a call.
Transfer	Transfers a call.
TypeDigit	Used to type a digit.
Unhold	Takes a call off hold.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


Activated	This event is fired immediately after the class is activated.
CallReady	This event is fired after a call has been answered, declined, or ignored.
CallStateChanged	This event is fired after a call's state has changed.
CallTerminated	This event is fired after a call has been terminated.
Deactivated	This event is fired immediately after the class is deactivated.
DialCompleted	This event is fired after the dial process has finished.
Digit	This event fires every time a digit is pressed using the keypad.
Error	Fired when information is available about errors during data delivery.
IncomingCall	This event is fired when an incoming call is received.
Log	This event is fired once for each log message.
OutgoingCall	This event is fired when an outgoing call has been made.
Played	This event is fired after the class finishes playing available audio.
Record	This event is fired when recorded audio data is available.
Silence	This event is fired when the class detects silence from incoming audio streams.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.


AudioDirection	Indicates the direction of available recorded audio when dynamic recording is enabled.
AuthUser	Specifies the username to be used during client authentication.
Codecs	Comma-separated list of codecs the class can use.
DeclineStatus	Specifies the status to send when declining an incoming call.
DialTimeout	Specifies the amount of time to wait for a response when making a call.
DialToneFile	Specifies the location of the WAV file to play when making a call.
DisableRegistration	Can be used to disable SIP registration.
Domain	Can be used to set the address of the SIP domain.
DtmfMethod	The method used for delivering the signals/tones sent when typing a digit.
EnableDynamicRecording	Specifies whether dynamic recording is enabled when recording a call.
LogEncodedAudioData	Whether the class will log encoded audio data.
LogLevel	The level of detail that is logged.
LogRTPPackets	Whether the class will log RTP packets.
RecordType	The type of recording the class will use.
RedirectLimit	The maximum number of redirects an outgoing call can experience.
RefreshInterval	Used to manually specify the interval between subsequent registration messages after successful activation.
RegistrationInterval	Specifies the lifetime of the current registration.
RingtoneFile	Specifies location of a WAV file to play when receiving an incoming call.
SilenceInterval	Specifies the interval the class uses to detect periods of silence.
STUNPort	The port of the STUN server.
STUNServer	The address of the STUN Server.
UnregisterOnActivate	Specifies whether the class will unregister from the SIP Server before registration.
VoiceIndex	The voice that will be used when playing text.
VoiceRate	The speaking rate of the voice when playing text.
CaptureIPPacketInfo	Used to capture the packet information.
DelayHostResolution	Whether the hostname is resolved when RemoteHost is set.
DestinationAddress	Used to get the destination address from the packet information.
DontFragment	Used to set the Don't Fragment flag of outgoing packets.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxPacketSize	The maximum length of the packets that can be received.
QOSDSCPValue	Used to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficType	Used to specify QOS/DSCP settings (optional).
ShareLocalPort	If set to True, allows more than one instance of the class to be active on the same local port.
SourceIPAddress	Used to set the source IP address used when sending a packet.
SourceMacAddress	Used to set the source MAC address used when sending a packet.
UseConnection	Determines whether to use a connected socket.
UseIPv6	Whether or not to use IPv6.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificate to be included when performing an SSL handshake.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

Active Property (IPPhone Class)

The current activation status of the class.

Syntax

ANSI (Cross Platform)
int GetActive();

Unicode (Windows)
BOOL GetActive();

int ipworksvoip_ipphone_getactive(void* lpObj);

bool GetActive();

Default Value

FALSE

Remarks

This property indicates the activation status of the class. Active will be True if the class has been successfully activated (registered) with the SIP Server, and False otherwise. If False, the class is not registered and will not be able to make or receive calls.

The class can be activated via Activate and deactivated through Deactivate.

This property is read-only and not available at design time.

Data Type

Boolean

Calls Property (IPPhone Class)

A collection of calls.

Syntax

IPWorksVoIPList<IPWorksVoIPCall>* GetCalls();

int ipworksvoip_ipphone_getcallcount(void* lpObj);

char* ipworksvoip_ipphone_getcallcallid(void* lpObj, int callindex);

char* ipworksvoip_ipphone_getcallconferenceid(void* lpObj, int callindex);

int ipworksvoip_ipphone_getcallduration(void* lpObj, int callindex);

int ipworksvoip_ipphone_getcalllaststatus(void* lpObj, int callindex);

char* ipworksvoip_ipphone_getcalllocaladdress(void* lpObj, int callindex);

int ipworksvoip_ipphone_getcalllocalport(void* lpObj, int callindex);

char* ipworksvoip_ipphone_getcallmicrophone(void* lpObj, int callindex);

int ipworksvoip_ipphone_getcallmutemicrophone(void* lpObj, int callindex);
int ipworksvoip_ipphone_setcallmutemicrophone(void* lpObj, int callindex, int bCallMuteMicrophone);

int ipworksvoip_ipphone_getcallmutespeaker(void* lpObj, int callindex);
int ipworksvoip_ipphone_setcallmutespeaker(void* lpObj, int callindex, int bCallMuteSpeaker);

int ipworksvoip_ipphone_getcalloutgoing(void* lpObj, int callindex);

int ipworksvoip_ipphone_getcallplaying(void* lpObj, int callindex);

int ipworksvoip_ipphone_getcallrecording(void* lpObj, int callindex);

char* ipworksvoip_ipphone_getcallremoteaddress(void* lpObj, int callindex);

int ipworksvoip_ipphone_getcallremoteport(void* lpObj, int callindex);

char* ipworksvoip_ipphone_getcallremoteuri(void* lpObj, int callindex);

char* ipworksvoip_ipphone_getcallremoteuser(void* lpObj, int callindex);

char* ipworksvoip_ipphone_getcallspeaker(void* lpObj, int callindex);

int64 ipworksvoip_ipphone_getcallstartedat(void* lpObj, int callindex);

int ipworksvoip_ipphone_getcallstate(void* lpObj, int callindex);

char* ipworksvoip_ipphone_getcalluserinput(void* lpObj, int callindex);

char* ipworksvoip_ipphone_getcallvia(void* lpObj, int callindex);

int GetCallCount();

QString GetCallCallId(int iCallIndex);

QString GetCallConferenceId(int iCallIndex);

int GetCallDuration(int iCallIndex);

int GetCallLastStatus(int iCallIndex);

QString GetCallLocalAddress(int iCallIndex);

int GetCallLocalPort(int iCallIndex);

QString GetCallMicrophone(int iCallIndex);

bool GetCallMuteMicrophone(int iCallIndex);
int SetCallMuteMicrophone(int iCallIndex, bool bCallMuteMicrophone);

bool GetCallMuteSpeaker(int iCallIndex);
int SetCallMuteSpeaker(int iCallIndex, bool bCallMuteSpeaker);

bool GetCallOutgoing(int iCallIndex);

bool GetCallPlaying(int iCallIndex);

bool GetCallRecording(int iCallIndex);

QString GetCallRemoteAddress(int iCallIndex);

int GetCallRemotePort(int iCallIndex);

QString GetCallRemoteURI(int iCallIndex);

QString GetCallRemoteUser(int iCallIndex);

QString GetCallSpeaker(int iCallIndex);

qint64 GetCallStartedAt(int iCallIndex);

int GetCallState(int iCallIndex);

QString GetCallUserInput(int iCallIndex);

QString GetCallVia(int iCallIndex);

Remarks

This collection holds data for each incoming and outgoing Call recognized by the class.

This property is read-only and not available at design time.

Data Type

IPWorksVoIPCall

LocalHost Property (IPPhone Class)

This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksvoip_ipphone_getlocalhost(void* lpObj);
int ipworksvoip_ipphone_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (IPPhone Class)

This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds.

Syntax

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int ipworksvoip_ipphone_getlocalport(void* lpObj);
int ipworksvoip_ipphone_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

Remarks

The LocalPort property must be set before UDP is activated (Active is set to True). This instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting it to 0 (default) enables the Transmission Control Protocol (TCP)/IP stack to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established.

LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class is Active will generate an error.

The LocalPort property is useful when trying to connect to services that require a trusted port on the client side.

Data Type

Integer

Microphones Property (IPPhone Class)

A collection of microphones.

Syntax

IPWorksVoIPList<IPWorksVoIPMicrophone>* GetMicrophones();

int ipworksvoip_ipphone_getmicrophonecount(void* lpObj);

int ipworksvoip_ipphone_getmicrophonechannels(void* lpObj, int microphoneindex);

int ipworksvoip_ipphone_getmicrophonemanufacturerid(void* lpObj, int microphoneindex);

char* ipworksvoip_ipphone_getmicrophonename(void* lpObj, int microphoneindex);

int ipworksvoip_ipphone_getmicrophoneproductid(void* lpObj, int microphoneindex);

int ipworksvoip_ipphone_getmicrophonesupport(void* lpObj, int microphoneindex);

int ipworksvoip_ipphone_getmicrophonesupportedformats(void* lpObj, int microphoneindex);

int GetMicrophoneCount();

int GetMicrophoneChannels(int iMicrophoneIndex);

int GetMicrophoneManufacturerId(int iMicrophoneIndex);

QString GetMicrophoneName(int iMicrophoneIndex);

int GetMicrophoneProductId(int iMicrophoneIndex);

int GetMicrophoneSupport(int iMicrophoneIndex);

int GetMicrophoneSupportedFormats(int iMicrophoneIndex);

Remarks

This collection holds data for each Microphone detected on the system. Calling ListMicrophones will populate this collection.

This property is read-only and not available at design time.

Data Type

IPWorksVoIPMicrophone

Password Property (IPPhone Class)

The password that is used when connecting to the SIP Server.

Syntax

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworksvoip_ipphone_getpassword(void* lpObj);
int ipworksvoip_ipphone_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

Remarks

This property contains the password of the client attempting to connect to the SIP Server. This value will be used when activating the class via Activate.

This property is not available at design time.

Data Type

String

Port Property (IPPhone Class)

The port on the SIP server the class is connecting to.

Syntax

ANSI (Cross Platform)
int GetPort();
int SetPort(int iPort);

Unicode (Windows)
INT GetPort();
INT SetPort(INT iPort);

int ipworksvoip_ipphone_getport(void* lpObj);
int ipworksvoip_ipphone_setport(void* lpObj, int iPort);

int GetPort();
int SetPort(int iPort);

Default Value

5060

Remarks

This property specifies the port on the SIP server that the class will connect to. This value will be used when activating the class via Activate.

Data Type

Integer

RTPSecurityMode Property (IPPhone Class)

Specifies the security mode that will be used when transmitting RTP.

Syntax

ANSI (Cross Platform)
int GetRTPSecurityMode();
int SetRTPSecurityMode(int iRTPSecurityMode);

Unicode (Windows)
INT GetRTPSecurityMode();
INT SetRTPSecurityMode(INT iRTPSecurityMode);

Possible Values

ET_NONE(0), 
ET_SDES(1), 
ET_DTLS(2)

int ipworksvoip_ipphone_getrtpsecuritymode(void* lpObj);
int ipworksvoip_ipphone_setrtpsecuritymode(void* lpObj, int iRTPSecurityMode);

int GetRTPSecurityMode();
int SetRTPSecurityMode(int iRTPSecurityMode);

Default Value

Remarks

This property is used to specify the security mode that will be used when transmitting RTP (audio data). Possible modes are:


0 (None)	SRTP is disabled.
1 (SDES)	SRTP is enabled, utilizing SDES.
2 (DTLS)	SRTP is enabled, utilizing DTLS (DTLS-SRTP).

By default, the security mode will be 0 (None), and RTP packets will remain unencrypted during communication with the remote party. To enable SRTP (Secure RTP), the security mode must be set to either: 1 (SDES), or 2 (DTLS).

When SRTP is enabled, the selected mode will be used to securely derive a key used to encrypt and decrypt RTP packets, enabling secure audio communication with the remote party. The appropriate mode to use may depend on the service provider and configuration of a particular User. Additionally, if SRTP is enabled, the remote party must support the selected mode, otherwise no call will be established.

Note it is highly recommended that SIPTransportProtocol is set to TLS when enabling SRTP.

Data Type

Integer

Server Property (IPPhone Class)

The address of the SIP Server.

Syntax

ANSI (Cross Platform)
char* GetServer();
int SetServer(const char* lpszServer);

Unicode (Windows)
LPWSTR GetServer();
INT SetServer(LPCWSTR lpszServer);

char* ipworksvoip_ipphone_getserver(void* lpObj);
int ipworksvoip_ipphone_setserver(void* lpObj, const char* lpszServer);

QString GetServer();
int SetServer(QString qsServer);

Default Value

Remarks

This property contains the address of the SIP Server the class will attempt to connect to. This value will be used when activating the class via Activate.

Data Type

String

SIPTransportProtocol Property (IPPhone Class)

Specifies the transport protocol the class will use for SIP signaling.

Syntax

ANSI (Cross Platform)
int GetSIPTransportProtocol();
int SetSIPTransportProtocol(int iSIPTransportProtocol);

Unicode (Windows)
INT GetSIPTransportProtocol();
INT SetSIPTransportProtocol(INT iSIPTransportProtocol);

Possible Values

TP_UDP(0), 
TP_TCP(1), 
TP_TLS(2)

int ipworksvoip_ipphone_getsiptransportprotocol(void* lpObj);
int ipworksvoip_ipphone_setsiptransportprotocol(void* lpObj, int iSIPTransportProtocol);

int GetSIPTransportProtocol();
int SetSIPTransportProtocol(int iSIPTransportProtocol);

Default Value

Remarks

This property specifies which transport protocol (UDP, TCP, TLS) the class will use for SIP signaling and can be used to enable SIPS (Secure SIP). Note it is important to set the SIPTransportProtocol property before setting any additional properties and configurations.

This value is 0 (UDP) by default. Possible values are:


0 (UDP - Default)	Signaling will be performed over UDP (plaintext).
1 (TCP)	Signaling will be performed over TCP (plaintext).
2 (TLS)	Signaling will be performed using TLS over TCP (SIPS).

Note when TLS is specified, the Port will typically need to be set to 5061.

Data Type

Integer

Speakers Property (IPPhone Class)

A collection of speakers.

Syntax

IPWorksVoIPList<IPWorksVoIPSpeaker>* GetSpeakers();

int ipworksvoip_ipphone_getspeakercount(void* lpObj);

int ipworksvoip_ipphone_getspeakerchannels(void* lpObj, int speakerindex);

int ipworksvoip_ipphone_getspeakermanufacturerid(void* lpObj, int speakerindex);

char* ipworksvoip_ipphone_getspeakername(void* lpObj, int speakerindex);

int ipworksvoip_ipphone_getspeakerproductid(void* lpObj, int speakerindex);

int ipworksvoip_ipphone_getspeakersupport(void* lpObj, int speakerindex);

int ipworksvoip_ipphone_getspeakersupportedformats(void* lpObj, int speakerindex);

int GetSpeakerCount();

int GetSpeakerChannels(int iSpeakerIndex);

int GetSpeakerManufacturerId(int iSpeakerIndex);

QString GetSpeakerName(int iSpeakerIndex);

int GetSpeakerProductId(int iSpeakerIndex);

int GetSpeakerSupport(int iSpeakerIndex);

int GetSpeakerSupportedFormats(int iSpeakerIndex);

Remarks

This collection holds data for each Speaker detected on the system. Calling ListSpeakers will populate this collection.

This property is read-only and not available at design time.

Data Type

IPWorksVoIPSpeaker

SSLAcceptServerCert Property (IPPhone Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

IPWorksVoIPCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksVoIPCertificate* val);

char* ipworksvoip_ipphone_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertissuer(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertprivatekey(void* lpObj);

int ipworksvoip_ipphone_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertpublickey(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksvoip_ipphone_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksvoip_ipphone_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksvoip_ipphone_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksvoip_ipphone_getsslacceptservercertstorepassword(void* lpObj);
int ipworksvoip_ipphone_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksvoip_ipphone_getsslacceptservercertstoretype(void* lpObj);
int ipworksvoip_ipphone_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksvoip_ipphone_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertusage(void* lpObj);

int ipworksvoip_ipphone_getsslacceptservercertusageflags(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertversion(void* lpObj);

char* ipworksvoip_ipphone_getsslacceptservercertsubject(void* lpObj);
int ipworksvoip_ipphone_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksvoip_ipphone_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksvoip_ipphone_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

This property is not available at design time.

Data Type

IPWorksVoIPCertificate

SSLCert Property (IPPhone Class)

The certificate to be used during SSL negotiation.

Syntax

IPWorksVoIPCertificate* GetSSLCert();
int SetSSLCert(IPWorksVoIPCertificate* val);

char* ipworksvoip_ipphone_getsslcerteffectivedate(void* lpObj);

char* ipworksvoip_ipphone_getsslcertexpirationdate(void* lpObj);

char* ipworksvoip_ipphone_getsslcertextendedkeyusage(void* lpObj);

char* ipworksvoip_ipphone_getsslcertfingerprint(void* lpObj);

char* ipworksvoip_ipphone_getsslcertfingerprintsha1(void* lpObj);

char* ipworksvoip_ipphone_getsslcertfingerprintsha256(void* lpObj);

char* ipworksvoip_ipphone_getsslcertissuer(void* lpObj);

char* ipworksvoip_ipphone_getsslcertprivatekey(void* lpObj);

int ipworksvoip_ipphone_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksvoip_ipphone_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksvoip_ipphone_getsslcertpublickey(void* lpObj);

char* ipworksvoip_ipphone_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksvoip_ipphone_getsslcertpublickeylength(void* lpObj);

char* ipworksvoip_ipphone_getsslcertserialnumber(void* lpObj);

char* ipworksvoip_ipphone_getsslcertsignaturealgorithm(void* lpObj);

int ipworksvoip_ipphone_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksvoip_ipphone_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksvoip_ipphone_getsslcertstorepassword(void* lpObj);
int ipworksvoip_ipphone_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksvoip_ipphone_getsslcertstoretype(void* lpObj);
int ipworksvoip_ipphone_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksvoip_ipphone_getsslcertsubjectaltnames(void* lpObj);

char* ipworksvoip_ipphone_getsslcertthumbprintmd5(void* lpObj);

char* ipworksvoip_ipphone_getsslcertthumbprintsha1(void* lpObj);

char* ipworksvoip_ipphone_getsslcertthumbprintsha256(void* lpObj);

char* ipworksvoip_ipphone_getsslcertusage(void* lpObj);

int ipworksvoip_ipphone_getsslcertusageflags(void* lpObj);

char* ipworksvoip_ipphone_getsslcertversion(void* lpObj);

char* ipworksvoip_ipphone_getsslcertsubject(void* lpObj);
int ipworksvoip_ipphone_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksvoip_ipphone_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksvoip_ipphone_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

This property is not available at design time.

Data Type

IPWorksVoIPCertificate

User Property (IPPhone Class)

The username that is used when connecting to the SIP Server.

Syntax

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworksvoip_ipphone_getuser(void* lpObj);
int ipworksvoip_ipphone_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

Default Value

Remarks

This property contains the username of the client attempting to connect to the SIP Server. This value will be used when activating the class via Activate.

This property is not available at design time.

Data Type

String

Activate Method (IPPhone Class)

Activates the class.

Syntax

ANSI (Cross Platform)
int Activate();

Unicode (Windows)
INT Activate();

int ipworksvoip_ipphone_activate(void* lpObj);

int Activate();

Remarks

This method is used to activate the class by registering to a SIP Server specified in the Server and Port properties. The username and password of the SIP Server must be provided via User and Password properties for authorization, if applicable.

Example: ipphone.User = "MyUsername"; ipphone.Password = "MyPassword"; ipphone.Server = "HostNameOrIP"; ipphone.Port = 5060; ipphone.Activate(); Upon successful activation, the Activated event will fire.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Answer Method (IPPhone Class)

Answers an incoming phone call.

Syntax

ANSI (Cross Platform)
int Answer(const char* lpszcallId);

Unicode (Windows)
INT Answer(LPCWSTR lpszcallId);

int ipworksvoip_ipphone_answer(void* lpObj, const char* lpszcallId);

int Answer(const QString& qscallId);

Remarks

This method can be used to answer an incoming phone call, specified by CallId. This method can be used in conjunction with the IncomingCall event, for example: ipphone.onIncomingCall += (sender, e) => { ipphone.Answer(e.CallId); }; If successful, CallReady will fire.

Error Handling (C++)

Config Method (IPPhone Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksvoip_ipphone_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Deactivate Method (IPPhone Class)

Deactivates the class.

Syntax

ANSI (Cross Platform)
int Deactivate();

Unicode (Windows)
INT Deactivate();

int ipworksvoip_ipphone_deactivate(void* lpObj);

int Deactivate();

Remarks

This method is used to unregister the class from the SIP Server. If deactivation is successful, Deactivated will fire.

Error Handling (C++)

Decline Method (IPPhone Class)

Declines an incoming phone call.

Syntax

ANSI (Cross Platform)
int Decline(const char* lpszcallId);

Unicode (Windows)
INT Decline(LPCWSTR lpszcallId);

int ipworksvoip_ipphone_decline(void* lpObj, const char* lpszcallId);

int Decline(const QString& qscallId);

Remarks

This method can be used to decline an incoming phone call, specified by CallId. This method can be used in conjunction with the IncomingCall event, for example: ipphone.onIncomingCall += (sender, e) => { ipphone.Decline(e.CallId); };

Error Handling (C++)

Dial Method (IPPhone Class)

Used to make a call.

Syntax

ANSI (Cross Platform)
char* Dial(const char* lpsznumber, const char* lpszcallerNumber, int bwait);

Unicode (Windows)
LPWSTR Dial(LPCWSTR lpsznumber, LPCWSTR lpszcallerNumber, BOOL bwait);

char* ipworksvoip_ipphone_dial(void* lpObj, const char* lpsznumber, const char* lpszcallerNumber, int bwait);

QString Dial(const QString& qsnumber, const QString& qscallerNumber, bool bwait);

Remarks

This method is used to make a call to a particular user, given by Number. This method should only be called after the class has been successfully activated via Activate. Initially, the OutgoingCall event will fire after calling this method. DialCompleted may fire when the dial process is complete. If successful, CallReady will fire after the outgoing call has been answered, declined, or ignored. If the call is declined or ignored, the class will be sent to voicemail, which can be ended with Hangup.

The CallerNumber parameter specifies the optional caller ID. If given, the P-Asserted-Identity Header, specified in RFC 3325, will be sent in requests to the connected SIP Server. If left as an empty string, this header will not be sent.

The Wait parameter specifies whether the class should connect synchronously or asynchronously to the call. If True, the class will connect synchronously, and won't return until the call has been answered, declined, or ignored. If False, the class will connect asynchronously. The call's status can be checked through various events, such as OutgoingCall, CallReady, and CallStateChanged, or found in the call's State field. Exceptions throughout the call process will be reported in DialCompleted, along with other call details.

NOTE: This method will return the CallId field of the call. This returned value may not always reflect the accurate CallId. In the case that Wait is true, this method will always return the accurate value. In the case that Wait is false, the returned value may not be accurate if the outgoing call is forwarded, or redirected, as the class must change this field. Both the updated and original CallId will be present within the DialCompleted event. Any references to the original CallId must be updated accordingly. Please see DialCompleted for more details. The below examples assume the outgoing call has been answered:

Example: "wait" is true string callId = ""; bool connected = false; ipphone.OnCallReady += (sender, e) => { connected = true; } try { callId = ipphone.Dial("123456789", "", true); } catch (IPWorksVoIPException e) { MessageBox.Show(e.Code + ": " + e.Message); } if (connected) { ipphone.PlayText(callId, "Hello"); } Example: "wait" is false bool connected = false; string callId = ""; ipphone.OnDialCompleted += (sender, e) => { if (e.ErrorCode != 0) { MessageBox.Show(e.ErrorCode + ": " + e.Description); // Handle error } if (e.OriginalCallId != e.CallId) { callId = e.CallId; // Update callId if redirect occurred } } ipphone.OnCallReady += (sender, e) => { connected = true; } string callId = ipphone.Dial("123456789", "", false); ... ... ... // Somewhere else... if (connected) { ipphone.PlayText(callId, "Hello"); }

Error Handling (C++)

DoEvents Method (IPPhone Class)

This method processes events from the internal message queue.

Syntax

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksvoip_ipphone_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

Forward Method (IPPhone Class)

Used to forward an incoming call.

Syntax

ANSI (Cross Platform)
int Forward(const char* lpszcallId, const char* lpsznumber);

Unicode (Windows)
INT Forward(LPCWSTR lpszcallId, LPCWSTR lpsznumber);

int ipworksvoip_ipphone_forward(void* lpObj, const char* lpszcallId, const char* lpsznumber);

int Forward(const QString& qscallId, const QString& qsnumber);

Remarks

This method can be used to implement call forwarding, allowing incoming calls, given by CallId to be forwarded to a particular user specified by Number. This method can be used in conjunction with the IncomingCall event, for example: ipphone.onIncomingCall += (sender, e) => { ipphone.Forward(e.CallId, "123456789"); };

Error Handling (C++)

Hangup Method (IPPhone Class)

Used to hang up a specific call.

Syntax

ANSI (Cross Platform)
int Hangup(const char* lpszcallId);

Unicode (Windows)
INT Hangup(LPCWSTR lpszcallId);

int ipworksvoip_ipphone_hangup(void* lpObj, const char* lpszcallId);

int Hangup(const QString& qscallId);

Remarks

This method is used to terminate a specific call, specified by CallId. After the call has been successfully terminated, CallTerminated will fire.

Error Handling (C++)

HangupAll Method (IPPhone Class)

Used to hang up all calls.

Syntax

ANSI (Cross Platform)
int HangupAll();

Unicode (Windows)
INT HangupAll();

int ipworksvoip_ipphone_hangupall(void* lpObj);

int HangupAll();

Remarks

This method is used to terminate all calls currently in the Calls collection. CallTerminated will fire for each successfully terminated call.

Error Handling (C++)

Hold Method (IPPhone Class)

Places a call on hold.

Syntax

ANSI (Cross Platform)
int Hold(const char* lpszcallId);

Unicode (Windows)
INT Hold(LPCWSTR lpszcallId);

int ipworksvoip_ipphone_hold(void* lpObj, const char* lpszcallId);

int Hold(const QString& qscallId);

Remarks

This method is used to place a call, specified by CallId, on hold.

Error Handling (C++)

JoinConference Method (IPPhone Class)

Adds a call to a conference call.

Syntax

ANSI (Cross Platform)
int JoinConference(const char* lpszcallId, const char* lpszconferenceId);

Unicode (Windows)
INT JoinConference(LPCWSTR lpszcallId, LPCWSTR lpszconferenceId);

int ipworksvoip_ipphone_joinconference(void* lpObj, const char* lpszcallId, const char* lpszconferenceId);

int JoinConference(const QString& qscallId, const QString& qsconferenceId);

Remarks

This method is used to add a call, specified by CallId, to a conference call.

The ConferenceId parameter specifies the unique Id of the conference call. If no conference ID exists, the class will start a new conference call with this ID.

Error Handling (C++)

LeaveConference Method (IPPhone Class)

Removes a call from a conference call.

Syntax

ANSI (Cross Platform)
int LeaveConference(const char* lpszcallId);

Unicode (Windows)
INT LeaveConference(LPCWSTR lpszcallId);

int ipworksvoip_ipphone_leaveconference(void* lpObj, const char* lpszcallId);

int LeaveConference(const QString& qscallId);

Remarks

This method is used to remove a call, specified by CallId, from a conference call. If the call is not a part of any conference call, an exception will be thrown.

Error Handling (C++)

ListConferences Method (IPPhone Class)

Lists ongoing conference calls.

Syntax

ANSI (Cross Platform)
char* ListConferences();

Unicode (Windows)
LPWSTR ListConferences();

char* ipworksvoip_ipphone_listconferences(void* lpObj);

QString ListConferences();

Remarks

This method is used to list ongoing conferences any of the class's calls are currently a part of. Calling this will return a string with the following format:

ConferenceId_1: CallId_1, CallId_2

...

ConferenceId_n: CallId_3, CallId_4, CallId_5, ...

Error Handling (C++)

ListMicrophones Method (IPPhone Class)

Lists all microphones detected on the system.

Syntax

ANSI (Cross Platform)
int ListMicrophones();

Unicode (Windows)
INT ListMicrophones();

int ipworksvoip_ipphone_listmicrophones(void* lpObj);

int ListMicrophones();

Remarks

This method lists all microphones detected on the system. Calling this method will populate the Microphones collection.

Error Handling (C++)

ListSpeakers Method (IPPhone Class)

Lists all speakers detected on the system.

Syntax

ANSI (Cross Platform)
int ListSpeakers();

Unicode (Windows)
INT ListSpeakers();

int ipworksvoip_ipphone_listspeakers(void* lpObj);

int ListSpeakers();

Remarks

This method lists all speakers detected on the system. Calling this method will populate the Speakers collection.

Error Handling (C++)

MuteMicrophone Method (IPPhone Class)

Used to mute or unmute the microphone for a specified call.

Syntax

ANSI (Cross Platform)
int MuteMicrophone(const char* lpszcallId, int bmute);

Unicode (Windows)
INT MuteMicrophone(LPCWSTR lpszcallId, BOOL bmute);

int ipworksvoip_ipphone_mutemicrophone(void* lpObj, const char* lpszcallId, int bmute);

int MuteMicrophone(const QString& qscallId, bool bmute);

Remarks

This method can be used to either mute or unmute the microphone for a specified call, given by CallId. When Mute is true, the microphone will be muted for the call. When false, the microphone will be unmuted.

Error Handling (C++)

MuteSpeaker Method (IPPhone Class)

Used to mute or unmute the speaker for a specified call.

Syntax

ANSI (Cross Platform)
int MuteSpeaker(const char* lpszcallId, int bmute);

Unicode (Windows)
INT MuteSpeaker(LPCWSTR lpszcallId, BOOL bmute);

int ipworksvoip_ipphone_mutespeaker(void* lpObj, const char* lpszcallId, int bmute);

int MuteSpeaker(const QString& qscallId, bool bmute);

Remarks

This method can be used to either mute or unmute the speaker for a specified call, given by CallId. When Mute is true, the speaker will be muted for the call. When false, the speaker will be unmuted.

Error Handling (C++)

Ping Method (IPPhone Class)

Used to ping the server.

Syntax

ANSI (Cross Platform)
int Ping(int itimeout);

Unicode (Windows)
INT Ping(INT itimeout);

int ipworksvoip_ipphone_ping(void* lpObj, int itimeout);

int Ping(int itimeout);

Remarks

This method is used to ping the SIP server by sending an OPTIONS request. If no server response is received by the class in Timeout seconds, Ping will throw an error.

Note this method is only applicable when the component is active.

Error Handling (C++)

PlayBytes Method (IPPhone Class)

This method is used to play bytes to a call.

Syntax

ANSI (Cross Platform)
int PlayBytes(const char* lpszcallId, const char* lpbytesToPlay, int lenbytesToPlay, int blastBlock);

Unicode (Windows)
INT PlayBytes(LPCWSTR lpszcallId, LPCSTR lpbytesToPlay, INT lenbytesToPlay, BOOL blastBlock);

int ipworksvoip_ipphone_playbytes(void* lpObj, const char* lpszcallId, const char* lpbytesToPlay, int lenbytesToPlay, int blastBlock);

int PlayBytes(const QString& qscallId, QByteArray qbabytesToPlay, bool blastBlock);

Remarks

This method is used to play bytes to a call, specified by the CallId parameter. These bytes are expected to have a sampling rate of 8 kHz and a bit depth of 16 bits per sample (PCM 8 kHz 16-bit format). The BytesToPlay parameter specifies the bytes that will be sent to the call. Internally, these bytes will be stored within a buffer. Once all bytes have played and the buffer is empty, the Played event will fire.

The LastBlock parameter indicates whether the class will expect further uses of PlayBytes. When true, this indicates that no additional bytes will be provided for this particular audio stream, and Played will fire once after the bytes have been played. Until this parameter is specified as true, the class will be considered to be playing audio.

If LastBlock is false, this indicates that the class should expect more calls to PlayBytes. Once all bytes have played and the buffer is empty, Played will fire as expected, and will continue firing until the LastBlock parameter is set to true. Within Played, the user can provide further bytes to PlayBytes. Please see below for detailed examples on how to use this method with Played.

Example: Playing audio from a stream MemoryStream playBytesStream = new MemoryStream(byteSource); phone.PlayBytes("callId", new byte[0], false); phone.OnPlayed += (o, e) => { if (e.Completed) { Console.WriteLine("Playing Bytes Completed"); } else { byte[] data = new byte[4096]; // Arbitrary length int dataLen = playBytesStream.Read(data, 0, data.Length); if (dataLen > 0) { byte[] newData = new byte[dataLen]; Array.Copy(data, newData, dataLen) // Normalize array phone.PlayBytes(e.CallId, newData, false); } else { phone.PlayBytes(e.CallId, null, true); } } }; Exmaple: Playing single audio block MemoryStream playBytesStream = new MemoryStream(byteSource); phone.PlayBytes("callId", playBytesStream.ToArray(), true); phone.OnPlayed += (o, e) => { Console.WriteLine("Done!"); // No further calls to PlayBytes are expected in this case }

Error Handling (C++)

PlayFile Method (IPPhone Class)

Plays audio from a WAV file to a call.

Syntax

ANSI (Cross Platform)
int PlayFile(const char* lpszcallId, const char* lpszwavFile);

Unicode (Windows)
INT PlayFile(LPCWSTR lpszcallId, LPCWSTR lpszwavFile);

int ipworksvoip_ipphone_playfile(void* lpObj, const char* lpszcallId, const char* lpszwavFile);

int PlayFile(const QString& qscallId, const QString& qswavFile);

Remarks

This method is used to play the audio from a WAV file to a particular call, given by CallId. Audio transmission will only occur when the call has connected and CallReady has fired. Only WAV files with a sampling rate of 8 kHz and a bit depth of 16 bits per sample are supported (PCM 8 kHz 16-bit format).

Note that this class can handle playing audio to concurrent calls. This method is non-blocking and will return immediately. The Played event will fire when the audio for the specified call has finished playing. Consecutive uses of PlayText or PlayFile can prevent prior audio transmissions from being completed. In the below example, Played will only fire for the second call to PlayText:

ipphone.PlayFile("callId", "C:\\hello.wav"); // Played will not fire for this ipphone.PlayText("callId", "This will interrupt the previous use if it has not finished playing.");

The WavFile parameter specifies the path to the WAV file.

Error Handling (C++)

PlayText Method (IPPhone Class)

Plays audio from a string to a call using Text-to-Speech.

Syntax

ANSI (Cross Platform)
int PlayText(const char* lpszcallId, const char* lpsztext);

Unicode (Windows)
INT PlayText(LPCWSTR lpszcallId, LPCWSTR lpsztext);

int ipworksvoip_ipphone_playtext(void* lpObj, const char* lpszcallId, const char* lpsztext);

int PlayText(const QString& qscallId, const QString& qstext);

Remarks

This method is used to play the text from a string to a particular call, given by CallId, using Text-to-Speech. Audio transmission will only occur when the call has connected and CallReady has fired.

Note that this class can handle playing audio to concurrent calls. This method is non-blocking and will return immediately. The Played event will fire when the audio for the specified call has finished playing. Consecutive uses of PlayText and PlayFile can prevent prior audio transmissions from completing. In the below example, Played will only fire for the second call to PlayText:

ipphone.PlayFile("callId", "C:\\hello.wav"); // Played will not fire for this ipphone.PlayText("callId", "This will interrupt the previous use if it has not finished playing.");

The Text parameter must be a string representation of the text to be transmitted.

Error Handling (C++)

Reset Method (IPPhone Class)

This method will reset the class.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksvoip_ipphone_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

SetMicrophone Method (IPPhone Class)

Sets the microphone used by the class.

Syntax

ANSI (Cross Platform)
int SetMicrophone(const char* lpszmicrophone);

Unicode (Windows)
INT SetMicrophone(LPCWSTR lpszmicrophone);

int ipworksvoip_ipphone_setmicrophone(void* lpObj, const char* lpszmicrophone);

int SetMicrophone(const QString& qsmicrophone);

Remarks

This method is used to set the Microphone that will be used by the class.

The Microphone parameter specifies the name of the microphone to be set. To get the available microphones on the system, call ListMicrophones. Then, set the microphone with a name specified in the Microphones collection.

Example ipphone.ListMicrophones(); ipphone.SetMicrophone(ipphone.Microphones[0].Name);

Error Handling (C++)

SetSpeaker Method (IPPhone Class)

Sets the speaker used by the class.

Syntax

ANSI (Cross Platform)
int SetSpeaker(const char* lpszspeaker);

Unicode (Windows)
INT SetSpeaker(LPCWSTR lpszspeaker);

int ipworksvoip_ipphone_setspeaker(void* lpObj, const char* lpszspeaker);

int SetSpeaker(const QString& qsspeaker);

Remarks

This method is used to set the speaker that will be used by the class.

The Speaker parameter specifies the name of the speaker to be set. To get the available speakers on the system, call ListSpeakers. Then, set the speaker with a name specified in the Speakers collection.

Example ipphone.ListSpeakers(); ipphone.SetSpeaker(ipphone.Speakers[0].Name);

Error Handling (C++)

StartRecording Method (IPPhone Class)

Used to start recording the audio of a call.

Syntax

ANSI (Cross Platform)
int StartRecording(const char* lpszcallId, const char* lpszfilename);

Unicode (Windows)
INT StartRecording(LPCWSTR lpszcallId, LPCWSTR lpszfilename);

int ipworksvoip_ipphone_startrecording(void* lpObj, const char* lpszcallId, const char* lpszfilename);

int StartRecording(const QString& qscallId, const QString& qsfilename);

Remarks

This method is used to start recording the incoming and outgoing audio of a call, specified by CallId. If you wish to record the audio to file, you may specify the Filename parameter. Note that when this parameter is specified, you must record to a WAV file.

You may also leave the Filename parameter blank if you want more direct control over the recorded data. This will cause the Record event to fire containing the call's audio data once the recording is finished.

In both scenarios, you can stop recording the call's audio via StopRecording. By default, the recording will end if the call is terminated. Note the recorded audio will have a sampling rate of 8 kHz and a bit depth of 16 bits per sample (PCM 8 kHz 16-bit format).

Example: Using the 'Record' event MemoryStream recordStream = new MemoryStream(); phone.StartRecording("callId", ""); phone.OnRecord += (o, e) => { recordStream.Write(e.RecordedDataB, 0, e.RecordedDataB.Length); File.WriteAllBytes(recordFile, recordStream.ToArray()); };

Error Handling (C++)

StopPlaying Method (IPPhone Class)

Stops audio from playing to a call.

Syntax

ANSI (Cross Platform)
int StopPlaying(const char* lpszcallId);

Unicode (Windows)
INT StopPlaying(LPCWSTR lpszcallId);

int ipworksvoip_ipphone_stopplaying(void* lpObj, const char* lpszcallId);

int StopPlaying(const QString& qscallId);

Remarks

This method is used to stop the audio playing to a call, given by CallId. Note that this will not stop audio from transmitting with an external device set using SetMicrophone, however, will stop audio transmitting from usage of PlayText, PlayFile, and PlayBytes.

Note that Played will not fire when this method is used.

Error Handling (C++)

StopRecording Method (IPPhone Class)

Stops recording the audio of a call.

Syntax

ANSI (Cross Platform)
int StopRecording(const char* lpszcallId);

Unicode (Windows)
INT StopRecording(LPCWSTR lpszcallId);

int ipworksvoip_ipphone_stoprecording(void* lpObj, const char* lpszcallId);

int StopRecording(const QString& qscallId);

Remarks

This method is used to stop recording the audio of a call, given by CallId. The class will automatically stop recording upon call termination.

Error Handling (C++)

Transfer Method (IPPhone Class)

Transfers a call.

Syntax

ANSI (Cross Platform)
int Transfer(const char* lpszcallId, const char* lpsznumber);

Unicode (Windows)
INT Transfer(LPCWSTR lpszcallId, LPCWSTR lpsznumber);

int ipworksvoip_ipphone_transfer(void* lpObj, const char* lpszcallId, const char* lpsznumber);

int Transfer(const QString& qscallId, const QString& qsnumber);

Remarks

This method is used to transfer a call, specified by CallId, to the phone number given by Number. The class supports the following types of transfers:

Basic Transfers

Basic transfers are very simple to perform. First, the user must establish a call with the number they will be transferring (transferee). After the call is established, the user can transfer the call to the appropriate number (transfer target). The call will then be removed. For example:

string callId = ipphone1.Dial("123456789", "", true); // Establish call with transferee, hold if needed //ipphone1.Hold(callId); ipphone1.Transfer(callId, "number");

Attended Transfers

Typically, attended transfers are used to manually check if the Number (or transfer target) is available for a call, provide extra information about the call, etc., before transferring. In addition to establishing a call with the transferee, the class must also establish a call with the transfer target. Once both of these calls are active, you may perform an attended transfer by calling Transfer at any moment. Afterwards, a session between these calls will be established and they will be removed. Note that Transfer must be used with the CallId of the call you wish to transfer (transferee) and the Number of the call you wish to transfer to (transfer target). For example:

Note in these examples, Hold can be used to place a call on hold before a transfer. This is optional.

Error Handling (C++)

TypeDigit Method (IPPhone Class)

Used to type a digit.

Syntax

ANSI (Cross Platform)
int TypeDigit(const char* lpszcallId, const char* lpszdigit);

Unicode (Windows)
INT TypeDigit(LPCWSTR lpszcallId, LPCWSTR lpszdigit);

int ipworksvoip_ipphone_typedigit(void* lpObj, const char* lpszcallId, const char* lpszdigit);

int TypeDigit(const QString& qscallId, const QString& qsdigit);

Remarks

This method can be used to type a digit, mimicking the functionality of a phone's keypad.

The CallId parameter specifies the call that will receive the virtual keypad input.

The Digit parameter specifies the digit that will be typed. Valid inputs include: 0-9, *, #

Error Handling (C++)

Unhold Method (IPPhone Class)

Takes a call off hold.

Syntax

ANSI (Cross Platform)
int Unhold(const char* lpszcallId);

Unicode (Windows)
INT Unhold(LPCWSTR lpszcallId);

int ipworksvoip_ipphone_unhold(void* lpObj, const char* lpszcallId);

int Unhold(const QString& qscallId);

Remarks

This method is used to take a call, specified by CallId, off hold.

Error Handling (C++)

Activated Event (IPPhone Class)

This event is fired immediately after the class is activated.

Syntax

ANSI (Cross Platform)
virtual int FireActivated(IPPhoneActivatedEventParams *e);

typedef struct {
  int reserved;
} IPPhoneActivatedEventParams;


Unicode (Windows)
virtual INT FireActivated(IPPhoneActivatedEventParams *e);

typedef struct {
  INT reserved;
} IPPhoneActivatedEventParams;

#define EID_IPPHONE_ACTIVATED 1

virtual INT IPWORKSVOIP_CALL FireActivated();

class IPPhoneActivatedEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Activated(IPPhoneActivatedEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireActivated(IPPhoneActivatedEventParams *e) {...}

Remarks

The Activated event will fire after the class has successfully registered with the SIP Server via Activate.

CallReady Event (IPPhone Class)

This event is fired after a call has been answered, declined, or ignored.

Syntax

ANSI (Cross Platform)
virtual int FireCallReady(IPPhoneCallReadyEventParams *e);

typedef struct {
  const char *CallId;
  int reserved;
} IPPhoneCallReadyEventParams;


Unicode (Windows)
virtual INT FireCallReady(IPPhoneCallReadyEventParams *e);

typedef struct {
  LPCWSTR CallId;
  INT reserved;
} IPPhoneCallReadyEventParams;

#define EID_IPPHONE_CALLREADY 2

virtual INT IPWORKSVOIP_CALL FireCallReady(LPSTR &lpszCallId);

class IPPhoneCallReadyEventParams {
public:
  const QString &CallId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CallReady(IPPhoneCallReadyEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireCallReady(IPPhoneCallReadyEventParams *e) {...}

Remarks

For all calls, this event will fire when audio can be transmitted and received. For incoming calls, it will fire after the call has been answered.

For outgoing calls, this event will fire after the call has either been answered, declined, or ignored. In the case that the call is declined or ignored, it will fire and the class will be sent to voicemail. Hangup can be used to end the call in all scenarios.

Note that this event will fire after OutgoingCall and DialCompleted, assuming Dial was successful.

The CallId parameter is the unique Id of the call.

CallStateChanged Event (IPPhone Class)

This event is fired after a call's state has changed.

Syntax

ANSI (Cross Platform)
virtual int FireCallStateChanged(IPPhoneCallStateChangedEventParams *e);

typedef struct {
  const char *CallId;
  int State;
  int reserved;
} IPPhoneCallStateChangedEventParams;


Unicode (Windows)
virtual INT FireCallStateChanged(IPPhoneCallStateChangedEventParams *e);

typedef struct {
  LPCWSTR CallId;
  INT State;
  INT reserved;
} IPPhoneCallStateChangedEventParams;

#define EID_IPPHONE_CALLSTATECHANGED 3

virtual INT IPWORKSVOIP_CALL FireCallStateChanged(LPSTR &lpszCallId, INT &iState);

class IPPhoneCallStateChangedEventParams {
public:
  const QString &CallId();

  int State();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CallStateChanged(IPPhoneCallStateChangedEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireCallStateChanged(IPPhoneCallStateChangedEventParams *e) {...}

Remarks

The CallStateChanged event will fire each time the state of a call has changed.

The CallId parameter is the unique Id of the call.

The State parameter denotes the state the call has changed to. The following values are applicable:


csInactive (0)	The call is inactive (default setting).
csConnecting (1)	The call is establishing a connection to the callee.
csAutConnecting (2)	The call is establishing a connection to the callee with authorization credentials.
csRinging (3)	The call is ringing.
csActive (4)	The call is active.
csActiveInConference (5)	The call is active and in a conference.
csDisconnecting (6)	The call is disconnecting with the callee.
csAutDisconnecting (7)	The call is disconnecting with the callee with authorization credentials.
csHolding (8)	The call is currently being placed on hold, but the Hold operation has not finished.
csOnHold (9)	The call is currently on hold.
csUnholding (10)	The call is currently being unheld, but the Unhold operation has not finished.
csTransferring (11)	The call is currently being transferred.
csAutTransferring (12)	The call is currently being transferred with authorization credentials.

CallTerminated Event (IPPhone Class)

This event is fired after a call has been terminated.

Syntax

ANSI (Cross Platform)
virtual int FireCallTerminated(IPPhoneCallTerminatedEventParams *e);

typedef struct {
  const char *CallId;
  int reserved;
} IPPhoneCallTerminatedEventParams;


Unicode (Windows)
virtual INT FireCallTerminated(IPPhoneCallTerminatedEventParams *e);

typedef struct {
  LPCWSTR CallId;
  INT reserved;
} IPPhoneCallTerminatedEventParams;

#define EID_IPPHONE_CALLTERMINATED 4

virtual INT IPWORKSVOIP_CALL FireCallTerminated(LPSTR &lpszCallId);

class IPPhoneCallTerminatedEventParams {
public:
  const QString &CallId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CallTerminated(IPPhoneCallTerminatedEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireCallTerminated(IPPhoneCallTerminatedEventParams *e) {...}

Remarks

The CallTerminated event will fire after a call has been terminated by either end of the call.

The CallId parameter is the unique Id of the call.

Deactivated Event (IPPhone Class)

This event is fired immediately after the class is deactivated.

Syntax

ANSI (Cross Platform)
virtual int FireDeactivated(IPPhoneDeactivatedEventParams *e);

typedef struct {
  int reserved;
} IPPhoneDeactivatedEventParams;


Unicode (Windows)
virtual INT FireDeactivated(IPPhoneDeactivatedEventParams *e);

typedef struct {
  INT reserved;
} IPPhoneDeactivatedEventParams;

#define EID_IPPHONE_DEACTIVATED 5

virtual INT IPWORKSVOIP_CALL FireDeactivated();

class IPPhoneDeactivatedEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Deactivated(IPPhoneDeactivatedEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireDeactivated(IPPhoneDeactivatedEventParams *e) {...}

Remarks

The Deactivated event will fire after the class has unregistered from the SIP Server via Deactivate.

DialCompleted Event (IPPhone Class)

This event is fired after the dial process has finished.

Syntax

ANSI (Cross Platform)
virtual int FireDialCompleted(IPPhoneDialCompletedEventParams *e);

typedef struct {
  const char *OriginalCallId;
  const char *CallId;
  const char *Caller;
  const char *Callee;
  int ErrorCode;
  const char *Description;
  int reserved;
} IPPhoneDialCompletedEventParams;


Unicode (Windows)
virtual INT FireDialCompleted(IPPhoneDialCompletedEventParams *e);

typedef struct {
  LPCWSTR OriginalCallId;
  LPCWSTR CallId;
  LPCWSTR Caller;
  LPCWSTR Callee;
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} IPPhoneDialCompletedEventParams;

#define EID_IPPHONE_DIALCOMPLETED 6

virtual INT IPWORKSVOIP_CALL FireDialCompleted(LPSTR &lpszOriginalCallId, LPSTR &lpszCallId, LPSTR &lpszCaller, LPSTR &lpszCallee, INT &iErrorCode, LPSTR &lpszDescription);

class IPPhoneDialCompletedEventParams {
public:
  const QString &OriginalCallId();

  const QString &CallId();

  const QString &Caller();

  const QString &Callee();

  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DialCompleted(IPPhoneDialCompletedEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireDialCompleted(IPPhoneDialCompletedEventParams *e) {...}

Remarks

This event will fire when the dial process, initiated by calling Dial, has completed. Note that this event will not fire if an exception occurs when the "wait" parameter of Dial is true. In this case, the class will throw an exception. However, it will fire if "wait" is true and no exception occurs, indicating Dial was successful.

The OriginalCallId parameter is the value returned by Dial.

The value of the CallId parameter depends on the redirection status of the call. There are two scenarios:

The outgoing call has not been redirected. In this case, CallId is equal to OriginalCallId, and the value returned by Dial is correct.
The outgoing call has been redirected any number of times. In this case, the OriginalCallId is no longer applicable, and the CallId parameter is the new unique identifier for this call. Any reference to the past value, OriginalCallId, should be updated accordingly to reflect the change due to redirection. This would also include references to the original value returned by Dial.

The Caller parameter specifies the user that initially made the call. The Callee parameter specifies the final recipient of the call.

Errors during the dial process are reported via the ErrorCode and Description parameters. An error code of 0 and description of "Dialed Successfully" indicate Dial has completed with no issues. A list of error codes can be found in the Error Codes section. In the case of a non-zero ErrorCode, the Description parameter will contain the error message (and SIP response code, if applicable), for example, "Dial Timeout" or "486: Busy Here".

Digit Event (IPPhone Class)

This event fires every time a digit is pressed using the keypad.

Syntax

ANSI (Cross Platform)
virtual int FireDigit(IPPhoneDigitEventParams *e);

typedef struct {
  const char *CallId;
  const char *Digit;
  int reserved;
} IPPhoneDigitEventParams;


Unicode (Windows)
virtual INT FireDigit(IPPhoneDigitEventParams *e);

typedef struct {
  LPCWSTR CallId;
  LPCWSTR Digit;
  INT reserved;
} IPPhoneDigitEventParams;

#define EID_IPPHONE_DIGIT 7

virtual INT IPWORKSVOIP_CALL FireDigit(LPSTR &lpszCallId, LPSTR &lpszDigit);

class IPPhoneDigitEventParams {
public:
  const QString &CallId();

  const QString &Digit();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Digit(IPPhoneDigitEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireDigit(IPPhoneDigitEventParams *e) {...}

Remarks

The Digit event will fire after every detected keypad input from a call.

The detected input will be present in the Digit parameter. Note, this event will not fire after the class's inputs via TypeDigit. Detectable inputs include: 0-9, *, #

The CallId parameter is the unique Id of the call.

Error Event (IPPhone Class)

Fired when information is available about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(IPPhoneErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} IPPhoneErrorEventParams;


Unicode (Windows)
virtual INT FireError(IPPhoneErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} IPPhoneErrorEventParams;

#define EID_IPPHONE_ERROR 8

virtual INT IPWORKSVOIP_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class IPPhoneErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(IPPhoneErrorEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireError(IPPhoneErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

IncomingCall Event (IPPhone Class)

This event is fired when an incoming call is received.

Syntax

ANSI (Cross Platform)
virtual int FireIncomingCall(IPPhoneIncomingCallEventParams *e);

typedef struct {
  const char *CallId;
  const char *RemoteUser;
  const char *RequestURI;
  const char *ToURI;
  int reserved;
} IPPhoneIncomingCallEventParams;


Unicode (Windows)
virtual INT FireIncomingCall(IPPhoneIncomingCallEventParams *e);

typedef struct {
  LPCWSTR CallId;
  LPCWSTR RemoteUser;
  LPCWSTR RequestURI;
  LPCWSTR ToURI;
  INT reserved;
} IPPhoneIncomingCallEventParams;

#define EID_IPPHONE_INCOMINGCALL 9

virtual INT IPWORKSVOIP_CALL FireIncomingCall(LPSTR &lpszCallId, LPSTR &lpszRemoteUser, LPSTR &lpszRequestURI, LPSTR &lpszToURI);

class IPPhoneIncomingCallEventParams {
public:
  const QString &CallId();

  const QString &RemoteUser();

  const QString &RequestURI();

  const QString &ToURI();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void IncomingCall(IPPhoneIncomingCallEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireIncomingCall(IPPhoneIncomingCallEventParams *e) {...}

Remarks

The IncomingCall event will fire when an incoming call is received.

The CallId parameter specifies the unique Id of the call, and can be used to Answer or Decline the call.

The RemoteUser parameter indicates the username or telephone number of the remote user associated with the call.

The RequestURI parameter specifies the contact information of the current recipient associated with the call. This parameter is typically of the format sip:user@domain:port.

The ToURI parameter specifies the URI present in the To header. This URI contains the contact information information of the original recipient associated with the call. This parameter is typically of the format sip:user@domain.

Note the user and domain within the ToURI indicate the original recipient of the call as initially specified by the caller. This value may not reflect the current (or final) recipient of the call as denoted by the RequestURI.

Log Event (IPPhone Class)

This event is fired once for each log message.

Syntax

ANSI (Cross Platform)
virtual int FireLog(IPPhoneLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} IPPhoneLogEventParams;


Unicode (Windows)
virtual INT FireLog(IPPhoneLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} IPPhoneLogEventParams;

#define EID_IPPHONE_LOG 10

virtual INT IPWORKSVOIP_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class IPPhoneLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(IPPhoneLogEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireLog(IPPhoneLogEventParams *e) {...}

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel configuration.

LogLevel indicates the detail level of the message. Possible values are:


0 (None)	No messages are logged.
1 (Info - Default)	Informational events such as a call's status are logged.
2 (Verbose)	Detailed data such as SIP/SDP packet information is logged.
3 (Debug)	Debug data including all relevant sent and received audio bytes are logged.

Note: When LogLevel is set to 3 (Debug), we strongly advise against performing long-running operations inside of this event due to large amounts of sent and received audio bytes. For example, continuously updating an interface displaying the Log data will cause major performance issues in an application. It is recommended to set LogLevel to 3 only when writing Log data to a stream or file. There will be no performance issues in this case.

Message is the log message.

LogType identifies the type of log entry. Possible values are as follows:

Info
Packet
RTP

OutgoingCall Event (IPPhone Class)

This event is fired when an outgoing call has been made.

Syntax

ANSI (Cross Platform)
virtual int FireOutgoingCall(IPPhoneOutgoingCallEventParams *e);

typedef struct {
  const char *CallId;
  const char *RemoteUser;
  int reserved;
} IPPhoneOutgoingCallEventParams;


Unicode (Windows)
virtual INT FireOutgoingCall(IPPhoneOutgoingCallEventParams *e);

typedef struct {
  LPCWSTR CallId;
  LPCWSTR RemoteUser;
  INT reserved;
} IPPhoneOutgoingCallEventParams;

#define EID_IPPHONE_OUTGOINGCALL 11

virtual INT IPWORKSVOIP_CALL FireOutgoingCall(LPSTR &lpszCallId, LPSTR &lpszRemoteUser);

class IPPhoneOutgoingCallEventParams {
public:
  const QString &CallId();

  const QString &RemoteUser();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void OutgoingCall(IPPhoneOutgoingCallEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireOutgoingCall(IPPhoneOutgoingCallEventParams *e) {...}

Remarks

The OutgoingCall event is fired when an outgoing call has been made using Dial. This event signifies the start of the invite process.

The CallId parameter is the unique Id of the call.

The RemoteUser parameter indicates the username or telephone number of the remote user associated with the call.

Played Event (IPPhone Class)

This event is fired after the class finishes playing available audio.

Syntax

ANSI (Cross Platform)
virtual int FirePlayed(IPPhonePlayedEventParams *e);

typedef struct {
  const char *CallId;
  int Completed;
  int reserved;
} IPPhonePlayedEventParams;


Unicode (Windows)
virtual INT FirePlayed(IPPhonePlayedEventParams *e);

typedef struct {
  LPCWSTR CallId;
  BOOL Completed;
  INT reserved;
} IPPhonePlayedEventParams;

#define EID_IPPHONE_PLAYED 12

virtual INT IPWORKSVOIP_CALL FirePlayed(LPSTR &lpszCallId, BOOL &bCompleted);

class IPPhonePlayedEventParams {
public:
  const QString &CallId();

  bool Completed();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Played(IPPhonePlayedEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FirePlayed(IPPhonePlayedEventParams *e) {...}

Remarks

The Played event will fire after the class finishes playing available audio to a call. When using PlayText or PlayFile, Completed will always be true. However, this will not always be the case when using PlayBytes.

When playing audio via PlayBytes, this event will fire when the internal byte queue is empty. In the event that the internal byte queue is empty, and the class is still expecting calls to PlayBytes (i.e., lastBlock is false), this event will continue to fire with the Completed parameter as false. In this case, additional bytes are expected to be provided. Completed will be true once all bytes have been played and the class is no longer expecting calls to PlayBytes (i.e., lastBlock is true). Please see the method description for more details.

The CallId parameter is the unique Id of the call.

Record Event (IPPhone Class)

This event is fired when recorded audio data is available.

Syntax

ANSI (Cross Platform)
virtual int FireRecord(IPPhoneRecordEventParams *e);

typedef struct {
  const char *CallId;
  const char *RecordedData;
  int lenRecordedData;
  int reserved;
} IPPhoneRecordEventParams;


Unicode (Windows)
virtual INT FireRecord(IPPhoneRecordEventParams *e);

typedef struct {
  LPCWSTR CallId;
  LPCSTR RecordedData;
  INT lenRecordedData;
  INT reserved;
} IPPhoneRecordEventParams;

#define EID_IPPHONE_RECORD 13

virtual INT IPWORKSVOIP_CALL FireRecord(LPSTR &lpszCallId, LPSTR &lpRecordedData, INT &lenRecordedData);

class IPPhoneRecordEventParams {
public:
  const QString &CallId();

  const QByteArray &RecordedData();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Record(IPPhoneRecordEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireRecord(IPPhoneRecordEventParams *e) {...}

Remarks

This event is fired when a call's recorded data is available. This data is made available when either StopRecording is called or the call is terminated. Note that for this event to fire, StartRecording must be specified with no filename parameter.

The recorded data will be available in the RecordedData and RecordedDataB parameters, and will have a sampling rate of 8 kHz and a bit depth of 16 bits per sample (PCM 8 kHz 16-bit format).

The CallId parameter is the unique Id of the call.

Silence Event (IPPhone Class)

This event is fired when the class detects silence from incoming audio streams.

Syntax

ANSI (Cross Platform)
virtual int FireSilence(IPPhoneSilenceEventParams *e);

typedef struct {
  const char *CallId;
  int reserved;
} IPPhoneSilenceEventParams;


Unicode (Windows)
virtual INT FireSilence(IPPhoneSilenceEventParams *e);

typedef struct {
  LPCWSTR CallId;
  INT reserved;
} IPPhoneSilenceEventParams;

#define EID_IPPHONE_SILENCE 14

virtual INT IPWORKSVOIP_CALL FireSilence(LPSTR &lpszCallId);

class IPPhoneSilenceEventParams {
public:
  const QString &CallId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Silence(IPPhoneSilenceEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireSilence(IPPhoneSilenceEventParams *e) {...}

Remarks

The Silence event will fire every second the class detects silence from a call's incoming audio stream. Note that this event can fire while an outgoing call is ringing.

The CallId parameter is the unique Id of the call.

SSLServerAuthentication Event (IPPhone Class)

Fired after the server presents its certificate to the client.

Syntax

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(IPPhoneSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} IPPhoneSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(IPPhoneSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} IPPhoneSSLServerAuthenticationEventParams;

#define EID_IPPHONE_SSLSERVERAUTHENTICATION 15

virtual INT IPWORKSVOIP_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class IPPhoneSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(IPPhoneSSLServerAuthenticationEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireSSLServerAuthentication(IPPhoneSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (IPPhone Class)

Fired when secure connection progress messages are available.

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(IPPhoneSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} IPPhoneSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(IPPhoneSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} IPPhoneSSLStatusEventParams;

#define EID_IPPHONE_SSLSTATUS 16

virtual INT IPWORKSVOIP_CALL FireSSLStatus(LPSTR &lpszMessage);

class IPPhoneSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(IPPhoneSSLStatusEventParams *e);

// Or, subclass IPPhone and override this emitter function.
virtual int FireSSLStatus(IPPhoneSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Call Type

Contains the details of an active call.

Syntax

IPWorksVoIPCall (declared in ipworksvoip.h)

Remarks

This type contains the details of an active call.

Fields

CallId
char* (read-only)
Default Value: ""

String representation of an immutable universally unique identifier (UUID) specific to the call.

ConferenceId
char* (read-only)
Default Value: ""

A unique identifier for a conference call.

Duration
int (read-only)
Default Value: 0

Elapsed time, in seconds, since the call has begun. Calculated using the value in StartedAt.

LastStatus
int (read-only)
Default Value: 0

This field indicates the call's last response code. Response codes are defined in RFC 3261.

LocalAddress
char* (read-only)
Default Value: ""

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

LocalPort
int (read-only)
Default Value: 0

The UDP port in the local host where UDP binds.

Microphone
char* (read-only)
Default Value: ""

The microphone currently in use during the call. Set through SetMicrophone.

MuteMicrophone
int
Default Value: FALSE

This field can be set to mute the Microphone being used by the class in the given call. When True, the Microphone is muted.

MuteSpeaker
int
Default Value: FALSE

This field can be set to mute the Speaker being used by the class in the given call. When True, the Speaker is muted.

Outgoing
int (read-only)
Default Value: FALSE

Indicates whether the current call is outgoing. If false, the call is incoming.

Playing
int (read-only)
Default Value: FALSE

Indicates whether the current call is playing audio via PlayText or PlayFile, or PlayBytes. After audio transmission is complete, or stopped using StopPlaying, this flag will be false.

Recording
int (read-only)
Default Value: FALSE

Indicates whether the current call is recording the received voice from the peer. When the recording is done, this flag will be false. If the recording is stopped via StopRecording, this flag will be false.

RemoteAddress
char* (read-only)
Default Value: ""

The address of the remote host we are communicating with.

RemotePort
int (read-only)
Default Value: 0

The port of the remote host we are communicating with. This field is typically 5060.

RemoteURI
char* (read-only)
Default Value: ""

This field communicates who to call via SIP. This value contains the RemoteUser, RemoteAddress, and the RemotePort, and has the following format:

sip:user@host:port

RemoteUser
char* (read-only)
Default Value: ""

The username or telephone number of the remote user associated with the call.

Speaker
char* (read-only)
Default Value: ""

The speaker currently in use during the call. Set through SetSpeaker.

StartedAt
int64 (read-only)
Default Value: 0

The number of milliseconds since 12:00:00 AM January 1, 1970 when this call started.

State
int
Default Value: 0

This field indicates the state of the current call. The applicable values are as follows:


csInactive (0)	The call is inactive (default setting).
csConnecting (1)	The call is establishing a connection to the callee.
csAutConnecting (2)	The call is establishing a connection to the callee with authorization credentials.
csRinging (3)	The call is ringing.
csActive (4)	The call is active.
csActiveInConference (5)	The call is active and in a conference.
csDisconnecting (6)	The call is disconnecting with the callee.
csAutDisconnecting (7)	The call is disconnecting with the callee with authorization credentials.
csHolding (8)	The call is currently being placed on hold, but the Hold operation has not finished.
csOnHold (9)	The call is currently on hold.
csUnholding (10)	The call is currently being unheld, but the Unhold operation has not finished.
csTransferring (11)	The call is currently being transferred.
csAutTransferring (12)	The call is currently being transferred with authorization credentials.

UserInput
char* (read-only)
Default Value: ""

String representation of digits typed by the callee using their keypad.

Via
char* (read-only)
Default Value: ""

The Via header sent in the most recent SIP request. Identifies the protocol name/version, transport type, IP Address of the User Agent Client, and port of the request.

Constructors

Call()

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksVoIPCertificate (declared in ipworksvoip.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

EffectiveDate
char* (read-only)
Default Value: ""

This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
char* (read-only)
Default Value: ""

This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
char* (read-only)
Default Value: ""

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
char* (read-only)
Default Value: ""

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
char* (read-only)
Default Value: ""

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
char* (read-only)
Default Value: ""

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
char* (read-only)
Default Value: ""

This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

PrivateKey
char* (read-only)
Default Value: ""

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
int (read-only)
Default Value: FALSE

This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
char* (read-only)
Default Value: ""

This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
char* (read-only)
Default Value: ""

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
char* (read-only)
Default Value: ""

This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)
Default Value: 0

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
char* (read-only)
Default Value: ""

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
char* (read-only)
Default Value: ""

The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
char*
Default Value: "MY"

This is the name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StorePassword
char*
Default Value: ""

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

StoreType
int
Default Value: 0

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This field can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CERTMGR class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
char* (read-only)
Default Value: ""

This field contains comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
char* (read-only)
Default Value: ""

This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
char* (read-only)
Default Value: ""

This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
char* (read-only)
Default Value: ""

This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
char* (read-only)
Default Value: ""

This field contains the text description of UsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int (read-only)
Default Value: 0

This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
char* (read-only)
Default Value: ""

This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
char*
Default Value: ""

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the field is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, it must be quoted.

Encoded
char*
Default Value: ""

This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

Constructors

Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

Microphone Type

This is a microphone detected on the system.

Syntax

IPWorksVoIPMicrophone (declared in ipworksvoip.h)

Remarks

This type describes a microphone that has been detected on the system.

Fields

Channels
int (read-only)
Default Value: 0

Number specifying whether the device supports mono (1) or stereo (2) output.

ManufacturerId
int (read-only)
Default Value: 0

Manufacturer identifier for the device driver for the device.

Name
char* (read-only)
Default Value: ""

Product name in a null-terminated string.

ProductId
int (read-only)
Default Value: 0

Product identifier for the device as assigned by Windows.

Support
int (read-only)
Default Value: 0

Bitmask of optional functionalities supported by the device. This field can have one or more of the following values OR'd together:


Bitmask	Flag	Description
0x0001	WAVECAPS_PITCH	Supports pitch control.
0x0002	WAVECAPS_PLAYBACKRATE	Supports playback rate control.
0x0004	WAVECAPS_VOLUME	Supports volume control.
0x0008	WAVECAPS_LRVOLUME	Supports separate left and right volume control.
0x0010	WAVECAPS_SYNC	The driver is synchronous and will block while playing a buffer.
0x0020	WAVECAPS_SAMPLEACCURATE	Returns sample-accurate position information.

SupportedFormats
int (read-only)
Default Value: 0

Bitmask of standard formats that are supported. This field can have one or more of the following values OR'd together:


Bitmask	Format	Description
0x00000001	WAVE_FORMAT_1M08	11.025 kHz, mono, 8-bit
0x00000002	WAVE_FORMAT_1S08	11.025 kHz, stereo, 8-bit
0x00000004	WAVE_FORMAT_1M16	11.025 kHz, mono, 16-bit
0x00000008	WAVE_FORMAT_1S16	11.025 kHz, stereo, 16-bit
0x00000010	WAVE_FORMAT_2M08	22.05 kHz, mono, 8-bit
0x00000020	WAVE_FORMAT_2S08	22.05 kHz, stereo, 8-bit
0x00000040	WAVE_FORMAT_2M16	22.05 kHz, mono, 16-bit
0x00000080	WAVE_FORMAT_2S16	22.05 kHz, stereo, 16-bit
0x00000100	WAVE_FORMAT_4M08	44.1 kHz, mono, 8-bit
0x00000200	WAVE_FORMAT_4S08	44.1 kHz, stereo, 8-bit
0x00000400	WAVE_FORMAT_4M16	44.1 kHz, mono, 16-bit
0x00000800	WAVE_FORMAT_4S16	44.1 kHz, stereo, 16-bit
0x00001000	WAVE_FORMAT_48M08	48 kHz, mono, 8-bit
0x00002000	WAVE_FORMAT_48S08	48 kHz, stereo, 8-bit
0x00004000	WAVE_FORMAT_48M16	48 kHz, mono, 16-bit
0x00008000	WAVE_FORMAT_48S16	48 kHz, stereo, 16-bit
0x00010000	WAVE_FORMAT_96M08	96 kHz, mono, 8-bit
0x00020000	WAVE_FORMAT_96S08	96 kHz, stereo, 8-bit
0x00040000	WAVE_FORMAT_96M16	96 kHz, mono, 16-bit
0x00080000	WAVE_FORMAT_96S16	96 kHz, stereo, 16-bit

Constructors

Microphone()

Speaker Type

This is a speaker detected on the system.

Syntax

IPWorksVoIPSpeaker (declared in ipworksvoip.h)

Remarks

This type describes a speaker that has been detected on the system

Fields

Channels
int (read-only)
Default Value: 0

Number specifying whether the device supports mono (1) or stereo (2) output.

ManufacturerId
int (read-only)
Default Value: 0

Manufacturer identifier for the device driver for the device.

Name
char* (read-only)
Default Value: ""

Product name in a null-terminated string.

ProductId
int (read-only)
Default Value: 0

Product identifier for the device as assigned by Windows.

Support
int (read-only)
Default Value: 0

Bitmask of optional functionalities supported by the device. This field can have one or more of the following values OR'd together:


Bitmask	Flag	Description
0x0001	WAVECAPS_PITCH	Supports pitch control.
0x0002	WAVECAPS_PLAYBACKRATE	Supports playback rate control.
0x0004	WAVECAPS_VOLUME	Supports volume control.
0x0008	WAVECAPS_LRVOLUME	Supports separate left and right volume control.
0x0010	WAVECAPS_SYNC	The driver is synchronous and will block while playing a buffer.
0x0020	WAVECAPS_SAMPLEACCURATE	Returns sample-accurate position information.

SupportedFormats
int (read-only)
Default Value: 0

Bitmask of standard formats that are supported. This field can have one or more of the following values OR'd together:


Bitmask	Format	Description
0x00000001	WAVE_FORMAT_1M08	11.025 kHz, mono, 8-bit
0x00000002	WAVE_FORMAT_1S08	11.025 kHz, stereo, 8-bit
0x00000004	WAVE_FORMAT_1M16	11.025 kHz, mono, 16-bit
0x00000008	WAVE_FORMAT_1S16	11.025 kHz, stereo, 16-bit
0x00000010	WAVE_FORMAT_2M08	22.05 kHz, mono, 8-bit
0x00000020	WAVE_FORMAT_2S08	22.05 kHz, stereo, 8-bit
0x00000040	WAVE_FORMAT_2M16	22.05 kHz, mono, 16-bit
0x00000080	WAVE_FORMAT_2S16	22.05 kHz, stereo, 16-bit
0x00000100	WAVE_FORMAT_4M08	44.1 kHz, mono, 8-bit
0x00000200	WAVE_FORMAT_4S08	44.1 kHz, stereo, 8-bit
0x00000400	WAVE_FORMAT_4M16	44.1 kHz, mono, 16-bit
0x00000800	WAVE_FORMAT_4S16	44.1 kHz, stereo, 16-bit
0x00001000	WAVE_FORMAT_48M08	48 kHz, mono, 8-bit
0x00002000	WAVE_FORMAT_48S08	48 kHz, stereo, 8-bit
0x00004000	WAVE_FORMAT_48M16	48 kHz, mono, 16-bit
0x00008000	WAVE_FORMAT_48S16	48 kHz, stereo, 16-bit
0x00010000	WAVE_FORMAT_96M08	96 kHz, mono, 8-bit
0x00020000	WAVE_FORMAT_96S08	96 kHz, stereo, 8-bit
0x00040000	WAVE_FORMAT_96M16	96 kHz, mono, 16-bit
0x00080000	WAVE_FORMAT_96S16	96 kHz, stereo, 16-bit

Constructors

Speaker()

IPWorksVoIPList Type

Syntax

IPWorksVoIPList<T> (declared in ipworksvoip.h)

Remarks

IPWorksVoIPList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the IPPhone class.

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount() {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

Config Settings (IPPhone Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

IPPhone Config Settings

AudioDirection: Indicates the direction of available recorded audio when dynamic recording is enabled.

This configuration is used to indicate the direction of available recorded audio when dynamic recording is enabled via EnableDynamicRecording. When EnableDynamicRecording is enabled and StartRecording has been called with no filename parameter, this configuration can be queried within Record to determine whether the recorded audio data is incoming or outgoing audio. A value of "0" indicates the audio is outgoing. A value of "1" indicates the audio is incoming. Aside from the above case, this configuration should not be interpreted elsewhere.

AuthUser: Specifies the username to be used during client authentication.

This configuration is used to specify the username to be used when authenticating a SIP client, for example, when registering or initiating a call. When specified, this value will replace the User property within the Authorization and Proxy-Authorization headers sent in the mentioned requests.

By default, this value is empty, and the User property will be used within the mentioned headers.

Codecs: Comma-separated list of codecs the class can use.

This configuration contains a comma-separated list of codecs, represented as integers, that the class can use to compress call data. By default, this value is:

8,0,3

The following integers correspond to these supported codecs:


0	PCMU (G711MU)
3	GSM
8	PCMA (G711A)

DeclineStatus: Specifies the status to send when declining an incoming call.

This configuration is used to specify the status to send when declining an incoming call. By default, this configuration will be empty and the class will send 486 Busy Here when calling Decline. Valid responses when declining a call can be found in RFC 3261 Section 21. Note this configuration must be set to the response code and description, for example:

Component.Config("DeclineStatus=600 Busy Everywhere")

DialTimeout: Specifies the amount of time to wait for a response when making a call.

This configuration is used to specify the amount of time (in seconds) the class will wait for the outgoing call to be answered, declined, or ignored when using Dial. Note this value will be 60 by default.

When using Dial with the Wait parameter as false, the timeout will be reported within DialCompleted.

DialToneFile: Specifies the location of the WAV file to play when making a call.

This configuration is used to specify the WAV file to play when making a call. Once the call is answered or terminated, the file will stop playing. Note this file will play when making a call, but only in the case that early media has not been established by the server. In the event the server has established early media, the server's dial tone will be heard instead. Only WAV files with a sampling rate of 8 kHz and a bit depth of 16 bits per sample are supported (PCM 8 kHz 16-bit format).

DisableRegistration: Can be used to disable SIP registration.

This configuration can be used to disable SIP registration. By default, this configuration is set to False and registration is enabled. When set to True and Activate is called, the class will attempt to establish a connection with the server using the underlying transport protocol specified by SIPTransportProtocol. After a successful connection, the class will be considered active until the connection is removed by either end.

Note: It is recommended to enable this configuration only if SIPTransportProtocol is set to TCP or TLS.

Domain: Can be used to set the address of the SIP domain.

This configuration is used to specify the domain name the component will use in SIP requests, if needed. By default this value will be empty.

DtmfMethod: The method used for delivering the signals/tones sent when typing a digit.

This configuration is used to describe the method being used to transmit the signals/tones when calling TypeDigit. Possible values of supported methods are:


1	Inband (Default)
2	RFC 2833
3	Info (SIP Info)

EnableDynamicRecording: Specifies whether dynamic recording is enabled when recording a call.

This configuration is used to specify whether dynamic recording is enabled when recording a call. By default, this configuration is disabled (false). When enabled (true), and StartRecording was called with no filename parameter specified, Record will fire when incoming audio is sent and received. Within Record, the data will either be incoming or outgoing audio. This can be determined by querying the AudioDirection configuration.

LogEncodedAudioData: Whether the class will log encoded audio data.

This configuration controls whether the class will log encoded audio data when LogLevel is set to 3 (Debug). By default, this configuration is false, and the class will only log raw audio data.

LogLevel: The level of detail that is logged.

This configuration controls the level of detail that is logged through the Log event. Possible values are:


0 (None)	No messages are logged.
1 (Info - Default)	Informational events such as a call's status are logged.
2 (Verbose)	Detailed data such as SIP/SDP packet information is logged.
3 (Debug)	Debug data including all relevant sent and received audio bytes are logged.

Note: When LogLevel is set to 3 (Debug), we strongly advise against performing long-running operations inside of this event due to large amounts of sent and received audio bytes. For example, continuously updating an interface displaying the Log data will cause major performance issues in an application. It is recommended to set LogLevel to 3 only when writing Log data to a stream or file. There will be no performance issues in this case.

LogRTPPackets: Whether the class will log RTP packets.

This configuration controls whether the class will log received RTP packets when LogLevel is set to 3 (Debug). By default, this configuration is false, and the class will only log audio data.

RecordType: The type of recording the class will use.

This configuration sets the recording type the class will use when calling StartRecording. Possible values are 0 (Mono) and 1 (Stereo - Default).

RedirectLimit: The maximum number of redirects an outgoing call can experience.

This configuration limits the number of redirects, also known as forwards or diversions, an outgoing call can experience. If the number of redirects exceeds this value, an exception will be thrown. Note this value is 0 by default.

RefreshInterval: Used to manually specify the interval between subsequent registration messages after successful activation.

By default, this configuration is set to 0, and RegistrationInterval will denote the interval at which the current registration is refreshed. When set to a positive value, this configuration denotes the interval at which the current registration is refreshed, in seconds.

If the client wishes to refresh the registration prior to the expected expiration, this configuration should be set appropriately. To do so, after successful activation, the RegistrationInterval should be queried to determine the existing lifetime. This configuration should then be set to a value less than or equal to the queried RegistrationInterval. For example:

component.Activate(); int lifetime = component.Config("RegistrationInterval"); // Refresh the registration halfway through it's lifetime. component.Config("RefreshInterval=" + (lifetime / 2));

RegistrationInterval: Specifies the lifetime of the current registration.

Prior to activation, this configuration can be used to specify the clients desired lifetime for the current registration, in seconds. Note that this is merely a suggestion to the server, as the server determines the final lifetime of the registration. By default, this configuration is set to 60.

After calling Activate, this configuration will be equal to the lifetime of the registration as decided by the server. By default, the class will automatically attempt to refresh the registration every RegistrationInterval seconds. This value can be overridden by setting the RefreshInterval configuration to a positive value.

RingtoneFile: Specifies location of a WAV file to play when receiving an incoming call.

This configuration is used to specify a WAV file to play when receiving an incoming call. The ringtone will play until all incoming calls are answered declined, or ignored. Only WAV files with a sampling rate of 8 kHz and a bit depth of 16 bits per sample are supported (PCM 8 kHz 16-bit format).

SilenceInterval: Specifies the interval the class uses to detect periods of silence.

This configuration is used to specify the interval (in milliseconds) that the class uses to detect silence from a call's incoming audio stream. This will also directly control the rate that Silence will fire in the case silence is detected. Note this value is 1000 by default.

STUNPort: The port of the STUN server.

This configuration sets the port of the corresponding STUNServer. This value will be 3478 by default.

STUNServer: The address of the STUN Server.

This configuration sets the address of the STUN Server the class will use to communicate with the SIP Server.

UnregisterOnActivate: Specifies whether the class will unregister from the SIP Server before registration.

When calling Activate, this configuration will specify whether the component will unregister with the SIP Server before the initial registration. If False (default), the component will not attempt to unregister first, and will only perform registration.

VoiceIndex: The voice that will be used when playing text.

This configuration sets the voice that will be used when calling PlayText. The available voice tokens are listed in the registry under HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Speech\\Voices\\Tokens. Note this value will be 0 by default.

VoiceRate: The speaking rate of the voice when playing text.

This configuration specifies the speaking rate of the voice when calling PlayText. Supported values range from -10 (slowest) to 10 (fastest). Note this value will be 0 by default.

UDP Config Settings

CaptureIPPacketInfo: Used to capture the packet information.

If this is set to True, the component will capture the IP packet information.

The default value for this setting is False.

Note: This configuration setting is available only in Windows.

DelayHostResolution: Whether the hostname is resolved when RemoteHost is set.

This configuration setting specifies whether a hostname is resolved immediately when RemoteHost is set. If true the class will resolve the hostname and the IP address will be present in the RemoteHost property. If false, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may be called to manually resolve the value in RemoteHost at any time.

The default value is false.

DestinationAddress: Used to get the destination address from the packet information.

If CaptureIPPacketInfo is set to True, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event.

Note: This configuration setting is available only in Windows.

DontFragment: Used to set the Don't Fragment flag of outgoing packets.

When set to True, packets sent by the class will have the Don't Fragment flag set. The default value is False.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the class binds.

This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxPacketSize: The maximum length of the packets that can be received.

This configuration setting specifies the maximum size of the datagrams that the class will accept without truncation.

QOSDSCPValue: Used to specify an arbitrary QOS/DSCP setting (optional).

UseConnection must be True to use this configuration setting. This option allows you to specify an arbitrary DSCP value between 0 and 63. The default is 0. When set to the default value, the component will not set a DSCP value.

Note: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later.

QOSTrafficType: Used to specify QOS/DSCP settings (optional).

UseConnection must be True to use this setting. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).

Note: This configuration setting uses the qWAVE API and is available only on Windows Vista and Windows Server 2008 or above.

Note: QOSTrafficType must be set before setting Active to True.

ShareLocalPort: If set to True, allows more than one instance of the class to be active on the same local port.

This option must be set before the class is activated through the Active property or it will have no effect.

The default value for this setting is False.

SourceIPAddress: Used to set the source IP address used when sending a packet.

This configuration setting can be used to override the source IP address when sending a packet.

Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

SourceMacAddress: Used to set the source MAC address used when sending a packet.

This configuration setting can be used to override the source MAC address when sending a packet.

Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

UseConnection: Determines whether to use a connected socket.

UseConnection specifies whether or not the class should use a connected socket. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional Transmission Control Protocol (TCP) sense. It means only that the class will send and receive data to and from the specified destination.

The default value for this setting is False.

UseIPv6: Whether or not to use IPv6.

By default, the component expects an IPv4 address for local and remote host properties, and it will create an IPv4 socket. To use IPv6 instead, set this to True.

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for User Datagram Protocol (UDP) ports.

Determines whether timeouts are inactivity timeouts or absolute timeouts.