IPPhone Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TipvIPPhone

Remarks

The IPPhone component 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 component. 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 component has successfully activated/registered, the Activated event will fire and Active will be set to true. The component 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 component 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, after registration is complete, RegistrationInterval will be updated.

To prevent the registration from expiring, the component will refresh the registration within DoEvents, when needed. To ensure this occurs, we recommend calling DoEvents frequently. In a form-based application, we recommend doing so within a timer. 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 that in console applications, you must call DoEvents in a loop in order to provide accurate message processing, in addition to this case.

Security

By default, the component operates in plaintext for both SIP signaling and RTP (audio) communication. To enable completely secure communication using the component, 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 component 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 component to use during calls. First, you must call ListMicrophones and ListSpeakers. Doing so will populate the Microphone* properties and the Speaker* properties. 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 component will be stored in the Call* properties. 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 (Call-ID) that is unique to the call. After the method returns successfully, the call will be added to the Call* properties.

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

Transferring Calls

Ongoing calls can be transferred using Transfer. The component 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 component 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 component 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 component 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 component 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 Call-ID 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 component 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 component with short descriptions. Click on the links for further details.

ActiveThe current activation status of the component.
CallCountThe number of records in the Call arrays.
CallCallIdString representation of an immutable universally unique identifier (UUID) specific to the call.
CallConferenceIdA unique identifier for a conference call.
CallDurationElapsed time, in seconds, since the call has begun.
CallLastStatusThis property indicates the call's last response code.
CallLocalAddressThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
CallLocalPortThe UDP port in the local host where UDP binds.
CallMicrophoneThe microphone currently in use during the call.
CallMuteMicrophoneThis property can be set to mute the Microphone being used by the component in the given call.
CallMuteSpeakerThis property can be set to mute the Speaker being used by the component in the given call.
CallOutgoingIndicates whether the current call is outgoing.
CallPlayingIndicates whether the current call is playing audio via PlayText or PlayFile , or PlayBytes .
CallRecordingIndicates whether the current call is recording the received voice from the peer.
CallRemoteAddressThe address of the remote host we are communicating with.
CallRemotePortThe port of the remote host we are communicating with.
CallRemoteURIThis property communicates who to call via SIP.
CallRemoteUserThe username or telephone number of the remote user associated with the call.
CallSpeakerThe speaker currently in use during the call.
CallStartedAtThe number of milliseconds since 12:00:00 AM January 1, 1970 when this call started.
CallStateThis property indicates the state of the current call.
CallUserInputString representation of digits typed by the callee using their keypad.
CallViaThe Via header sent in the most recent SIP request.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe UDP port in the local host where UDP binds.
MicrophoneCountThe number of records in the Microphone arrays.
MicrophoneChannelsNumber specifying whether the device supports mono (1) or stereo (2) output.
MicrophoneManufacturerIdManufacturer identifier for the device driver for the device.
MicrophoneNameProduct name in a null-terminated string.
MicrophoneProductIdProduct identifier for the device as assigned by Windows.
MicrophoneSupportBitmask of optional functionalities supported by the device.
MicrophoneSupportedFormatsBitmask of standard formats that are supported.
PasswordThe password that is used when connecting to the SIP Server.
PortThe port on the SIP server the component is connecting to.
RTPSecurityModeSpecifies the security mode that will be used when transmitting RTP.
ServerThe address of the SIP Server.
SIPTransportProtocolSpecifies the transport protocol the component will use for SIP signaling.
SpeakerCountThe number of records in the Speaker arrays.
SpeakerChannelsNumber specifying whether the device supports mono (1) or stereo (2) output.
SpeakerManufacturerIdManufacturer identifier for the device driver for the device.
SpeakerNameProduct name in a null-terminated string.
SpeakerProductIdProduct identifier for the device as assigned by Windows.
SpeakerSupportBitmask of optional functionalities supported by the device.
SpeakerSupportedFormatsBitmask of standard formats that are supported.
SSLAcceptServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
UserThe username that is used when connecting to the SIP Server.

Method List


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

ActivateActivates the component.
AnswerAnswers an incoming phone call.
ConfigSets or retrieves a configuration setting.
DeactivateDeactivates the component.
DeclineDeclines an incoming phone call.
DialUsed to make a call.
DoEventsProcesses events from the internal message queue.
ForwardUsed to forward an incoming call.
HangupUsed to hang up a specific call.
HangupAllUsed to hang up all calls.
HoldPlaces a call on hold.
JoinConferenceAdds a call to a conference call.
LeaveConferenceRemoves a call from a conference call.
ListConferencesLists ongoing conference calls.
ListMicrophonesLists all microphones detected on the system.
ListSpeakersLists all speakers detected on the system.
MuteMicrophoneUsed to mute or unmute the microphone for a specified call.
MuteSpeakerUsed to mute or unmute the speaker for a specified call.
PingUsed to ping the server.
PlayBytesThis method is used to play bytes to a call.
PlayFilePlays audio from a WAV file to a call.
PlayTextPlays audio from a string to a call using Text-to-Speech.
ResetReset the component.
SetMicrophoneSets the microphone used by the component.
SetSpeakerSets the speaker used by the component.
StartRecordingUsed to start recording the audio of a call.
StopPlayingStops audio from playing to a call.
StopRecordingStops recording the audio of a call.
TransferTransfers a call.
TypeDigitUsed to type a digit.
UnholdTakes a call off hold.

Event List


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

ActivatedThis event is fired immediately after the component is activated.
CallReadyThis event is fired after a call has been answered, declined, or ignored.
CallStateChangedThis event is fired after a call's state has changed.
CallTerminatedThis event is fired after a call has been terminated.
DeactivatedThis event is fired immediately after the component is deactivated.
DialCompletedThis event is fired after the dial process has finished.
DigitThis event fires every time a digit is pressed using the keypad.
ErrorInformation about errors during data delivery.
IncomingCallThis event is fired when there's an incoming call.
LogThis event is fired once for each log message.
OutgoingCallThis event is fired when an outgoing call has been made.
PlayedThis event is fired after the component finishes playing available audio.
RecordThis event is fired when recorded audio data is available.
SilenceThis event is fired when the component detects silence from incoming audio streams.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Config Settings


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

AuthUserSpecifies the username to be used during client authentication.
CodecsComma-separated list of codecs the component can use.
DialTimeoutSpecifies the amount of time to wait for a response when making a call.
DomainCan be used to set the address of the SIP domain.
DtmfMethodThe method used for delivering the signals/tones sent when typing a digit.
LogEncodedAudioDataWhether the component will log encoded audio data.
LogLevelThe level of detail that is logged.
LogRTPPacketsWhether the component will log RTP packets.
RecordTypeThe type of recording the component will use.
RedirectLimitThe maximum number of redirects an outgoing call can experience.
RegistrationIntervalSpecifies the interval between subsequent registration messages.
SilenceIntervalSpecifies the interval the component uses to detect periods of silence.
STUNPortThe port of the STUN server.
STUNServerThe address of the STUN Server.
UnregisterOnActivateSpecifies whether the component will unregister from the SIP Server before registration.
VoiceIndexThe voice that will be used when playing text.
VoiceRateThe speaking rate of the voice when playing text.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Active Property (IPPhone Component)

The current activation status of the component.

Syntax

__property bool Active = { read=FActive };

Default Value

false

Remarks

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

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

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

Data Type

Boolean

CallCount Property (IPPhone Component)

The number of records in the Call arrays.

Syntax

__property int CallCount = { read=FCallCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at CallCount - 1.

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

Data Type

Integer

CallCallId Property (IPPhone Component)

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

Syntax

__property String CallCallId[int CallIndex] = { read=FCallCallId };

Default Value

""

Remarks

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

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

String

CallConferenceId Property (IPPhone Component)

A unique identifier for a conference call.

Syntax

__property String CallConferenceId[int CallIndex] = { read=FCallConferenceId };

Default Value

""

Remarks

A unique identifier for a conference call.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

String

CallDuration Property (IPPhone Component)

Elapsed time, in seconds, since the call has begun.

Syntax

__property int CallDuration[int CallIndex] = { read=FCallDuration };

Default Value

0

Remarks

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

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

Integer

CallLastStatus Property (IPPhone Component)

This property indicates the call's last response code.

Syntax

__property int CallLastStatus[int CallIndex] = { read=FCallLastStatus };

Default Value

0

Remarks

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

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

Integer

CallLocalAddress Property (IPPhone Component)

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

Syntax

__property String CallLocalAddress[int CallIndex] = { read=FCallLocalAddress };

Default Value

""

Remarks

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

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

String

CallLocalPort Property (IPPhone Component)

The UDP port in the local host where UDP binds.

Syntax

__property int CallLocalPort[int CallIndex] = { read=FCallLocalPort };

Default Value

0

Remarks

The UDP port in the local host where UDP binds.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

Integer

CallMicrophone Property (IPPhone Component)

The microphone currently in use during the call.

Syntax

__property String CallMicrophone[int CallIndex] = { read=FCallMicrophone };

Default Value

""

Remarks

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

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

String

CallMuteMicrophone Property (IPPhone Component)

This property can be set to mute the Microphone being used by the component in the given call.

Syntax

__property bool CallMuteMicrophone[int CallIndex] = { read=FCallMuteMicrophone, write=FSetCallMuteMicrophone };

Default Value

False

Remarks

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

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is not available at design time.

Data Type

Boolean

CallMuteSpeaker Property (IPPhone Component)

This property can be set to mute the Speaker being used by the component in the given call.

Syntax

__property bool CallMuteSpeaker[int CallIndex] = { read=FCallMuteSpeaker, write=FSetCallMuteSpeaker };

Default Value

False

Remarks

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

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is not available at design time.

Data Type

Boolean

CallOutgoing Property (IPPhone Component)

Indicates whether the current call is outgoing.

Syntax

__property bool CallOutgoing[int CallIndex] = { read=FCallOutgoing };

Default Value

False

Remarks

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

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

Boolean

CallPlaying Property (IPPhone Component)

Indicates whether the current call is playing audio via PlayText or PlayFile , or PlayBytes .

Syntax

__property bool CallPlaying[int CallIndex] = { read=FCallPlaying };

Default Value

False

Remarks

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.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

Boolean

CallRecording Property (IPPhone Component)

Indicates whether the current call is recording the received voice from the peer.

Syntax

__property bool CallRecording[int CallIndex] = { read=FCallRecording };

Default Value

False

Remarks

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.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

Boolean

CallRemoteAddress Property (IPPhone Component)

The address of the remote host we are communicating with.

Syntax

__property String CallRemoteAddress[int CallIndex] = { read=FCallRemoteAddress };

Default Value

""

Remarks

The address of the remote host we are communicating with.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

String

CallRemotePort Property (IPPhone Component)

The port of the remote host we are communicating with.

Syntax

__property int CallRemotePort[int CallIndex] = { read=FCallRemotePort };

Default Value

0

Remarks

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

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

Integer

CallRemoteURI Property (IPPhone Component)

This property communicates who to call via SIP.

Syntax

__property String CallRemoteURI[int CallIndex] = { read=FCallRemoteURI };

Default Value

""

Remarks

This field communicates who to call via SIP. This value contains the CallRemoteUser, CallRemoteAddress, and the CallRemotePort, and has the following format:

sip:user@host:port

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

String

CallRemoteUser Property (IPPhone Component)

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

Syntax

__property String CallRemoteUser[int CallIndex] = { read=FCallRemoteUser };

Default Value

""

Remarks

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

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

String

CallSpeaker Property (IPPhone Component)

The speaker currently in use during the call.

Syntax

__property String CallSpeaker[int CallIndex] = { read=FCallSpeaker };

Default Value

""

Remarks

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

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

String

CallStartedAt Property (IPPhone Component)

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

Syntax

__property __int64 CallStartedAt[int CallIndex] = { read=FCallStartedAt };

Default Value

0

Remarks

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

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

Long64

CallState Property (IPPhone Component)

This property indicates the state of the current call.

Syntax

__property TipvIPPhoneCallStates CallState[int CallIndex] = { read=FCallState };
enum TipvIPPhoneCallStates { csInactive=0, csConnecting=1, csAutConnecting=2, csRinging=3, csActive=4, csActiveInConference=5, csDisconnecting=6, csAutDisconnecting=7, csHolding=8, csOnHold=9, csUnholding=10, csTransferring=11, csAutTransferring=12 };

Default Value

csInactive

Remarks

This property 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.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

Integer

CallUserInput Property (IPPhone Component)

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

Syntax

__property String CallUserInput[int CallIndex] = { read=FCallUserInput };

Default Value

""

Remarks

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

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

String

CallVia Property (IPPhone Component)

The Via header sent in the most recent SIP request.

Syntax

__property String CallVia[int CallIndex] = { read=FCallVia };

Default Value

""

Remarks

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.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

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

Data Type

String

LocalHost Property (IPPhone Component)

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

Syntax

__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };

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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component 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 multi-homed 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 Component)

The UDP port in the local host where UDP binds.

Syntax

__property int LocalPort = { read=FLocalPort, write=FSetLocalPort };

Default Value

0

Remarks

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

Setting it to 0 (default) enables the 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 component is Active. Any attempt to set the LocalPort property when the component is Active will generate an error.

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

Data Type

Integer

MicrophoneCount Property (IPPhone Component)

The number of records in the Microphone arrays.

Syntax

__property int MicrophoneCount = { read=FMicrophoneCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at MicrophoneCount - 1.

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

Data Type

Integer

MicrophoneChannels Property (IPPhone Component)

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

Syntax

__property int MicrophoneChannels[int MicrophoneIndex] = { read=FMicrophoneChannels };

Default Value

0

Remarks

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

The MicrophoneIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MicrophoneCount property.

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

Data Type

Integer

MicrophoneManufacturerId Property (IPPhone Component)

Manufacturer identifier for the device driver for the device.

Syntax

__property int MicrophoneManufacturerId[int MicrophoneIndex] = { read=FMicrophoneManufacturerId };

Default Value

0

Remarks

Manufacturer identifier for the device driver for the device.

The MicrophoneIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MicrophoneCount property.

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

Data Type

Integer

MicrophoneName Property (IPPhone Component)

Product name in a null-terminated string.

Syntax

__property String MicrophoneName[int MicrophoneIndex] = { read=FMicrophoneName };

Default Value

""

Remarks

Product name in a null-terminated string.

The MicrophoneIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MicrophoneCount property.

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

Data Type

String

MicrophoneProductId Property (IPPhone Component)

Product identifier for the device as assigned by Windows.

Syntax

__property int MicrophoneProductId[int MicrophoneIndex] = { read=FMicrophoneProductId };

Default Value

0

Remarks

Product identifier for the device as assigned by Windows.

The MicrophoneIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MicrophoneCount property.

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

Data Type

Integer

MicrophoneSupport Property (IPPhone Component)

Bitmask of optional functionalities supported by the device.

Syntax

__property int MicrophoneSupport[int MicrophoneIndex] = { read=FMicrophoneSupport };

Default Value

0

Remarks

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

BitmaskFlagDescription
0x0001WAVECAPS_PITCHSupports pitch control.
0x0002WAVECAPS_PLAYBACKRATESupports playback rate control.
0x0004WAVECAPS_VOLUMESupports volume control.
0x0008WAVECAPS_LRVOLUMESupports separate left and right volume control.
0x0010WAVECAPS_SYNCThe driver is synchronous and will block while playing a buffer.
0x0020WAVECAPS_SAMPLEACCURATE Returns sample-accurate position information.

The MicrophoneIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MicrophoneCount property.

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

Data Type

Integer

MicrophoneSupportedFormats Property (IPPhone Component)

Bitmask of standard formats that are supported.

Syntax

__property int MicrophoneSupportedFormats[int MicrophoneIndex] = { read=FMicrophoneSupportedFormats };

Default Value

0

Remarks

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

BitmaskFormatDescription
0x00000001WAVE_FORMAT_1M0811.025 kHz, mono, 8-bit
0x00000002WAVE_FORMAT_1S0811.025 kHz, stereo, 8-bit
0x00000004WAVE_FORMAT_1M1611.025 kHz, mono, 16-bit
0x00000008WAVE_FORMAT_1S1611.025 kHz, stereo, 16-bit
0x00000010WAVE_FORMAT_2M0822.05 kHz, mono, 8-bit
0x00000020WAVE_FORMAT_2S0822.05 kHz, stereo, 8-bit
0x00000040WAVE_FORMAT_2M1622.05 kHz, mono, 16-bit
0x00000080WAVE_FORMAT_2S1622.05 kHz, stereo, 16-bit
0x00000100WAVE_FORMAT_4M0844.1 kHz, mono, 8-bit
0x00000200WAVE_FORMAT_4S0844.1 kHz, stereo, 8-bit
0x00000400WAVE_FORMAT_4M1644.1 kHz, mono, 16-bit
0x00000800WAVE_FORMAT_4S1644.1 kHz, stereo, 16-bit
0x00001000WAVE_FORMAT_48M0848 kHz, mono, 8-bit
0x00002000WAVE_FORMAT_48S0848 kHz, stereo, 8-bit
0x00004000WAVE_FORMAT_48M1648 kHz, mono, 16-bit
0x00008000WAVE_FORMAT_48S1648 kHz, stereo, 16-bit
0x00010000WAVE_FORMAT_96M0896 kHz, mono, 8-bit
0x00020000WAVE_FORMAT_96S0896 kHz, stereo, 8-bit
0x00040000WAVE_FORMAT_96M1696 kHz, mono, 16-bit
0x00080000WAVE_FORMAT_96S1696 kHz, stereo, 16-bit

The MicrophoneIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MicrophoneCount property.

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

Data Type

Integer

Password Property (IPPhone Component)

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

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

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 component via Activate.

This property is not available at design time.

Data Type

String

Port Property (IPPhone Component)

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

Syntax

__property int Port = { read=FPort, write=FSetPort };

Default Value

5060

Remarks

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

Data Type

Integer

RTPSecurityMode Property (IPPhone Component)

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

Syntax

__property TipvIPPhoneRTPSecurityModes RTPSecurityMode = { read=FRTPSecurityMode, write=FSetRTPSecurityMode };
enum TipvIPPhoneRTPSecurityModes { etNone=0, etSDES=1, etDTLS=2 };

Default Value

etNone

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 Component)

The address of the SIP Server.

Syntax

__property String Server = { read=FServer, write=FSetServer };

Default Value

""

Remarks

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

Data Type

String

SIPTransportProtocol Property (IPPhone Component)

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

Syntax

__property TipvIPPhoneSIPTransportProtocols SIPTransportProtocol = { read=FSIPTransportProtocol, write=FSetSIPTransportProtocol };
enum TipvIPPhoneSIPTransportProtocols { tpUDP=0, tpTCP=1, tpTLS=2 };

Default Value

tpUDP

Remarks

This property specifies which transport protocol (UDP, TCP, TLS) the component 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

SpeakerCount Property (IPPhone Component)

The number of records in the Speaker arrays.

Syntax

__property int SpeakerCount = { read=FSpeakerCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at SpeakerCount - 1.

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

Data Type

Integer

SpeakerChannels Property (IPPhone Component)

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

Syntax

__property int SpeakerChannels[int SpeakerIndex] = { read=FSpeakerChannels };

Default Value

0

Remarks

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

The SpeakerIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SpeakerCount property.

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

Data Type

Integer

SpeakerManufacturerId Property (IPPhone Component)

Manufacturer identifier for the device driver for the device.

Syntax

__property int SpeakerManufacturerId[int SpeakerIndex] = { read=FSpeakerManufacturerId };

Default Value

0

Remarks

Manufacturer identifier for the device driver for the device.

The SpeakerIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SpeakerCount property.

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

Data Type

Integer

SpeakerName Property (IPPhone Component)

Product name in a null-terminated string.

Syntax

__property String SpeakerName[int SpeakerIndex] = { read=FSpeakerName };

Default Value

""

Remarks

Product name in a null-terminated string.

The SpeakerIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SpeakerCount property.

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

Data Type

String

SpeakerProductId Property (IPPhone Component)

Product identifier for the device as assigned by Windows.

Syntax

__property int SpeakerProductId[int SpeakerIndex] = { read=FSpeakerProductId };

Default Value

0

Remarks

Product identifier for the device as assigned by Windows.

The SpeakerIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SpeakerCount property.

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

Data Type

Integer

SpeakerSupport Property (IPPhone Component)

Bitmask of optional functionalities supported by the device.

Syntax

__property int SpeakerSupport[int SpeakerIndex] = { read=FSpeakerSupport };

Default Value

0

Remarks

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

BitmaskFlagDescription
0x0001WAVECAPS_PITCHSupports pitch control.
0x0002WAVECAPS_PLAYBACKRATESupports playback rate control.
0x0004WAVECAPS_VOLUMESupports volume control.
0x0008WAVECAPS_LRVOLUMESupports separate left and right volume control.
0x0010WAVECAPS_SYNCThe driver is synchronous and will block while playing a buffer.
0x0020WAVECAPS_SAMPLEACCURATE Returns sample-accurate position information.

The SpeakerIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SpeakerCount property.

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

Data Type

Integer

SpeakerSupportedFormats Property (IPPhone Component)

Bitmask of standard formats that are supported.

Syntax

__property int SpeakerSupportedFormats[int SpeakerIndex] = { read=FSpeakerSupportedFormats };

Default Value

0

Remarks

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

BitmaskFormatDescription
0x00000001WAVE_FORMAT_1M0811.025 kHz, mono, 8-bit
0x00000002WAVE_FORMAT_1S0811.025 kHz, stereo, 8-bit
0x00000004WAVE_FORMAT_1M1611.025 kHz, mono, 16-bit
0x00000008WAVE_FORMAT_1S1611.025 kHz, stereo, 16-bit
0x00000010WAVE_FORMAT_2M0822.05 kHz, mono, 8-bit
0x00000020WAVE_FORMAT_2S0822.05 kHz, stereo, 8-bit
0x00000040WAVE_FORMAT_2M1622.05 kHz, mono, 16-bit
0x00000080WAVE_FORMAT_2S1622.05 kHz, stereo, 16-bit
0x00000100WAVE_FORMAT_4M0844.1 kHz, mono, 8-bit
0x00000200WAVE_FORMAT_4S0844.1 kHz, stereo, 8-bit
0x00000400WAVE_FORMAT_4M1644.1 kHz, mono, 16-bit
0x00000800WAVE_FORMAT_4S1644.1 kHz, stereo, 16-bit
0x00001000WAVE_FORMAT_48M0848 kHz, mono, 8-bit
0x00002000WAVE_FORMAT_48S0848 kHz, stereo, 8-bit
0x00004000WAVE_FORMAT_48M1648 kHz, mono, 16-bit
0x00008000WAVE_FORMAT_48S1648 kHz, stereo, 16-bit
0x00010000WAVE_FORMAT_96M0896 kHz, mono, 8-bit
0x00020000WAVE_FORMAT_96S0896 kHz, stereo, 8-bit
0x00040000WAVE_FORMAT_96M1696 kHz, mono, 16-bit
0x00080000WAVE_FORMAT_96S1696 kHz, stereo, 16-bit

The SpeakerIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SpeakerCount property.

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

Data Type

Integer

SSLAcceptServerCertEncoded Property (IPPhone Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (IPPhone Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (IPPhone Component)

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

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

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

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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. PKCS12 certificate store).

This property is not available at design time.

Data Type

Byte Array

SSLCertStorePassword Property (IPPhone Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

SSLCertStoreType Property (IPPhone Component)

This is the type of certificate store for this certificate.

Syntax

__property TipvIPPhoneSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };
enum TipvIPPhoneSSLCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used the component will automatically determine the type. This property 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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 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 SSLCertStore and set SSLCertStorePassword 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.

This property is not available at design time.

Data Type

Integer

SSLCertSubject Property (IPPhone Component)

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

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

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 property 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 displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

This property is not available at design time.

Data Type

String

User Property (IPPhone Component)

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

Syntax

__property String User = { read=FUser, write=FSetUser };

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 component via Activate.

This property is not available at design time.

Data Type

String

Activate Method (IPPhone Component)

Activates the component.

Syntax

void __fastcall Activate();

Remarks

This method is used to activate the component 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.

Answer Method (IPPhone Component)

Answers an incoming phone call.

Syntax

void __fastcall Answer(String callId);

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.

Config Method (IPPhone Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

Deactivate Method (IPPhone Component)

Deactivates the component.

Syntax

void __fastcall Deactivate();

Remarks

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

Decline Method (IPPhone Component)

Declines an incoming phone call.

Syntax

void __fastcall Decline(String callId);

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); };

Dial Method (IPPhone Component)

Used to make a call.

Syntax

String __fastcall Dial(String number, String callerNumber, bool wait);

Remarks

This method is used to make a call to a particular user, given by number. This method should only be called after the component 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 component 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 component should connect synchronously or asynchronously to the call. If True, the component will connect synchronously, and won't return until the call has been answered, declined, or ignored. If False, the component 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 component 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"); }

DoEvents Method (IPPhone Component)

Processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

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

Forward Method (IPPhone Component)

Used to forward an incoming call.

Syntax

void __fastcall Forward(String callId, String number);

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"); };

Hangup Method (IPPhone Component)

Used to hang up a specific call.

Syntax

void __fastcall Hangup(String callId);

Remarks

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

HangupAll Method (IPPhone Component)

Used to hang up all calls.

Syntax

void __fastcall HangupAll();

Remarks

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

Hold Method (IPPhone Component)

Places a call on hold.

Syntax

void __fastcall Hold(String callId);

Remarks

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

JoinConference Method (IPPhone Component)

Adds a call to a conference call.

Syntax

void __fastcall JoinConference(String callId, String conferenceId);

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 component will start a new conference call with this ID.

LeaveConference Method (IPPhone Component)

Removes a call from a conference call.

Syntax

void __fastcall LeaveConference(String callId);

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.

ListConferences Method (IPPhone Component)

Lists ongoing conference calls.

Syntax

String __fastcall ListConferences();

Remarks

This method is used to list ongoing conferences any of the component'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, ...

ListMicrophones Method (IPPhone Component)

Lists all microphones detected on the system.

Syntax

void __fastcall ListMicrophones();

Remarks

This method lists all microphones detected on the system. Calling this method will populate the Microphone* properties.

ListSpeakers Method (IPPhone Component)

Lists all speakers detected on the system.

Syntax

void __fastcall ListSpeakers();

Remarks

This method lists all speakers detected on the system. Calling this method will populate the Speaker* properties.

MuteMicrophone Method (IPPhone Component)

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

Syntax

void __fastcall MuteMicrophone(String callId, bool mute);

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.

MuteSpeaker Method (IPPhone Component)

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

Syntax

void __fastcall MuteSpeaker(String callId, bool mute);

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.

Ping Method (IPPhone Component)

Used to ping the server.

Syntax

void __fastcall Ping(int timeout);

Remarks

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

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

PlayBytes Method (IPPhone Component)

This method is used to play bytes to a call.

Syntax

void __fastcall PlayBytes(String callId, DynamicArray<Byte> bytesToPlay, bool lastBlock);

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 component 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 component will be considered to be playing audio.

If lastBlock is false, this indicates that the component 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 }

PlayFile Method (IPPhone Component)

Plays audio from a WAV file to a call.

Syntax

void __fastcall PlayFile(String callId, String wavFile);

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 component 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.

PlayText Method (IPPhone Component)

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

Syntax

void __fastcall PlayText(String callId, String text);

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 component 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.

Reset Method (IPPhone Component)

Reset the component.

Syntax

void __fastcall Reset();

Remarks

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

SetMicrophone Method (IPPhone Component)

Sets the microphone used by the component.

Syntax

void __fastcall SetMicrophone(String microphone);

Remarks

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

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 Microphone* properties.

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

SetSpeaker Method (IPPhone Component)

Sets the speaker used by the component.

Syntax

void __fastcall SetSpeaker(String speaker);

Remarks

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

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 Speaker* properties.

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

StartRecording Method (IPPhone Component)

Used to start recording the audio of a call.

Syntax

void __fastcall StartRecording(String callId, String filename);

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()); };

StopPlaying Method (IPPhone Component)

Stops audio from playing to a call.

Syntax

void __fastcall StopPlaying(String callId);

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.

StopRecording Method (IPPhone Component)

Stops recording the audio of a call.

Syntax

void __fastcall StopRecording(String callId);

Remarks

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

Transfer Method (IPPhone Component)

Transfers a call.

Syntax

void __fastcall Transfer(String callId, String number);

Remarks

This method is used to transfer a call, specified by callId, to the phone number given by number. The component 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 component 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:

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.

TypeDigit Method (IPPhone Component)

Used to type a digit.

Syntax

void __fastcall TypeDigit(String callId, String digit);

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, *, #

Unhold Method (IPPhone Component)

Takes a call off hold.

Syntax

void __fastcall Unhold(String callId);

Remarks

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

Activated Event (IPPhone Component)

This event is fired immediately after the component is activated.

Syntax

typedef struct {
} TipvIPPhoneActivatedEventParams;
typedef void __fastcall (__closure *TipvIPPhoneActivatedEvent)(System::TObject* Sender, TipvIPPhoneActivatedEventParams *e);
__property TipvIPPhoneActivatedEvent OnActivated = { read=FOnActivated, write=FOnActivated };

Remarks

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

CallReady Event (IPPhone Component)

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

Syntax

typedef struct {
  String CallId;
} TipvIPPhoneCallReadyEventParams;
typedef void __fastcall (__closure *TipvIPPhoneCallReadyEvent)(System::TObject* Sender, TipvIPPhoneCallReadyEventParams *e);
__property TipvIPPhoneCallReadyEvent OnCallReady = { read=FOnCallReady, write=FOnCallReady };

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 component 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 Call-ID of the call.

CallStateChanged Event (IPPhone Component)

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

Syntax

typedef struct {
  String CallId;
  int State;
} TipvIPPhoneCallStateChangedEventParams;
typedef void __fastcall (__closure *TipvIPPhoneCallStateChangedEvent)(System::TObject* Sender, TipvIPPhoneCallStateChangedEventParams *e);
__property TipvIPPhoneCallStateChangedEvent OnCallStateChanged = { read=FOnCallStateChanged, write=FOnCallStateChanged };

Remarks

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

The CallId parameter is the unique Call-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 Component)

This event is fired after a call has been terminated.

Syntax

typedef struct {
  String CallId;
} TipvIPPhoneCallTerminatedEventParams;
typedef void __fastcall (__closure *TipvIPPhoneCallTerminatedEvent)(System::TObject* Sender, TipvIPPhoneCallTerminatedEventParams *e);
__property TipvIPPhoneCallTerminatedEvent OnCallTerminated = { read=FOnCallTerminated, write=FOnCallTerminated };

Remarks

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

The CallId parameter is the unique Call-ID of the call.

Deactivated Event (IPPhone Component)

This event is fired immediately after the component is deactivated.

Syntax

typedef struct {
} TipvIPPhoneDeactivatedEventParams;
typedef void __fastcall (__closure *TipvIPPhoneDeactivatedEvent)(System::TObject* Sender, TipvIPPhoneDeactivatedEventParams *e);
__property TipvIPPhoneDeactivatedEvent OnDeactivated = { read=FOnDeactivated, write=FOnDeactivated };

Remarks

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

DialCompleted Event (IPPhone Component)

This event is fired after the dial process has finished.

Syntax

typedef struct {
  String OriginalCallId;
  String CallId;
  String Caller;
  String Callee;
  int ErrorCode;
  String Description;
} TipvIPPhoneDialCompletedEventParams;
typedef void __fastcall (__closure *TipvIPPhoneDialCompletedEvent)(System::TObject* Sender, TipvIPPhoneDialCompletedEventParams *e);
__property TipvIPPhoneDialCompletedEvent OnDialCompleted = { read=FOnDialCompleted, write=FOnDialCompleted };

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 component 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:

  1. The outgoing call has not been redirected. In this case, CallId is equal to OriginalCallId, and the value returned by Dial is correct.
  2. 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 Component)

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

Syntax

typedef struct {
  String CallId;
  String Digit;
} TipvIPPhoneDigitEventParams;
typedef void __fastcall (__closure *TipvIPPhoneDigitEvent)(System::TObject* Sender, TipvIPPhoneDigitEventParams *e);
__property TipvIPPhoneDigitEvent OnDigit = { read=FOnDigit, write=FOnDigit };

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 component's inputs via TypeDigit. Detectable inputs include: 0-9, *, #

The CallId parameter is the unique Call-ID of the call.

Error Event (IPPhone Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TipvIPPhoneErrorEventParams;
typedef void __fastcall (__closure *TipvIPPhoneErrorEvent)(System::TObject* Sender, TipvIPPhoneErrorEventParams *e);
__property TipvIPPhoneErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

ErrorCode contains an error code and Description 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 Component)

This event is fired when there's an incoming call.

Syntax

typedef struct {
  String CallId;
  String RemoteUser;
} TipvIPPhoneIncomingCallEventParams;
typedef void __fastcall (__closure *TipvIPPhoneIncomingCallEvent)(System::TObject* Sender, TipvIPPhoneIncomingCallEventParams *e);
__property TipvIPPhoneIncomingCallEvent OnIncomingCall = { read=FOnIncomingCall, write=FOnIncomingCall };

Remarks

The IncomingCall event will fire after an incoming call is detected.

The CallId parameter specifies the unique Call-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.

Log Event (IPPhone Component)

This event is fired once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TipvIPPhoneLogEventParams;
typedef void __fastcall (__closure *TipvIPPhoneLogEvent)(System::TObject* Sender, TipvIPPhoneLogEventParams *e);
__property TipvIPPhoneLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

This event fires once for each log message generated by the component. 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 Component)

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

Syntax

typedef struct {
  String CallId;
  String RemoteUser;
} TipvIPPhoneOutgoingCallEventParams;
typedef void __fastcall (__closure *TipvIPPhoneOutgoingCallEvent)(System::TObject* Sender, TipvIPPhoneOutgoingCallEventParams *e);
__property TipvIPPhoneOutgoingCallEvent OnOutgoingCall = { read=FOnOutgoingCall, write=FOnOutgoingCall };

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 Call-ID of the call.

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

Played Event (IPPhone Component)

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

Syntax

typedef struct {
  String CallId;
  bool Completed;
} TipvIPPhonePlayedEventParams;
typedef void __fastcall (__closure *TipvIPPhonePlayedEvent)(System::TObject* Sender, TipvIPPhonePlayedEventParams *e);
__property TipvIPPhonePlayedEvent OnPlayed = { read=FOnPlayed, write=FOnPlayed };

Remarks

The Played event will fire after the component 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 component 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 component 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 Call-ID of the call.

Record Event (IPPhone Component)

This event is fired when recorded audio data is available.

Syntax

typedef struct {
  String CallId;
  String RecordedData;
  DynamicArray<Byte> RecordedDataB;
} TipvIPPhoneRecordEventParams;
typedef void __fastcall (__closure *TipvIPPhoneRecordEvent)(System::TObject* Sender, TipvIPPhoneRecordEventParams *e);
__property TipvIPPhoneRecordEvent OnRecord = { read=FOnRecord, write=FOnRecord };

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 Call-ID of the call.

Silence Event (IPPhone Component)

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

Syntax

typedef struct {
  String CallId;
} TipvIPPhoneSilenceEventParams;
typedef void __fastcall (__closure *TipvIPPhoneSilenceEvent)(System::TObject* Sender, TipvIPPhoneSilenceEventParams *e);
__property TipvIPPhoneSilenceEvent OnSilence = { read=FOnSilence, write=FOnSilence };

Remarks

The Silence event will fire every second the component 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 Call-ID of the call.

SSLServerAuthentication Event (IPPhone Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TipvIPPhoneSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TipvIPPhoneSSLServerAuthenticationEvent)(System::TObject* Sender, TipvIPPhoneSSLServerAuthenticationEventParams *e);
__property TipvIPPhoneSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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 Component)

Shows the progress of the secure connection.

Syntax

typedef struct {
  String Message;
} TipvIPPhoneSSLStatusEventParams;
typedef void __fastcall (__closure *TipvIPPhoneSSLStatusEvent)(System::TObject* Sender, TipvIPPhoneSSLStatusEventParams *e);
__property TipvIPPhoneSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (IPPhone Component)

The component 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 component, access to these internal properties is provided through the Config method.

IPPhone Config Settings

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 component can use.

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

8,0,3

The following integers correspond to these supported codecs:

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

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 component 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.

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)
LogEncodedAudioData:   Whether the component will log encoded audio data.

This configuration controls whether the component will log encoded audio data when LogLevel is set to 3 (Debug). By default, this configuration is false, and the component 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 component will log RTP packets.

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

RecordType:   The type of recording the component will use.

This configuration sets the recording type the component 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.

RegistrationInterval:   Specifies the interval between subsequent registration messages.

Once the component is activated, this configuration specifies the amount of time (in seconds) between subsequent registrations. This is used to refresh the current registration and prevent the session's expiration.

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

This configuration is used to specify the interval (in milliseconds) that the component 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 component will use to communicate with the SIP Server.

UnregisterOnActivate:   Specifies whether the component 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 at HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Speech\\Voices. 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.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to true tells the component to use the internal implementation instead of using the system security libraries.

This setting is set to false by default on all platforms.

Trappable Errors (IPPhone Component)

IPPHONE Errors

201   Timeout error. The error description contains detailed information.
202   Invalid argument error. The error description contains detailed information.
601   Protocol error. The error description contains detailed information.

UDP Errors

104   UDP is already Active.
106   You cannot change the LocalPort while the component is Active.
107   You cannot change the LocalHost at this time. A connection is in progress.
109   The component must be Active for this operation.
112   Cannot change MaxPacketSize while the component is Active.
113   Cannot change ShareLocalPort option while the component is Active.
114   Cannot change RemoteHost when UseConnection is set and the component Active.
115   Cannot change RemotePort when UseConnection is set and the component is Active.
116   RemotePort can't be zero when UseConnection is set. Please specify a valid service port number.
117   Cannot change UseConnection while the component is Active.
118   Message can't be longer than MaxPacketSize.
119   Message too short.
434   Unable to convert string to selected CodePage

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).