Ozeki VoIP SDK Class library
ISoftPhone Interface
NamespacesOzeki.VoIP.SDKISoftPhone
Defines methods, events for softphone functionality.
Declaration Syntax
C#Visual BasicVisual C++
public interface ISoftPhone
Public Interface ISoftPhone
public interface class ISoftPhone
Members
All MembersMethodsPropertiesEvents



IconMemberDescription
BeginNatDiscovery(String, NatDiscoveryCallback)
Begins the NAT discovery process using the default STUN server (stun.ozekiphone.com).

BeginNatDiscovery(String, String, NatDiscoveryCallback)
Begins the NAT discovery process.

Close()()()()
Closes the softphone and frees the resources.

Codecs
Gets the list of available codecs in the softphone.

CreateCallObject(IPhoneLine, String)
Creates a phone call with the specified dialed number.

CreateCallObject(IPhoneLine, DialParameters)
Creates a phone call with the specified parameters.

CreateDirectIPCallObject(IPhoneLine, DirectIPDialParameters, String)
Makes a call to a remote address.

CreateDirectIPPhoneLine(DirectIPPhoneLineConfig)
Creates a line with the specified configuration which can receive calls via direct IP dialing.

CreatePhoneLine(SIPAccount)
Creates a line for the specified SIP account which uses default settings (UDP protocol for SIP, automatic NAT configuration, no SRTP support).

CreatePhoneLine(PhoneLineConfiguration)
Creates a line with the specified configuration.

DisableCodec(Int32)
Disables a codec globally in the softphone.

DisableCodec(CodecPayloadType)
Disables a codec globally in the softphone.

EnableCodec(Int32)
Enables the specified codec in the softphone globally.

EnableCodec(CodecPayloadType)
Enables a codec globally in the softphone.

EnableServerNameValidation(Boolean)
Enables or disables server name validation.

IncomingCall
Occurs when an incoming call received from a remote host.

RegisterPhoneLine(IPhoneLine)
Registers the SIP account to the softphone. If SIP account registration required, the softphone will send a register request asynchronously to the SIP registrar/proxy.

SetPortRange(Int32, Int32)
Sets the RTP port range.

SetSDPMessageManipulator(ISDPMessageManipulator)
Sets an SDP message manipulator to the softphone which can modify incoming and outgoing SDP messages.

SetSIPMessageManipulator(ISIPMessageManipulator)
Sets an SDP message manipulator to the softphone which can modify incoming and outgoing SIP messages.

UnregisterPhoneLine(IPhoneLine)
Unregisters the SIP account from the softphone. If the SIP account is registered with a SIP server, the softphone will send an unregister request asynchronously to the SIP registrar/proxy.

VideoEncoderQuality
Gets or sets the quality of the sent video.

Remarks
This interface contains all the functionality of a traditional telephone device with the ability of multiple call handling. The codecs it uses can be set and changed dinamically.
Exceptions
ExceptionCondition
LicenseExceptionThrows a license exception, when call limit or phone line registration limit reached.

Assembly: VoIPSDK (Module: VoIPSDK.dll) Version: 11.2.4.290