Zoiper COM API  1.1
 All Classes Files Functions Typedefs Enumerations Enumerator Properties
Zoiper.idl File Reference

Go to the source code of this file.

Classes

interface  IZoiperCall
 Call Interface. More...
 
interface  IZoiperAccount
 Account interface. More...
 
interface  IZoiperContact
 Contact interface. More...
 
interface  IZoiperConfig
 Configuration interface. More...
 
interface  IZoiperAudio
 Audio interface. More...
 
interface  IZoiperVideo
 Video interface. More...
 
interface  IZoiperProperty
 Property interface. More...
 
interface  IZoiperHeaders
 Headers interface. More...
 
interface  IZoiperPlayback
 Playback interface. More...
 
interface  IZoiperEvent
 Events interface. More...
 
interface  IZoiperPhone
 The Phone interface. More...
 
class  ZoiperAPI
 Zoiper API main class This class creates the main Zoiper API instance and its event dispatcher. More...
 

Typedefs

typedef enum EAccountType EAccountType
 Enumerate possible account types. More...
 
typedef enum EContactState EContactState
 Enumerate possible contact states. More...
 
typedef enum
EAccountRegistrationState 
EAccountRegistrationState
 Enumarete possible account states. More...
 
typedef enum EPresenceModel EPresenceModel
 Enumerate possible presence models. More...
 
typedef enum EDTMFType EDTMFType
 Enumerate possible DTMF type. More...
 
typedef enum EProtocolTransport EProtocolTransport
 Enumerate possible protocol transport types. More...
 
typedef enum ESRTPNegotiation ESRTPNegotiation
 Enumerate possible RTP encyption scheme. More...
 
typedef enum ESubscribeMWI ESubscribeMWI
 Enumerate possible MWI subscription mode. More...
 
typedef enum
EOnTransferRequestStyle 
EOnTransferRequestStyle
 Enumerate possible options when there is transfer reguest. More...
 
typedef enum ESecureSuite ESecureSuite
 Enumerate encryption version. More...
 
typedef enum EOutputDeviceStyle EOutputDeviceStyle
 Enumerate possible output audio device usage. More...
 
typedef enum EContactExtendedState EContactExtendedState
 Enumerate all possible extended contact states. More...
 
typedef enum EVideoFPS EVideoFPS
 Enumerate possible video quality options. More...
 
typedef enum EVideoMode EVideoMode
 Enumerate possible video resolution options. More...
 

Enumerations

enum  EAccountType { ACCOUNT_SIP, ACCOUNT_IAX, ACCOUNT_XMPP }
 Enumerate possible account types. More...
 
enum  EContactState { CONTACT_OFFLINE, CONTACT_ONLINE, CONTACT_AWAY, CONTACT_BUSY }
 Enumerate possible contact states. More...
 
enum  EAccountRegistrationState { ACCOUNT_NOT_REGISTERED, ACCOUNT_REGISTERING, ACCOUNT_REGISTERED, ACCOUNT_WAIT_FOR_NETWORK_DISCOVERY }
 Enumarete possible account states. More...
 
enum  EPresenceModel { PM_SERVER_BASED, PM_PEER_TO_PEER }
 Enumerate possible presence models. More...
 
enum  EDTMFType { DTMF_MEDIA_OUTBAND, DTMF_SIGNALLING_OUTBAND, DTMF_MEDIA_INBAND, DTMF_MEDIA_DISABLED }
 Enumerate possible DTMF type. More...
 
enum  EProtocolTransport { TRANSPORT_UDP, TRANSPORT_TCP, TRANSPORT_TLS }
 Enumerate possible protocol transport types. More...
 
enum  ESRTPNegotiation { SRTP_NONE, SRTP_SDES }
 Enumerate possible RTP encyption scheme. More...
 
enum  ESubscribeMWI { MWI_DISABLED, MWI_BEFORE_REGISTRATION, MWI_AFTER_REGISTRATION, MWI_BOTH }
 Enumerate possible MWI subscription mode. More...
 
enum  EOnTransferRequestStyle { TRANSFER_ALWAYS_ACCEPT, TRANSFER_ALWAYS_REJECT, TRANSFER_ASK }
 Enumerate possible options when there is transfer reguest. More...
 
enum  ESecureSuite { SECURE_SSLv23, SECURE_TLSv1 }
 Enumerate encryption version. More...
 
enum  EOutputDeviceStyle { DEVICE_OUTPUT_NORMAL, DEVICE_OUTPUT_RINGING, DEVICE_OUTPUT_DISABLE }
 Enumerate possible output audio device usage. More...
 
enum  EContactExtendedState {
  CONTACT_XSTATE_OFFLINE, CONTACT_XSTATE_INVISIBLE, CONTACT_XSTATE_ONLINE, CONTACT_XSTATE_AWAY,
  CONTACT_XSTATE_BUSY, CONTACT_XSTATE_PHONE, CONTACT_XSTATE_LUNCH, CONTACT_XSTATE_BE_BACK
}
 Enumerate all possible extended contact states. More...
 
enum  EVideoFPS { VIDEO_FPS_5, VIDEO_FPS_15, VIDEO_FPS_30 }
 Enumerate possible video quality options. More...
 
enum  EVideoMode {
  VIDEO_MODE_176_144, VIDEO_MODE_352_288, VIDEO_MODE_640_480, VIDEO_MODE_1280_720,
  VIDEO_MODE_1600_1200
}
 Enumerate possible video resolution options. More...
 

Typedef Documentation

Enumarete possible account states.

typedef enum EAccountType EAccountType

Enumerate possible account types.

Enumerate all possible extended contact states.

Enumerate possible contact states.

typedef enum EDTMFType EDTMFType

Enumerate possible DTMF type.

Enumerate possible options when there is transfer reguest.

Enumerate possible output audio device usage.

Enumerate possible presence models.

Enumerate possible protocol transport types.

typedef enum ESecureSuite ESecureSuite

Enumerate encryption version.

Enumerate possible RTP encyption scheme.

Enumerate possible MWI subscription mode.

typedef enum EVideoFPS EVideoFPS

Enumerate possible video quality options.

typedef enum EVideoMode EVideoMode

Enumerate possible video resolution options.

Enumeration Type Documentation

Enumarete possible account states.

Enumerator
ACCOUNT_NOT_REGISTERED 

The account is not registered.

ACCOUNT_REGISTERING 

The account is in process of registration.

ACCOUNT_REGISTERED 

The account is registered

ACCOUNT_WAIT_FOR_NETWORK_DISCOVERY 

The account is waiting for the STUN network discovery to finish before it starts to register.

Enumerate possible account types.

Enumerator
ACCOUNT_SIP 

Session Initiation Protocol (SIP).

ACCOUNT_IAX 

Inter-Asterisk eXchange protocol (IAX2).

ACCOUNT_XMPP 

Extensible Messaging and Presence Protocol (XMPP).

Enumerate all possible extended contact states.

Enumerator
CONTACT_XSTATE_OFFLINE 

The contact is offline.

CONTACT_XSTATE_INVISIBLE 

The contact is invisible.

CONTACT_XSTATE_ONLINE 

The contact is online.

CONTACT_XSTATE_AWAY 

The contact is away.

CONTACT_XSTATE_BUSY 

The contact is busy.

CONTACT_XSTATE_PHONE 

The contact is speaking on the phone.

CONTACT_XSTATE_LUNCH 

The contact is out for lunch.

CONTACT_XSTATE_BE_BACK 

The contact will be back.

Enumerate possible contact states.

Enumerator
CONTACT_OFFLINE 

The contact is offline.

CONTACT_ONLINE 

The contact is online.

CONTACT_AWAY 

The contact is away.

CONTACT_BUSY 

The contact is busy.

enum EDTMFType

Enumerate possible DTMF type.

Enumerator
DTMF_MEDIA_OUTBAND 

RFC-2833 is going to be used for the SIP accounts. Out-of-band DTMF signaling will be used for the IAX2 accounts.

DTMF_SIGNALLING_OUTBAND 

SIP INFO will be used for SIP accounts. Out-of-band DTMF signaling will be used for the IAX2 accounts.

DTMF_MEDIA_INBAND 

Inband DTMF signaling will be used for both SIP and IAX2 accounts.

DTMF_MEDIA_DISABLED 

Disable the sending of DTMF signals.

Enumerate possible options when there is transfer reguest.

Enumerator
TRANSFER_ALWAYS_ACCEPT 

Always automatically accept the requests.

TRANSFER_ALWAYS_REJECT 

Always automatically reject the requests.

TRANSFER_ASK 

Ask the user what action to be taken.

Enumerate possible output audio device usage.

Enumerator
DEVICE_OUTPUT_NORMAL 

Use the normal output device

DEVICE_OUTPUT_RINGING 

Use the ringing output device

DEVICE_OUTPUT_DISABLE 

Disable output

Enumerate possible presence models.

Enumerator
PM_SERVER_BASED 

Server based presence model.

PM_PEER_TO_PEER 

Peer-to-peer based presence model.

Enumerate possible protocol transport types.

Enumerator
TRANSPORT_UDP 

UDP transport protocol.

TRANSPORT_TCP 

TCP transport protocol.

TRANSPORT_TLS 

TLS protocol over TCP protocol. TLS protocol is used to encrypt the SIP data using the certificates already installed on the machine.

Enumerate encryption version.

Enumerator
SECURE_SSLv23 

Secure Socket Layer. That provides privacy and reliability between two servers or applications

SECURE_TLSv1 

Transport Layer Security a standard encryption for private communication.

Enumerate possible RTP encyption scheme.

Enumerator
SRTP_NONE 

No encryption.

SRTP_SDES 

SDES encryption.

Enumerate possible MWI subscription mode.

Enumerator
MWI_DISABLED 

No subscription for MWI.

MWI_BEFORE_REGISTRATION 

The subscription for MWI will be made before the account registration.

MWI_AFTER_REGISTRATION 

The subscription for MWI will be made after the account registration.

MWI_BOTH 

Two subscriptions for MWI will be be made. One before and one after the account registration.

enum EVideoFPS

Enumerate possible video quality options.

Enumerator
VIDEO_FPS_5 

Video quality 5 frames per second

VIDEO_FPS_15 

Video quality 15 frames per second

VIDEO_FPS_30 

Video quality 30 frames per second

enum EVideoMode

Enumerate possible video resolution options.

Enumerator
VIDEO_MODE_176_144 

176x144 pixels mode

VIDEO_MODE_352_288 

352x288 pixels mode

VIDEO_MODE_640_480 

VGA Mode

VIDEO_MODE_1280_720 

720p Mode

VIDEO_MODE_1600_1200 

UXGA Mode