Zoiper COM API  1.1
 All Classes Files Functions Typedefs Enumerations Enumerator Properties
Zoiper.idl
Go to the documentation of this file.
1 #include "ScriptEvent.hpp"
2 
52 [
53  uuid(77A2B1E0-8F33-43D0-BEDB-CAAD48B929ED),
54  version(1.1),
55  helpstring("Zoiper API")
56 ]
58 
61 library ZoiperAPI
62 {
64 
68  typedef enum EAccountType
69  {
76  } EAccountType;
77 
81  typedef enum EContactState
82  {
91  } EContactState;
92 
97  {
107 
111  typedef enum EPresenceModel
112  {
117  } EPresenceModel;
118 
122  typedef enum EDTMFType
123  {
128 
133 
137 
140  } EDTMFType;
141 
145  typedef enum EProtocolTransport
146  {
156 
160  typedef enum ESRTPNegotiation
161  {
167 
171  typedef enum ESubscribeMWI
172  {
181  } ESubscribeMWI;
182 
187  {
195 
199  typedef enum ESecureSuite
200  {
205  } ESecureSuite;
206 
210  typedef enum EOutputDeviceStyle
211  {
219 
224  {
242 
246  typedef enum EVideoFPS
247  {
254  } EVideoFPS;
255 
259  typedef enum EVideoMode
260  {
271  } EVideoMode;
272 
273  dispinterface IZoiperCall;
274  dispinterface IZoiperAccount;
275  dispinterface IZoiperContact;
276  dispinterface IZoiperConfig;
277  dispinterface IZoiperAudio;
278  dispinterface IZoiperVideo;
279  dispinterface IZoiperProperty;
280  dispinterface IZoiperHeaders;
281  dispinterface IZoiperPhone;
282 
283  [
284  uuid(294FBB12-E743-468E-A7E6-4F071080D6C6),
285  helpstring("Zoiper Call dispinterface"),
286  ]
307  dispinterface IZoiperCall
308  {
309  properties:
310  methods:
316  [propget, id(DISPID_PROPERTY_PHONE) ] void Phone([out,retval]BSTR* retValue);
317 
325  [propget, id(DISPID_PROPERTY_CONTACT) ] void Contact([out,retval]IZoiperContact** retValue);
326 
330  [propget, id(DISPID_PROPERTY_ACCOUNT) ] void Account([out,retval]IZoiperAccount** retValue);
331 
337  [propget, id(DISPID_PROPERTY_DURATION) ] void Duration([out,retval]BSTR* retValue);
338 
351  [propget, id(DISPID_PROPERTY_CODEC) ] void CurrentCodec([out,retval]BSTR* retValue);
352 
359  [propget, id(DISPID_PROPERTY_CONFERENCE) ] void Conference([out,retval]VARIANT_BOOL* retValue);
360  [propput, id(DISPID_PROPERTY_CONFERENCE) ] void Conference([in] VARIANT_BOOL Value);
361 
366  [propget, id(DISPID_PROPERTY_DNID) ] void DNID([out, retval]BSTR* retValue);
367 
371  [propget, id(DISPID_PROPERTY_IS_HOLD) ] void IsHold([out, retval]VARIANT_BOOL* retValue);
372 
376  [propget, id(DISPID_PROPERTY_IS_REMOTE_HOLD) ] void IsRemoteHold([out, retval]VARIANT_BOOL* retValue);
377 
381  [propget, id(DISPID_PROPERTY_IS_INCOMING) ] void IsIncoming([out, retval]VARIANT_BOOL* retValue);
382 
386  [propget, id(DISPID_PROPERTY_IS_RECORDING) ] void IsRecording([out, retval]VARIANT_BOOL* retValue);
387 
391  [propget, id(DISPID_PROPERTY_IS_TRANSFERRING) ] void IsTransferring([out, retval]VARIANT_BOOL* retValue);
392 
396  [propget, id(DISPID_PROPERTY_IS_RINGING) ] void IsRinging([out,retval]VARIANT_BOOL* retValue);
397 
405  [propget, id(DISPID_PROPERTY_RECORD_FILENAME) ] void RecordingFileName([out, retval]BSTR* retValue);
406 
413  [ id(DISPID_CALL_HANG) ] void Hang();
414 
421  [ id(DISPID_CALL_HOLD) ] void Hold();
422 
431  [ id(DISPID_CALL_UNHOLD) ] void UnHold();
432 
437  [ id(DISPID_CALL_ACCEPT) ] void Accept();
438 
443  [ id(DISPID_CALL_REJECT) ] void Reject();
444 
453  [ id(DISPID_CALL_RECORD) ] VARIANT_BOOL Record();
454 
461  [ id(DISPID_CALL_RECORD_STOP) ] VARIANT_BOOL RecordStop();
462 
470  [ id(DISPID_CALL_RECORD_FILENAME) ] void UpdateRecordingFileName();
471 
478  [ id(DISPID_CALL_VIDEO) ] void Video([in] VARIANT_BOOL video);
479 
491  [ id(DISPID_SEND_DTMF) ] void SendDTMF([in] BSTR dtmf);
492 
499  [ id(DISPID_CALL_TRANSFER) ] void Transfer([in] BSTR phone);
500 
508  [ id(DISPID_CALL_ATTENDED) ] VARIANT_BOOL AttendedTransfer([in] IZoiperCall* call);
509  };
510 
511  [
512  uuid(34A66E26-7FEB-40E8-8C61-4E0DE10C0E11),
513  helpstring("Zoiper Account dispinterface"),
514  ]
524  dispinterface IZoiperAccount
525  {
526  properties:
527  methods:
533  [propget, id(DISPID_PROPERTY_NAME) ] void Name([out,retval]BSTR* retValue);
534 
538  [propget, id(DISPID_PROPERTY_TYPE) ] void Type([out, retval]EAccountType* retValue);
539 
543  [propget, id(DISPID_PROPERTY_STATE) ] void State([out, retval]EAccountRegistrationState* retValue);
544 
549  [propput, id(DISPID_PROPERTY_PHONE) ] void Phone([in]BSTR Value);
550 
555  [propput, id(DISPID_PROPERTY_HOST) ] void Host([in]BSTR Value);
556 
561  [propput, id(DISPID_PROPERTY_DOMAIN) ] void Domain([in]BSTR Value);
562 
566  [propput, id(DISPID_PROPERTY_CONTEXT) ] void Context([in]BSTR Value);
567 
572  [propput, id(DISPID_PROPERTY_PROXY) ] void OutboundProxy([in]BSTR Value);
573 
579  [propput, id(DISPID_PROPERTY_JABBERID) ] void JabberID([in]BSTR Value);
580 
584  [propput, id(DISPID_PROPERTY_USERNAME) ] void UserName([in]BSTR Value);
585 
589  [propput, id(DISPID_PROPERTY_PASSWORD) ] void Password([in]BSTR Value);
590 
594  [propput, id(DISPID_PROPERTY_CALLER_ID) ] void CallerID([in]BSTR Value);
595 
601  [propput, id(DISPID_PROPERTY_AUTH_USER) ] void AuthenticationUserName([in]BSTR Value);
602 
608  [propput, id(DISPID_PROPERTY_STUN_HOST) ] void STUNHost([in]BSTR Value);
609 
614  [propput, id(DISPID_PROPERTY_STUN_PORT) ] void STUNPort([in]LONG Value);
615 
622  [propput, id(DISPID_PROPERTY_REGISTRATION_EXPIRY) ] void RegistrationExpiry([in]LONG Value);
623 
628  [propput, id(DISPID_PROPERTY_DISABLE_RING_BACKTONES) ] void DisableRingbackTones([in]VARIANT_BOOL Value);
629 
633  [propput, id(DISPID_PROPERTY_USE_RPORT) ] void UseRPort([in]VARIANT_BOOL Value);
634 
638  [propput, id(DISPID_PROPERTY_USE_RPORTMEDIA) ] void UseRPortMedia([in]VARIANT_BOOL Value);
639 
643  [propget, id(DISPID_PROPERTY_FORCE_RFC3264) ] void ForceRFC3264([in]VARIANT_BOOL Value);
644 
648  [propput, id(DISPID_PROPERTY_PRESENCE_MODEL) ] void PresenceModel([in]EPresenceModel Value);
649 
653  [propput, id(DISPID_PROPERTY_DTMF_TYPE) ] void DTMFType([in]EDTMFType Value);
654 
658  [propput, id(DISPID_PROPERTY_SIP_TRANSPORT_TYPE) ] void SIPTransportType([in]EProtocolTransport Value);
659 
665  [propput, id(DISPID_PROPERTY_RTP_ENCRYPTION) ] void RTPEncryption([in]ESRTPNegotiation Value);
666 
671  [propput, id(DISPID_PROPERTY_USE_ROSTER) ] void UseRoster([in]VARIANT_BOOL Value);
672 
676  [propput, id(DISPID_PROPERTY_USE_LEGACY_TLS) ] void UseLegacyTLS([in]VARIANT_BOOL Value);
677 
682  [propput, id(DISPID_PROPERTY_SUBSCRIBE_FOR_MWI) ] void SubscribeForMWI([in]ESubscribeMWI Value);
683 
687  [propput, id(DISPID_PROPERTY_SUBSCRIBE_PRESENCE) ] void SubscribePresence([in]VARIANT_BOOL Value);
688 
692  [propput, id(DISPID_PROPERTY_PUBLISH_PRESENCE) ] void PublishPresence([in]VARIANT_BOOL Value);
693 
697  [propput, id(DISPID_PROPERTY_VOICE_MAIL_CHECK_EXTENSION) ] void VoiceMailCheckExtension([in]BSTR Value);
698 
702  [propput, id(DISPID_PROPERTY_VOICE_MAIL_FORWARD_EXTENSION) ] void VoiceMailForwardExtension([in]BSTR Value);
703 
710  [ id(DISPID_APPLY) ] void Apply();
711 
719  [ id(DISPID_ACCOUNT_REGISTER) ] void Register();
720 
728  [ id(DISPID_ACCOUNT_UNREGISTER) ] void Unregister();
729 
739  [ id(DISPID_ACCOUNT_ADD_CODEC) ] void AddCodec([in] BSTR codec);
740 
745  [ id(DISPID_ACCOUNT_CLEAR_CODEC) ] void ClearCodec();
746 
756  [ id(DISPID_ACCOUNT_SIP_HEADER_DUMP) ] void SipHeaderDump([in] VARIANT_BOOL enable);
757 
768  [ id(DISPID_ACCOUNT_SIP_HEADER_ADD) ] void SipHeaderAdd([in] BSTR name, [in] BSTR value);
769 
777  [ id(DISPID_ACCOUNT_SIP_HEADER_CLEAR) ] void SipHeaderClear([in] BSTR name);
778  };
779 
780  [
781  uuid(8A95800C-824A-484E-9C7D-4095CF685960),
782  helpstring("Zoiper Contact dispinterface"),
783  ]
793  dispinterface IZoiperContact
794  {
795  properties:
796  methods:
800  [propget, id(DISPID_PROPERTY_DISPLAY)] void Display([out, retval]BSTR* retValue);
801  [propput, id(DISPID_PROPERTY_DISPLAY)] void Display([in] BSTR value);
802 
806  [propget, id(DISPID_PROPERTY_PHONE)] void PresenceID([out, retval] BSTR* retValue);
807  [propput, id(DISPID_PROPERTY_PHONE)] void PresenceID([in] BSTR value);
808 
813  [propget, id(DISPID_PROPERTY_PRESENCE)] void PresenceAccount([out, retval] BSTR* retValue);
814  [propput, id(DISPID_PROPERTY_PRESENCE)] void PresenceAccount([in] BSTR value);
815 
820  [propget, id(DISPID_PROPERTY_ACCOUNT)] void Account([out, retval] BSTR* retValue);
821  [propput, id(DISPID_PROPERTY_ACCOUNT)] void Account([in] BSTR value);
822 
826  [propget, id(DISPID_PROPERTY_WORK_PHONE)] void WorkPhone([out, retval] BSTR* retValue);
827  [propput, id(DISPID_PROPERTY_WORK_PHONE)] void WorkPhone([in] BSTR value);
828 
832  [propget, id(DISPID_PROPERTY_HOME_PHONE)] void HomePhone([out, retval] BSTR* retValue);
833  [propput, id(DISPID_PROPERTY_HOME_PHONE)] void HomePhone([in] BSTR value);
834 
838  [propget, id(DISPID_PROPERTY_CELL_PHONE)] void CellPhone([out, retval] BSTR* retValue);
839  [propput, id(DISPID_PROPERTY_CELL_PHONE)] void CellPhone([in] BSTR value);
840 
844  [propget, id(DISPID_PROPERTY_FAX_NUMBER)] void FaxNumber([out, retval] BSTR* retValue);
845  [propput, id(DISPID_PROPERTY_FAX_NUMBER)] void FaxNumber([in] BSTR value);
846 
850  [propget, id(DISPID_PROPERTY_CITY)] void City([out, retval] BSTR* retValue);
851  [propput, id(DISPID_PROPERTY_CITY)] void City([in] BSTR value);
852 
856  [propget, id(DISPID_PROPERTY_COUNTRY)] void Country([out, retval] BSTR* retValue);
857  [propput, id(DISPID_PROPERTY_COUNTRY)] void Country([in] BSTR value);
858 
862  [propget, id(DISPID_PROPERTY_LAST_NAME)] void LastName([out, retval] BSTR* retValue);
863  [propput, id(DISPID_PROPERTY_LAST_NAME)] void LastName([in] BSTR value);
864 
868  [propget, id(DISPID_PROPERTY_FIRST_NAME)] void FirstName([out, retval] BSTR* retValue);
869  [propput, id(DISPID_PROPERTY_FIRST_NAME)] void FirstName([in] BSTR value);
870 
874  [propget, id(DISPID_PROPERTY_MIDDLE_NAME)] void MiddleName([out, retval] BSTR* retValue);
875  [propput, id(DISPID_PROPERTY_MIDDLE_NAME)] void MiddleName([in] BSTR value);
876 
880  [propget, id(DISPID_PROPERTY_SAVE_CONTACT)] void SaveContact([out, retval] VARIANT_BOOL* retValue);
881  [propput, id(DISPID_PROPERTY_SAVE_CONTACT)] void SaveContact([in] VARIANT_BOOL value);
882 
888  [ id(DISPID_APPLY) ] void Apply();
889 
894  [ id(DISPID_CONTACT_ACCEPT) ] void Accept();
895 
902  [ id(DISPID_CONTACT_REJECT) ] void Reject([in] BSTR reason);
903 
910  [ id(DISPID_CONTACT_MESSAGE) ] void Message([in] BSTR message, [in] VARIANT_BOOL show);
911  };
912 
913  [
914  uuid(AB325183-CD88-4AD9-A873-670BA3627C88),
915  helpstring("Zoiper Configuration dispinterface"),
916  ]
923  dispinterface IZoiperConfig
924  {
925  properties:
926  methods:
930  [propget, id(DISPID_CONFIG_POPUP_MENU_INCOMING_CALL)] void PopupMenuOnIncomingCall([out, retval] VARIANT_BOOL* retValue);
931  [propput, id(DISPID_CONFIG_POPUP_MENU_INCOMING_CALL)] void PopupMenuOnIncomingCall([in] VARIANT_BOOL value);
932 
936  [propget, id(DISPID_CONFIG_TRANSFER_REQUEST)] void OnTransferRequest([out, retval] EOnTransferRequestStyle* retValue);
937  [propput, id(DISPID_CONFIG_TRANSFER_REQUEST)] void OnTransferRequest([in] EOnTransferRequestStyle value);
938 
942  [propget, id(DISPID_CONFIG_USE_ECHO_CANCELLATION)] void UseEchoCancelation([out, retval] VARIANT_BOOL* retValue);
943  [propput, id(DISPID_CONFIG_USE_ECHO_CANCELLATION)] void UseEchoCancelation([in] VARIANT_BOOL value);
944 
948  [propget, id(DISPID_CONFIG_DEBUG_LOG)] void EnableDebugLog([out, retval] VARIANT_BOOL* retValue);
949  [propput, id(DISPID_CONFIG_DEBUG_LOG)] void EnableDebugLog([in] VARIANT_BOOL value);
950 
954  [propget, id(DISPID_CONFIG_DEBUG_LOG_PATH)] void DebugLogPath([out, retval] BSTR* retValue);
955  [propput, id(DISPID_CONFIG_DEBUG_LOG_PATH)] void DebugLogPath([in] BSTR value);
956 
961  [propget, id(DISPID_CONFIG_ENABLE_LARGE_DUMP)] void EnableDebugLargeDump([out, retval] VARIANT_BOOL* retValue);
962  [propput, id(DISPID_CONFIG_ENABLE_LARGE_DUMP)] void EnableDebugLargeDump([in] VARIANT_BOOL value);
963 
1015  [propget, id(DISPID_CONFIG_RESTRICTIONS)] void Restrictions([out, retval] BSTR* retValue);
1016  [propput, id(DISPID_CONFIG_RESTRICTIONS)] void Restrictions([in] BSTR value);
1017 
1021  [propget, id(DISPID_CONFIG_SERVER_SIDE_AUTO_ANSWER)] void ServerSideAutoAnswer([out, retval] VARIANT_BOOL* retValue);
1022  [propput, id(DISPID_CONFIG_SERVER_SIDE_AUTO_ANSWER)] void ServerSideAutoAnswer([in] VARIANT_BOOL value);
1023 
1027  [propget, id(DISPID_CONFIG_AUTO_ANSWER)] void AutoAnswer([out, retval] VARIANT_BOOL* retValue);
1028  [propput, id(DISPID_CONFIG_AUTO_ANSWER)] void AutoAnswer([in] VARIANT_BOOL value);
1029 
1033  [propget, id(DISPID_CONFIG_AUTO_ANSWER_SECONDS)] void AutoAnswerSeconds([out, retval] LONG* retValue);
1034  [propput, id(DISPID_CONFIG_AUTO_ANSWER_SECONDS)] void AutoAnswerSeconds([in] LONG value);
1035 
1039  [propget, id(DISPID_CONFIG_AUTO_ANSWER_PLAY_SOUND)] void AutoAnswerPlaySound([out, retval] VARIANT_BOOL* retValue);
1040  [propput, id(DISPID_CONFIG_AUTO_ANSWER_PLAY_SOUND)] void AutoAnswerPlaySound([in] VARIANT_BOOL value);
1041 
1045  [propget, id(DISPID_CONFIG_AUDIO_INPUT_VOLUME)] void AudioInputVolume([out, retval] LONG* retValue);
1046  [propput, id(DISPID_CONFIG_AUDIO_INPUT_VOLUME)] void AudioInputVolume([in] LONG value);
1047 
1051  [propget, id(DISPID_CONFIG_AUDIO_OUTPUT_VOLUME)] void AudioOutputVolume([out, retval] LONG* retValue);
1052  [propput, id(DISPID_CONFIG_AUDIO_OUTPUT_VOLUME)] void AudioOutputVolume([in] LONG value);
1053 
1065  [propget, id(DISPID_CONFIG_MEDIA_DSCP)] void MediaDSCP([out, retval] BSTR* retValue);
1066  [propput, id(DISPID_CONFIG_MEDIA_DSCP)] void MediaDSCP([in] BSTR value);
1067 
1071  [propget, id(DISPID_CONFIG_FORWARDING)] void Forwarding([out, retval] VARIANT_BOOL* retValue);
1072  [propput, id(DISPID_CONFIG_FORWARDING)] void Forwarding([in] VARIANT_BOOL value);
1073 
1077  [propget, id(DISPID_CONFIG_FORWARDING_SECONDS)] void ForwardingSeconds([out, retval] LONG* retValue);
1078  [propput, id(DISPID_CONFIG_FORWARDING_SECONDS)] void ForwardingSeconds([in] LONG value);
1079 
1083  [propget, id(DISPID_CONFIG_FORWARDING_EXTENSION)] void ForwardingExtension([out, retval] BSTR* retValue);
1084  [propput, id(DISPID_CONFIG_FORWARDING_EXTENSION)] void ForwardingExtension([in] BSTR value);
1085 
1089  [propget, id(DISPID_CONFIG_RECORD_CALLS)] void RecordCalls([out, retval] VARIANT_BOOL* retValue);
1090  [propput, id(DISPID_CONFIG_RECORD_CALLS)] void RecordCalls([in] VARIANT_BOOL value);
1091 
1095  [propget, id(DISPID_CONFIG_RECORD_CALLS_PATH)] void RecordPath([out, retval] BSTR* retValue);
1096  [propput, id(DISPID_CONFIG_RECORD_CALLS_PATH)] void RecordPath([in] BSTR value);
1097 
1130  [propget, id(DISPID_CONFIG_RECORD_CALLS_FILENAME)] void RecordFileName([out, retval] BSTR* retValue);
1131  [propput, id(DISPID_CONFIG_RECORD_CALLS_FILENAME)] void RecordFileName([in] BSTR value);
1132 
1136  [propget, id(DISPID_CONFIG_SIP_TLS_CERTIFICATE_FILE)] void SIPTLSCertificateFile([out, retval] BSTR* retValue);
1137  [propput, id(DISPID_CONFIG_SIP_TLS_CERTIFICATE_FILE)] void SIPTLSCertificateFile([in] BSTR value);
1138 
1142  [propget, id(DISPID_CONFIG_RTP_PORT)] void RTPPortBase([out, retval] LONG* retValue);
1143  [propput, id(DISPID_CONFIG_RTP_PORT)] void RTPPortBase([in] LONG value);
1144 
1148  [propget, id(DISPID_CONFIG_RTP_USE_RANDOM)] void RTPUseRandomPort([out, retval] VARIANT_BOOL* retValue);
1149  [propput, id(DISPID_CONFIG_RTP_USE_RANDOM)] void RTPUseRandomPort([in] VARIANT_BOOL value);
1150 
1154  [propget, id(DISPID_CONFIG_CHAT_PLAY_SOUND)] void ChatPlaySound([out, retval] VARIANT_BOOL* retValue);
1155  [propput, id(DISPID_CONFIG_CHAT_PLAY_SOUND)] void ChatPlaySound([in] VARIANT_BOOL value);
1156 
1160  [propget, id(DISPID_CONFIG_CHAT_BLINK_WINDOW)] void ChatBlinkWindow([out, retval] VARIANT_BOOL* retValue);
1161  [propput, id(DISPID_CONFIG_CHAT_BLINK_WINDOW)] void ChatBlinkWindow([in] VARIANT_BOOL value);
1162 
1166  [propget, id(DISPID_CONFIG_CHAT_SHOW_DIALOG)] void ChatShowDialog([out, retval] VARIANT_BOOL* retValue);
1167  [propput, id(DISPID_CONFIG_CHAT_SHOW_DIALOG)] void ChatShowDialog([in] VARIANT_BOOL value);
1168 
1172  [propget, id(DISPID_CONFIG_DO_NOT_SHOW_ERROR)] void DoNotShowError([out, retval] VARIANT_BOOL* retValue);
1173  [propput, id(DISPID_CONFIG_DO_NOT_SHOW_ERROR)] void DoNotShowError([in] VARIANT_BOOL value);
1174 
1181  [propget, id(DISPID_CONFIG_PHONE_INFO_TEXT)] void PhoneInfoText([out, retval] BSTR* retValue);
1182  [propput, id(DISPID_CONFIG_PHONE_INFO_TEXT)] void PhoneInfoText([in] BSTR value);
1183 
1187  [propget, id(DISPID_CONFIG_POPUP_ICOMING_CALL)] void PopupOnIncomingCall([out, retval] VARIANT_BOOL* retValue);
1188  [propput, id(DISPID_CONFIG_POPUP_ICOMING_CALL)] void PopupOnIncomingCall([in] VARIANT_BOOL value);
1189 
1193  [propget, id(DISPID_CONFIG_RING_WHEN_TALKING)] void RingWhenTalking([out, retval] VARIANT_BOOL* retValue);
1194  [propput, id(DISPID_CONFIG_RING_WHEN_TALKING)] void RingWhenTalking([in] VARIANT_BOOL value);
1195 
1199  [propget, id(DISPID_CONFIG_PC_SPEAKER_RING)] void PCSpeakerRing([out, retval] VARIANT_BOOL* retValue);
1200  [propput, id(DISPID_CONFIG_PC_SPEAKER_RING)] void PCSpeakerRing([in] VARIANT_BOOL value);
1201 
1205  [propget, id(DISPID_CONFIG_DISABLE_DTMF_SOUNDS)] void DisableDTMFSounds([out, retval] VARIANT_BOOL* retValue);
1206  [propput, id(DISPID_CONFIG_DISABLE_DTMF_SOUNDS)] void DisableDTMFSounds([in] VARIANT_BOOL value);
1207 
1211  [propget, id(DISPID_CONFIG_MUTE_EARLY_MEDIA)] void MuteEarlyMedia([out, retval] VARIANT_BOOL* retValue);
1212  [propput, id(DISPID_CONFIG_MUTE_EARLY_MEDIA)] void MuteEarlyMedia([in] VARIANT_BOOL value);
1213 
1217  [propget, id(DISPID_CONFIG_USE_EXTERNAL_DEVICE_YEALINK)] void UseExternalDeviceYealink([out, retval] VARIANT_BOOL* retValue);
1218  [propput, id(DISPID_CONFIG_USE_EXTERNAL_DEVICE_YEALINK)] void UseExternalDeviceYealink([in] VARIANT_BOOL value);
1219 
1224  [propget, id(DISPID_CONFIG_USE_EXTERNAL_DEVICE_GENERIC)] void UseExternalDeviceGeneric([out, retval] VARIANT_BOOL* retValue);
1225  [propput, id(DISPID_CONFIG_USE_EXTERNAL_DEVICE_GENERIC)] void UseExternalDeviceGeneric([in] VARIANT_BOOL value);
1226 
1231  [propget, id(DISPID_CONFIG_USE_AUTOMATIC_GAIN_CONTROL)] void UseAutomaticGainControl([out, retval] VARIANT_BOOL* retValue);
1232  [propput, id(DISPID_CONFIG_USE_AUTOMATIC_GAIN_CONTROL)] void UseAutomaticGainControl([in] VARIANT_BOOL value);
1233 
1237  [propget, id(DISPID_CONFIG_USE_NOISE_SUPPRESSION)] void UseNoiseSuppression([out, retval] VARIANT_BOOL* retValue);
1238  [propput, id(DISPID_CONFIG_USE_NOISE_SUPPRESSION)] void UseNoiseSuppression([in] VARIANT_BOOL value);
1239 
1243  [propget, id(DISPID_CONFIG_SIP_TLS_OVERRIDE_DOMAIN_NAME)] void SIPTLSOverrideDomainName([out, retval] BSTR* retValue);
1244  [propput, id(DISPID_CONFIG_SIP_TLS_OVERRIDE_DOMAIN_NAME)] void SIPTLSOverrideDomainName([in] BSTR value);
1245 
1251  [propget, id(DISPID_CONFIG_SIP_TLS_DISABLE_CERTIFICATE_VERIFICATION)] void SIPTLSDisableCertificateVerification([out, retval] VARIANT_BOOL* retValue);
1252  [propput, id(DISPID_CONFIG_SIP_TLS_DISABLE_CERTIFICATE_VERIFICATION)] void SIPTLSDisableCertificateVerification([in] VARIANT_BOOL value);
1253 
1257  [propget, id(DISPID_CONFIG_SIP_TLS_PROTOCOL_SUITE)] void SIPTLSProtocolSuite([out, retval] ESecureSuite* retValue);
1258  [propput, id(DISPID_CONFIG_SIP_TLS_PROTOCOL_SUITE)] void SIPTLSProtocolSuite([in] ESecureSuite value);
1259 
1263  [propget, id(DISPID_CONFIG_SIP_TLS_USE_STRONG_CIPHERS)] void SIPTLSUseStrongCiphers([out, retval] VARIANT_BOOL* retValue);
1264  [propput, id(DISPID_CONFIG_SIP_TLS_USE_STRONG_CIPHERS)] void SIPTLSUseStrongCiphers([in] VARIANT_BOOL value);
1265 
1269  [propget, id(DISPID_CONFIG_DISABLE_RINGING_SOUND)] void DisableRinging([out, retval] VARIANT_BOOL* retValue);
1270  [propput, id(DISPID_CONFIG_DISABLE_RINGING_SOUND)] void DisableRinging([in] VARIANT_BOOL value);
1271 
1272 
1280  [ id(DISPID_CONFIG_SIP_IAX_PORTS) ] void SetSIPIAXPorts( [in] LONG sip_port, [in] LONG iax_port );
1281 
1288  [ id(DISPID_CONFIG_NUMBER_OF_CALL_LIMITS) ] void NumberOfCallsLimit( [in] LONG call_limit );
1289  };
1290 
1291  [
1292  uuid(998F8CCD-DCB4-41AF-A4B4-3FA1B06777F7),
1293  helpstring("Zoiper Audio Configuration dispinterface"),
1294  ]
1300  dispinterface IZoiperAudio
1301  {
1302  properties:
1303  methods:
1309  [propget, id(DISPID_AUDIO_INPUT_DEVICE)] void InputDevice([out, retval] BSTR* retValue);
1310  [propput, id(DISPID_AUDIO_INPUT_DEVICE)] void InputDevice([in] BSTR value);
1311 
1317  [propget, id(DISPID_AUDIO_OUTPUT_DEVICE)] void OutputDevice([out, retval] BSTR* retValue);
1318  [propput, id(DISPID_AUDIO_OUTPUT_DEVICE)] void OutputDevice([in] BSTR value);
1319 
1325  [propget, id(DISPID_AUDIO_RINGING_DEVICE)] void RingingDevice([out, retval] BSTR* retValue);
1326  [propput, id(DISPID_AUDIO_RINGING_DEVICE)] void RingingDevice([in] BSTR value);
1327 
1331  [propget, id(DISPID_AUDIO_INPUT_COUNT)] void InputDeviceCount([out, retval] LONG* retValue);
1332 
1336  [propget, id(DISPID_AUDIO_OUTPUT_COUNT)] void OutputDeviceCount([out, retval] LONG* retValue);
1337 
1343  [ id(DISPID_APPLY) ] void Apply();
1344 
1350  [ id(DISPID_AUDIO_INPUT_NAME) ] BSTR InputDeviceName([in] INT index);
1351 
1357  [ id(DISPID_AUDIO_OUTPUT_NAME) ] BSTR OutputDeviceName([in] INT index);
1358  };
1359 
1360  [
1361  uuid(B58F13DA-CC0F-4d57-8110-1D11D85D597C),
1362  helpstring("Zoiper Video Configuration dispinterface"),
1363  ]
1369  dispinterface IZoiperVideo
1370  {
1371  properties:
1372  methods:
1378  [propget, id(DISPID_VIDEO_DEVICE)] void Device([out, retval] BSTR* retValue);
1379  [propput, id(DISPID_VIDEO_DEVICE)] void Device([in] BSTR value);
1380 
1384  [propget, id(DISPID_VIDEO_COUNT)] void DeviceCount([out, retval] INT* retValue);
1385 
1389  [propget, id(DISPID_VIDEO_DEVICE_SIZE)] void Mode([out, retval] EVideoMode* retValue);
1390  [propput, id(DISPID_VIDEO_DEVICE_SIZE)] void Mode([in] EVideoMode value);
1391 
1397  [propget, id(DISPID_VIDEO_DEVICE_FRAME)] void FPS([out, retval] EVideoFPS* retValue);
1398  [propput, id(DISPID_VIDEO_DEVICE_FRAME)] void FPS([in] EVideoFPS value);
1399 
1404  [propget, id(DISPID_VIDEO_DEVICE_RATE)] void BitRate([out, retval] INT* retValue);
1405  [propput, id(DISPID_VIDEO_DEVICE_RATE)] void BitRate([in] INT value);
1406 
1407 
1413  [ id(DISPID_APPLY) ] void Apply();
1414 
1421  [ id(DISPID_VIDEO_NAME) ] BSTR DeviceName([in] INT index);
1422  };
1423 
1424  [
1425  uuid(3A327587-D1E4-40a7-BC05-FDE03E37F2DF),
1426  helpstring("Zoiper Property dispinterface"),
1427  ]
1433  dispinterface IZoiperProperty
1434  {
1435  properties:
1436  methods:
1440  [propget, id(DISPID_PROPERTY_NAME)] void Name([out, retval] BSTR* retValue);
1444  [propget, id(DISPID_PROPERTY_COUNT)] void Count([out, retval] INT* retValue);
1445 
1452  [ id(DISPID_PROPERTY_VALUE) ] BSTR Value([in] INT index);
1453  };
1454 
1455  [
1456  uuid(02A2345E-85EB-4CAD-BF6E-2170D0BEE20D),
1457  helpstring("Zoiper Headers dispinterface"),
1458  ]
1465  dispinterface IZoiperHeaders
1466  {
1467  properties:
1468  methods:
1472  [propget, id(DISPID_PROPERTY_COUNT)] void Count([out, retval] INT* retValue);
1473 
1479  [ id(DISPID_HEADER_ENTRY) ] IZoiperProperty* Entry([in] INT index);
1480  };
1481 
1482  [
1483  uuid(F7ED336F-5C13-4e8a-A3F8-F15C27FAF93D),
1484  helpstring("Zoiper Playback sound dispinterface"),
1485  ]
1491  dispinterface IZoiperPlayback
1492  {
1493  properties:
1494  methods:
1500  [ id(DISPID_PLAYBACK_START) ] void Start([in] EOutputDeviceStyle mode);
1501 
1505  [ id(DISPID_PLAYBACK_STOP) ] void Stop();
1506  };
1507 
1508  [
1509  uuid(488198FA-EB61-4DC7-9254-9A1BB039A4A8),
1510  helpstring("Events for Zoiper object")
1511  ]
1516  dispinterface IZoiperEvent
1517  {
1518  properties:
1519  methods:
1524  [ id(DISPID_FILTER) ] void OnZoiperFilter ([in] BSTR text);
1525 
1532  [ id(DISPID_CALL_HANG) ] void OnZoiperCallHang ([in] IZoiperCall* call);
1533 
1539  [ id(DISPID_CALL_RING) ] void OnZoiperCallRing ([in] IZoiperCall* call);
1540 
1545  [ id(DISPID_CALL_HOLD) ] void OnZoiperCallHold ([in] IZoiperCall* call);
1546 
1551  [ id(DISPID_CALL_UNHOLD) ] void OnZoiperCallUnhold ([in] IZoiperCall* call);
1552 
1557  [ id(DISPID_CALL_ACCEPT) ] void OnZoiperCallAccept ([in] IZoiperCall* call);
1558 
1566  [ id(DISPID_CALL_REJECT) ] void OnZoiperCallReject ([in] IZoiperCall* call, [in] LONG cause_code);
1567 
1575  [ id(DISPID_CALL_FAIL) ] void OnZoiperCallFail ([in] IZoiperCall* call, [in] LONG cause_code);
1576 
1581  [ id(DISPID_CALL_INCOMING) ] void OnZoiperCallIncoming ([in] IZoiperCall* call);
1582 
1588  [ id(DISPID_CALL_RECORD) ] void OnZoiperCallStartRecording ([in] IZoiperCall* call, [in] BSTR filename);
1589 
1595  [ id(DISPID_CALL_RECORD_STOP) ] void OnZoiperCallStopRecording ([in] IZoiperCall* call, [in] BSTR filename);
1596 
1602  [ id(DISPID_RECEIVE_DTMF) ] void OnZoiperCallRecvDTMF ([in] IZoiperCall* call, [in] BSTR dtmf);
1603 
1608  [ id(DISPID_CALL_TRANSFER_SUCCESS) ] void OnZoiperTransferSuccess ([in] IZoiperCall* call);
1609 
1614  [ id(DISPID_CALL_TRANSFER_FAILED) ] void OnZoiperTransferFailed ([in] IZoiperCall* call);
1615 
1621  [ id(DISPID_CALL_SIP_HEADER) ] void OnZoiperCallSipHeader ([in] IZoiperCall* call, [in] IZoiperHeaders* headers);
1622 
1627  [ id(DISPID_CALL_HOLD_LOCAL) ] void OnZoiperCallHoldLocal ([in] IZoiperCall* call);
1628 
1633  [ id(DISPID_CALL_UNHOLD_LOCAL) ] void OnZoiperCallUnholdLocal ([in] IZoiperCall* call);
1634 
1640  [ id(DISPID_CALL_INCOMING_URL) ] void OnZoiperCallIncomingURL ([in] IZoiperCall* call, [in] BSTR url);
1641 
1647  [ id(DISPID_CONTACT_CREATE) ] void OnZoiperContactCreate ([in] IZoiperContact* contact, [in] BSTR name);
1648 
1653  [ id(DISPID_CONTACT_DELETE) ] void OnZoiperContactDelete ([in] IZoiperContact* contact);
1654 
1659  [ id(DISPID_CONTACT_CHANGE) ] void OnZoiperContactChange ([in] IZoiperContact* contact);
1660 
1666  [ id(DISPID_CONTACT_STATE) ] void OnZoiperContactStatus ([in] IZoiperContact* contact, [in] EContactExtendedState status);
1667 
1672  [ id(DISPID_CONTACT_SUBSCRIBE) ] void OnZoiperContactSubscribe ([in] IZoiperContact* contact);
1673 
1679  [ id(DISPID_MESSAGE_RECV) ] void OnZoiperContactMessageRecv ([in] IZoiperContact* contact, [in] BSTR message);
1680 
1686  [ id(DISPID_MESSAGE_SENT) ] void OnZoiperContactMessageSent ([in] IZoiperContact* contact, [in] BSTR message);
1687 
1694  [ id(DISPID_MESSAGE_FAIL) ] void OnZoiperContactMessageFailed ([in] IZoiperContact* contact, [in] BSTR message, [in] LONG reason);
1695 
1700  [ id(DISPID_ACCOUNT_REGISTER) ] void OnZoiperAccountRegister ([in] IZoiperAccount* account);
1701 
1706  [ id(DISPID_ACCOUNT_UNREGISTER) ] void OnZoiperAccountUnregister ([in] IZoiperAccount* account);
1707 
1713  [ id(DISPID_ACCOUNT_REGISTER_FAIL) ] void OnZoiperAccountRegisterFail ([in] IZoiperAccount* account, [in] LONG cause_code);
1714 
1719  [ id(DISPID_PLAYBACK_FINISHED) ] void OnZoiperPlaybackFinished ([in] IZoiperPlayback* playback);
1720 
1721 // URLLoaded could return either IZoiperPhone or IZoiperPlayback
1722 // depending on the success of the operation thus we will leave the parameter as IDispatch
1732  [ id(DISPID_PLAYBACK_URL_LOAD) ] void OnZoiperPlaybackSoundURLLoaded ([in] IDispatch* playback, [in] VARIANT_BOOL result, [in] BSTR response);
1733 
1740  [ id(DISPID_SMS_DELETE) ] void OnZoiperSMSDelete ([in] IZoiperPhone* phone, [in] BSTR ident);
1741 
1749  [ id(DISPID_SMS_SEND) ] void OnZoiperSMSSend ([in] IZoiperPhone* phone, [in] BSTR message, [in] BSTR number);
1750 
1755  [ id(DISPID_CONFERENCE_HOLD) ] void OnZoiperConferenceHold ([in] IZoiperPhone* phone);
1756 
1761  [ id(DISPID_CONFERENCE_UNHOLD) ] void OnZoiperConferenceUnhold ([in] IZoiperPhone* phone);
1762  };
1763 
1764  [
1765  uuid(50B770EA-DD3B-40F3-9228-6322B4C981C9),
1766  helpstring("Main Zoiper dispinterface"),
1767  ]
1774  dispinterface IZoiperPhone
1775  {
1776  properties:
1777  methods:
1784  [propget, id(DISPID_GET_VERSION)] void Version([out,retval]BSTR* retValue);
1785 
1792  [propget, id(DISPID_GET_CALL) ] void ActiveCall([out,retval]IZoiperCall** retValue);
1793  [propput, id(DISPID_GET_CALL) ] void ActiveCall([in] IZoiperCall* value);
1794 
1800  [propget, id(DISPID_NUMBER_OF_CALLS) ] void NumberOfCalls([out,retval]LONG* retValue);
1801 
1805  [propget, id(DISPID_FILTER) ] void DefaultFilterText([out,retval] BSTR* retval);
1806  [propput, id(DISPID_FILTER) ] void DefaultFilterText([in] BSTR value);
1807 
1811  [propget, id(DISPID_MUTE_SPEAKER) ] void MuteSpeaker([out,retval]VARIANT_BOOL* retValue);
1812  [propput, id(DISPID_MUTE_SPEAKER) ] void MuteSpeaker([in] VARIANT_BOOL value);
1813 
1817  [propget, id(DISPID_MUTE_MICROPHONE) ] void MuteMicrophone([out,retval]VARIANT_BOOL* retValue);
1818  [propput, id(DISPID_MUTE_MICROPHONE) ] void MuteMicrophone([in] VARIANT_BOOL value);
1819 
1832  [ id(DISPID_DIAL) ] IZoiperCall* Dial([in] BSTR phone, [in] INT video);
1833 
1839  [ id(DISPID_HANG) ] void Hang();
1840 
1847  [ id(DISPID_GET_AUDIO) ] IZoiperAudio* GetAudio();
1848 
1856  [ id(DISPID_GET_VIDEO) ] IZoiperVideo* GetVideo();
1857 
1865  [ id(DISPID_GET_CONFIG) ] IZoiperConfig* GetConfig();
1866 
1873  [ id(DISPID_GET_CONTACT) ] IZoiperContact* GetContact([in] BSTR phone);
1874 
1883  [ id(DISPID_GET_CONTACT_BY_INDEX) ] IZoiperContact* GetContactByIndex([in] INT index);
1884 
1892  [ id(DISPID_ADD_CONTACT) ] IZoiperContact* AddContact([in] BSTR phone);
1893 
1899  [ id(DISPID_DEL_CONTACT) ] IZoiperContact* DelContact([in] BSTR phone);
1900 
1908  [ id(DISPID_USE_ACCOUNT) ] IZoiperAccount* UseAccount([in] BSTR name);
1909 
1914  [ id(DISPID_DEL_ACCOUNT) ] void DelAccount([in] BSTR name);
1915 
1922  [ id(DISPID_GET_ACCOUNT) ] IZoiperAccount* GetAccount([in] BSTR name);
1923 
1932  [ id(DISPID_GET_ACCOUNT_BY_INDEX) ] IZoiperAccount* GetAccountByIndex([in] INT index);
1933 
1942  [ id(DISPID_ADD_ACCOUNT) ] IZoiperAccount* AddAccount([in] BSTR name, [in] EAccountType type);
1943 
1947  [ id(DISPID_DELETE_DIALOG) ] void DelDialog([in] BSTR name);
1948 
1952  [ id(DISPID_SHOW_AUDIO_WIZARD) ] void ShowAudioWizard();
1953 
1959  [ id(DISPID_SHOW_LOG)] void ShowLogDialog();
1960 
1965  [ id(DISPID_SHOW_TRANSFER_DIALOG) ] void ShowTransferDialog();
1966 
1971  [ id(DISPID_PLAYBACK_URL_LOAD) ] void LoadPlaybackSoundFromURL([in] BSTR url);
1972 
1979  [ id(DISPID_PLAYBACK_FILE_LOAD) ] IZoiperPlayback* LoadPlaybackSoundFromFile([in] BSTR filename);
1980 
1989  [ id(DISPID_SMS_ADD) ] void AddSMS([in] BSTR ident, [in] BSTR sender, [in] BSTR message, [in] VARIANT_BOOL unread);
1990 
1996  [ id(DISPID_SMS_DELETE) ] void DelSMS([in] BSTR ident);
1997 
2004  [ id(DISPID_SET_TEXT_PROPERTY) ] void SetRecordingProperty([in] BSTR name, [in] BSTR value);
2005 
2010  [ id(DISPID_SAVE_OPTIONS) ] void SaveOptions();
2011 
2016  [ id(DISPID_SAVE_CONTACT) ] void SaveContact();
2017 
2023  [ id(DISPID_SAVE_PRIVACY) ] void SavePrivacy ();
2024  };
2025 
2026  [
2027  uuid(EDE266EE-2C85-4436-A9A3-940CC5B45A1F),
2028  helpstring("Zoiper API Object"),
2029  ]
2033  coclass ZoiperAPI
2034  {
2035  [default] dispinterface IZoiperPhone;
2036  [default, source] dispinterface IZoiperEvent;
2037  };
2038 };
Configuration interface.
Definition: Zoiper.idl:923
Definition: Zoiper.idl:189
Zoiper API main class This class creates the main Zoiper API instance and its event dispatcher...
Definition: Zoiper.idl:2033
Definition: Zoiper.idl:103
Definition: Zoiper.idl:253
Definition: Zoiper.idl:238
Definition: Zoiper.idl:202
Definition: Zoiper.idl:86
Definition: Zoiper.idl:240
Definition: Zoiper.idl:226
Events interface.
Definition: Zoiper.idl:1516
Definition: Zoiper.idl:127
Definition: Zoiper.idl:114
The Phone interface.
Definition: Zoiper.idl:1774
Video interface.
Definition: Zoiper.idl:1369
Definition: Zoiper.idl:191
Definition: Zoiper.idl:101
Contact interface.
Definition: Zoiper.idl:793
Definition: Zoiper.idl:176
EDTMFType
Enumerate possible DTMF type.
Definition: Zoiper.idl:122
Definition: Zoiper.idl:90
Definition: Zoiper.idl:84
Audio interface.
Definition: Zoiper.idl:1300
Definition: Zoiper.idl:150
Definition: Zoiper.idl:213
ESRTPNegotiation
Enumerate possible RTP encyption scheme.
Definition: Zoiper.idl:160
EVideoFPS
Enumerate possible video quality options.
Definition: Zoiper.idl:246
EAccountType
Enumerate possible account types.
Definition: Zoiper.idl:68
ESubscribeMWI
Enumerate possible MWI subscription mode.
Definition: Zoiper.idl:171
Definition: Zoiper.idl:132
Definition: Zoiper.idl:270
Definition: Zoiper.idl:165
EOutputDeviceStyle
Enumerate possible output audio device usage.
Definition: Zoiper.idl:210
Definition: Zoiper.idl:73
ESecureSuite
Enumerate encryption version.
Definition: Zoiper.idl:199
Definition: Zoiper.idl:71
Definition: Zoiper.idl:75
Definition: Zoiper.idl:236
Definition: Zoiper.idl:268
EPresenceModel
Enumerate possible presence models.
Definition: Zoiper.idl:111
Definition: Zoiper.idl:154
Definition: Zoiper.idl:234
Definition: Zoiper.idl:266
Definition: Zoiper.idl:193
EProtocolTransport
Enumerate possible protocol transport types.
Definition: Zoiper.idl:145
EContactExtendedState
Enumerate all possible extended contact states.
Definition: Zoiper.idl:223
Definition: Zoiper.idl:204
EVideoMode
Enumerate possible video resolution options.
Definition: Zoiper.idl:259
Call Interface.
Definition: Zoiper.idl:307
Definition: Zoiper.idl:99
Definition: Zoiper.idl:180
Definition: Zoiper.idl:136
EOnTransferRequestStyle
Enumerate possible options when there is transfer reguest.
Definition: Zoiper.idl:186
Definition: Zoiper.idl:174
Playback interface.
Definition: Zoiper.idl:1491
EAccountRegistrationState
Enumarete possible account states.
Definition: Zoiper.idl:96
Definition: Zoiper.idl:139
Headers interface.
Definition: Zoiper.idl:1465
Definition: Zoiper.idl:264
Definition: Zoiper.idl:251
Definition: Zoiper.idl:88
Definition: Zoiper.idl:249
Definition: Zoiper.idl:217
Definition: Zoiper.idl:262
Definition: Zoiper.idl:105
Definition: Zoiper.idl:163
EContactState
Enumerate possible contact states.
Definition: Zoiper.idl:81
Account interface.
Definition: Zoiper.idl:524
Definition: Zoiper.idl:148
Property interface.
Definition: Zoiper.idl:1433
Definition: Zoiper.idl:178
Definition: Zoiper.idl:228
Definition: Zoiper.idl:116
Definition: Zoiper.idl:230
Definition: Zoiper.idl:232
Definition: Zoiper.idl:215