Zoiper COM API  1.1
 All Classes Files Functions Typedefs Enumerations Enumerator Properties
IZoiperConfig Interface Reference

Configuration interface. More...

Public Member Functions

void SetSIPIAXPorts ([in] LONG sip_port, [in] LONG iax_port)
 Set SIP and IAX2 listen ports. More...
 
void NumberOfCallsLimit ([in] LONG call_limit)
 Set maximum amount of calls. More...
 

Properties

VARIANT_BOOL PopupMenuOnIncomingCall [get, set]
 Enables the pop-up menu on incoming new call. More...
 
EOnTransferRequestStyle OnTransferRequest [get, set]
 Specifies the behavior of the phone on transfer request from the remote peer. More...
 
VARIANT_BOOL UseEchoCancelation [get, set]
 Enables acustic echo cancelation audio filter. More...
 
VARIANT_BOOL EnableDebugLog [get, set]
 Enables the debug logging to a file. More...
 
BSTR DebugLogPath [get, set]
 Specifies the path where the debug log files will be created. More...
 
VARIANT_BOOL EnableDebugLargeDump [get, set]
 Enables the generation of a large crash dump file that includes memory state. More...
 
BSTR Restrictions [get, set]
 Specifies the interface resrtictions that are going to be applied to the whole interface. More...
 
VARIANT_BOOL ServerSideAutoAnswer [get, set]
 Enables the ability of the phone to favor SIP Call-Info auto answer headers. More...
 
VARIANT_BOOL AutoAnswer [get, set]
 Enables the auto answer feature of the phone. More...
 
LONG AutoAnswerSeconds [get, set]
 Specifies the delay before the call is auto answered. More...
 
VARIANT_BOOL AutoAnswerPlaySound [get, set]
 Enables the sound played upon auto answering. More...
 
LONG AudioInputVolume [get, set]
 Specifies the input (microphone) volume. More...
 
LONG AudioOutputVolume [get, set]
 Specifies the output (speakers, headphones) volume. More...
 
BSTR MediaDSCP [get, set]
 Specifies the DSCP tagging for the outbound media streams. More...
 
VARIANT_BOOL Forwarding [get, set]
 Enables the automatic call forwarding. More...
 
LONG ForwardingSeconds [get, set]
 Specifies the time in seconds to wait before the call to be forwarded. More...
 
BSTR ForwardingExtension [get, set]
 Specifies the phone number to which the call should be forwarded. More...
 
VARIANT_BOOL RecordCalls [get, set]
 Enables the automatic call recording. More...
 
BSTR RecordPath [get, set]
 Specifies the path where the call recordings are going to be stored. More...
 
BSTR RecordFileName [get, set]
 Specifies the file name pattern that is going to be used to name the audio conversation recording files. More...
 
BSTR SIPTLSCertificateFile [get, set]
 Specifies the file path for additional TLS certificate. More...
 
LONG RTPPortBase [get, set]
 Specifies the port base used to create RTP sessions. More...
 
VARIANT_BOOL RTPUseRandomPort [get, set]
 Enables the usage of random value for RTP port base. More...
 
VARIANT_BOOL ChatPlaySound [get, set]
 Enables the playing of sound in case of incoming chat message. More...
 
VARIANT_BOOL ChatBlinkWindow [get, set]
 Enables the blinking of the chat window in the taskbar. More...
 
VARIANT_BOOL ChatShowDialog [get, set]
 Enables the showing of a chat dialog upon receiving a new chat message. More...
 
VARIANT_BOOL DoNotShowError [get, set]
 Enables the error messages shown by the phone. More...
 
BSTR PhoneInfoText [get, set]
 Specifies the default information text displayed in the filter field of the phone. More...
 
VARIANT_BOOL PopupOnIncomingCall [get, set]
 Enables the phone to pop-up in front of the other applications when there is a new incoming call or chat message. More...
 
VARIANT_BOOL RingWhenTalking [get, set]
 Enables the ringing sound in case of incoming call while there is already another established call. More...
 
VARIANT_BOOL PCSpeakerRing [get, set]
 Enables the ringing using the PC speaker. More...
 
VARIANT_BOOL DisableDTMFSounds [get, set]
 Enables the sounds played on the output device when a DTMF signal is sent over the line. More...
 
VARIANT_BOOL MuteEarlyMedia [get, set]
 Enables the automatic muting of early media audio received from the the PBX on outgoing calls if available. More...
 
VARIANT_BOOL UseExternalDeviceYealink [get, set]
 Enables the phone to use external hand/headsets from the Yealink family. More...
 
VARIANT_BOOL UseExternalDeviceGeneric [get, set]
 Enables the phone to use generic external hand/headsets phone HID (Human Interface Device) devices. More...
 
VARIANT_BOOL UseAutomaticGainControl [get, set]
 Enables the automatic gain control of the microphone. More...
 
VARIANT_BOOL UseNoiseSuppression [get, set]
 Enables the noise suppression filter. More...
 
BSTR SIPTLSOverrideDomainName [get, set]
 Specfies the override domain name for the TLS certificate. More...
 
VARIANT_BOOL SIPTLSDisableCertificateVerification [get, set]
 Enables certificate verification for TLS. More...
 
ESecureSuite SIPTLSProtocolSuite [get, set]
 Specfies the TLS version that is going to be used. More...
 
VARIANT_BOOL SIPTLSUseStrongCiphers [get, set]
 Enables the usage of only srong ciphers in the TLS. More...
 
VARIANT_BOOL DisableRinging [get, set]
 Enables the ringing sounds of the phone. More...
 

Detailed Description

Configuration interface.

The configuration interface encapsulates the phones general configuration options. An instance of that class can only be obtained from the IZoiperPhone class instance by using the IZoiperPhone::GetConfig() method.

Member Function Documentation

void IZoiperConfig::NumberOfCallsLimit ( [in] LONG  call_limit)

Set maximum amount of calls.

Sets the maximum amount of simultaneous incoming/outgoing calls.

Parameters
[in]call_limitcall limit. Possible values are between 0 and 20.
void IZoiperConfig::SetSIPIAXPorts ( [in] LONG  sip_port,
[in] LONG  iax_port 
)

Set SIP and IAX2 listen ports.

Parameters
[in]sip_portSIP port. Possible values are between 1 and 65500.
[in]iax_portIAX2 port. Possible values are between 1 and 65500.

Returns no value.

Property Documentation

LONG IZoiperConfig::AudioInputVolume
getset

Specifies the input (microphone) volume.

LONG IZoiperConfig::AudioOutputVolume
getset

Specifies the output (speakers, headphones) volume.

VARIANT_BOOL IZoiperConfig::AutoAnswer
getset

Enables the auto answer feature of the phone.

VARIANT_BOOL IZoiperConfig::AutoAnswerPlaySound
getset

Enables the sound played upon auto answering.

LONG IZoiperConfig::AutoAnswerSeconds
getset

Specifies the delay before the call is auto answered.

VARIANT_BOOL IZoiperConfig::ChatBlinkWindow
getset

Enables the blinking of the chat window in the taskbar.

VARIANT_BOOL IZoiperConfig::ChatPlaySound
getset

Enables the playing of sound in case of incoming chat message.

VARIANT_BOOL IZoiperConfig::ChatShowDialog
getset

Enables the showing of a chat dialog upon receiving a new chat message.

BSTR IZoiperConfig::DebugLogPath
getset

Specifies the path where the debug log files will be created.

VARIANT_BOOL IZoiperConfig::DisableDTMFSounds
getset

Enables the sounds played on the output device when a DTMF signal is sent over the line.

VARIANT_BOOL IZoiperConfig::DisableRinging
getset

Enables the ringing sounds of the phone.

VARIANT_BOOL IZoiperConfig::DoNotShowError
getset

Enables the error messages shown by the phone.

VARIANT_BOOL IZoiperConfig::EnableDebugLargeDump
getset

Enables the generation of a large crash dump file that includes memory state.

Note
If this property is not enabled crash dump files will be created as well.
VARIANT_BOOL IZoiperConfig::EnableDebugLog
getset

Enables the debug logging to a file.

VARIANT_BOOL IZoiperConfig::Forwarding
getset

Enables the automatic call forwarding.

BSTR IZoiperConfig::ForwardingExtension
getset

Specifies the phone number to which the call should be forwarded.

LONG IZoiperConfig::ForwardingSeconds
getset

Specifies the time in seconds to wait before the call to be forwarded.

BSTR IZoiperConfig::MediaDSCP
getset

Specifies the DSCP tagging for the outbound media streams.

Possible values are one of the following :

"NONE", "CS0", "CS1", "CS2", "CS3", "CS4", "CS5", "CS6", "CS7",

"AF11", "AF12", "AF13", "AF21", "AF22", "AF23", "AF31", "AF32", "AF33", "AF41", "AF42", "AF43" and "EF".

Windows might not favor this setting, unless the following registry key is not set to "0" : HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\Tcpip\Parameters\DisableUserTOSSetting

VARIANT_BOOL IZoiperConfig::MuteEarlyMedia
getset

Enables the automatic muting of early media audio received from the the PBX on outgoing calls if available.

EOnTransferRequestStyle IZoiperConfig::OnTransferRequest
getset

Specifies the behavior of the phone on transfer request from the remote peer.

VARIANT_BOOL IZoiperConfig::PCSpeakerRing
getset

Enables the ringing using the PC speaker.

BSTR IZoiperConfig::PhoneInfoText
getset

Specifies the default information text displayed in the filter field of the phone.

Use this property to read or change the default text shown in the filter field of the phone. By default this field have the english text "Find a contact...". This text is show only when there is no user data entered in that field.

VARIANT_BOOL IZoiperConfig::PopupMenuOnIncomingCall
getset

Enables the pop-up menu on incoming new call.

VARIANT_BOOL IZoiperConfig::PopupOnIncomingCall
getset

Enables the phone to pop-up in front of the other applications when there is a new incoming call or chat message.

VARIANT_BOOL IZoiperConfig::RecordCalls
getset

Enables the automatic call recording.

BSTR IZoiperConfig::RecordFileName
getset

Specifies the file name pattern that is going to be used to name the audio conversation recording files.

The pattern contains normal characters (Unicode is allowed) and properties set by the phone according to the current call details. The properties are enclosed in curly braces to separate them from the normal characters and are replaced from the real value they represent when the file is created.

The default record file name is : recorded_conversation_{YYYY}-{MM}-{DD}-{HH}_{NN}_{SS}_part{recording_part}.

The phone supports a number of preset properties which values are filled without any API interaction. The preset properties are as follows:

  • YYYY - the starting year of the call as four digits.
  • MM - the starting month of the call as two digits.
  • DD - the starting day of the call as two digits.
  • HH - the starting hour of the call as two digits.
  • NN - the starting minute of the call as two digits.
  • SS - the starting second of the call as two digits.
  • name - the Caller ID (CID) name of the remote party of the call. (The display name from the FROM header for SIP calls).
  • phone - the CID phone of the remote party of the call. (The user name from the FROM header for SIP calls).
  • dnid - the phone (user name) which the remote user has dialed to reach Zoiper. This property is set only for incoming calls.
  • account - the name of the account that was matched for this call if it is incoming or the name of the account that was used to dial out this call for outgoing calls.
  • recording_part - the number of the recording file per call. This parameter allows the phone to save multiple recording files for a single call. The sequence of the number starts from 1 and increases every time the recording is stopped and started again using the IZoiperCall class StopRecording() and StartRecording() methods.
Note
The custom parameters can be created and its value can be set by using the IZoiperPhone class method SetRecordingProperty().
BSTR IZoiperConfig::RecordPath
getset

Specifies the path where the call recordings are going to be stored.

BSTR IZoiperConfig::Restrictions
getset

Specifies the interface resrtictions that are going to be applied to the whole interface.

The restriction entries are comma separated string values that can be used in any combination. The valid values for the restrictions are:

  • options_sip_accounts - restrict the access to the entire SIP account options.
  • options_iax_accounts - restrict the access to the entire IAX account options.
  • options_sip_accounts_overview - restrict the access to the overview SIP account options.
  • options_iax_accounts_overview - restrict the access to the overview IAX account options.
  • options_sip_new_account - restrict the creation of new SIP accounts.
  • options_iax_new_account - restrict the creation of new IAX accounts.
  • options_audio_general - restrict the access to the audio general options.
  • options_audio_devices - restrict the access to the audio devices options.
  • options_audio_codecs - restrict the access to the audio codec options.
  • options_general - restrict the access to the general options.
  • options_call_events - restrict the access to the general call events options.
  • options_integration - restrict the access to the general integration options (* not supported in all versions).
  • options_provision - restrict the access to the provisioning options (* not supported in all versions).
  • options_sip - restrict the access to the SIP protocol options.
  • options_iax - restrict the access to the IAX protocol options.
  • options_rtp - restrict the access to the RTP protocol options.
  • options_stun - restrict the access to the STUN protocol options.
  • options_diagnostics - restrict the diagnostic options.
  • options_network - restrict the access to the network options.
  • options_fax - restrict the access to the fax options.
  • options_video - restrict the access to the video options (* not supported in all versions).
  • options_chat - restrict the access to the chat options (* not supported in all versions).
  • options_contact_server - restrict the access to the contact server options (* not supported in all versions).
  • options_show_advanced - restrict the access to the "Show advanced options" check box in the options window and disabling the access to all the advanced options.
  • options - restrict the showing of the options window.
  • dial - restrict the ability to dial.
  • hangup - restrict the ability to hang up.
  • transfer - restrict the ability to transfer.
  • hold - restrict the ability to hold.
  • record - restrict the ability to record calls (* not supported in all versions).
  • conference - restrict the ability to start conference call (* not supported in all versions).
  • auto_answer - restrict the ability to auto answer calls (* not supported in all versions).
  • fax - restrict the ability to send faxes (* not supported in all versions).
  • video - restrict the ability to start video calls (* not supported in all versions).
  • history - restrict the ability to view the history.
  • contacts - restrict the ability to view the address book / contacts.
  • dialpad - restrict the access to the dial pad.
  • chat - restrict the access to the chat window (* not supported in all versions).
  • chat_history - restrict the access to the chat history (* not supported in all versions).
  • save_contact - restrict the access to the save contact button (* not supported in all versions).
  • find_contact - restrict the access to the find contact button (* not supported in all versions).
  • send_message - restrict the access to the send message button (* not supported in all versions).
  • account_register - restrict the access to the account register button.
  • account_unregister - restrict the access to the account unregister button.
  • wizard_audio - restrict the access to the audio wizard button.
VARIANT_BOOL IZoiperConfig::RingWhenTalking
getset

Enables the ringing sound in case of incoming call while there is already another established call.

LONG IZoiperConfig::RTPPortBase
getset

Specifies the port base used to create RTP sessions.

VARIANT_BOOL IZoiperConfig::RTPUseRandomPort
getset

Enables the usage of random value for RTP port base.

VARIANT_BOOL IZoiperConfig::ServerSideAutoAnswer
getset

Enables the ability of the phone to favor SIP Call-Info auto answer headers.

BSTR IZoiperConfig::SIPTLSCertificateFile
getset

Specifies the file path for additional TLS certificate.

VARIANT_BOOL IZoiperConfig::SIPTLSDisableCertificateVerification
getset

Enables certificate verification for TLS.

Note
This shoudl be disabled only for debugging and testing puposes because it makes the whole encyption obsolete.
BSTR IZoiperConfig::SIPTLSOverrideDomainName
getset

Specfies the override domain name for the TLS certificate.

ESecureSuite IZoiperConfig::SIPTLSProtocolSuite
getset

Specfies the TLS version that is going to be used.

VARIANT_BOOL IZoiperConfig::SIPTLSUseStrongCiphers
getset

Enables the usage of only srong ciphers in the TLS.

VARIANT_BOOL IZoiperConfig::UseAutomaticGainControl
getset

Enables the automatic gain control of the microphone.

The property is used to enable

VARIANT_BOOL IZoiperConfig::UseEchoCancelation
getset

Enables acustic echo cancelation audio filter.

VARIANT_BOOL IZoiperConfig::UseExternalDeviceGeneric
getset

Enables the phone to use generic external hand/headsets phone HID (Human Interface Device) devices.

For example Jabra headsets set in "Microsoft" mode complies to this specifications.

VARIANT_BOOL IZoiperConfig::UseExternalDeviceYealink
getset

Enables the phone to use external hand/headsets from the Yealink family.

VARIANT_BOOL IZoiperConfig::UseNoiseSuppression
getset

Enables the noise suppression filter.


The documentation for this interface was generated from the following file: