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

The Phone interface. More...

Public Member Functions

IZoiperCallDial ([in] BSTR phone, [in] INT video)
 Dial a number. More...
 
void Hang ()
 Hang up. More...
 
IZoiperAudioGetAudio ()
 Get audio configuration. More...
 
IZoiperVideoGetVideo ()
 Get video configuration. More...
 
IZoiperConfigGetConfig ()
 Get general configuration. More...
 
IZoiperContactGetContact ([in] BSTR phone)
 Get contact by phone number. More...
 
IZoiperContactGetContactByIndex ([in] INT index)
 Get contact by index. More...
 
IZoiperContactAddContact ([in] BSTR phone)
 Create new contact. More...
 
IZoiperContactDelContact ([in] BSTR phone)
 Delete a contact by phone number. More...
 
IZoiperAccountUseAccount ([in] BSTR name)
 Set default account. More...
 
void DelAccount ([in] BSTR name)
 Delete account by name. More...
 
IZoiperAccountGetAccount ([in] BSTR name)
 Get account by name. More...
 
IZoiperAccountGetAccountByIndex ([in] INT index)
 Get account by index. More...
 
IZoiperAccountAddAccount ([in] BSTR name, [in] EAccountType type)
 Create new account. More...
 
void DelDialog ([in] BSTR name)
 Not used. More...
 
void ShowAudioWizard ()
 Show audio wizard dialog. More...
 
void ShowLogDialog ()
 Show log dialog. More...
 
void ShowTransferDialog ()
 Show the transfer dialog. More...
 
void LoadPlaybackSoundFromURL ([in] BSTR url)
 Load playback sound from URL. More...
 
IZoiperPlaybackLoadPlaybackSoundFromFile ([in] BSTR filename)
 Load playback sound from file. More...
 
void AddSMS ([in] BSTR ident, [in] BSTR sender, [in] BSTR message, [in] VARIANT_BOOL unread)
 Add SMS. More...
 
void DelSMS ([in] BSTR ident)
 Delete SMS by identification string. More...
 
void SetRecordingProperty ([in] BSTR name, [in] BSTR value)
 Sets a new custom recording file name property. More...
 
void SaveOptions ()
 Save the phone configuration. More...
 
void SaveContact ()
 Save contact. More...
 
void SavePrivacy ()
 Save the privacy rules. More...
 

Properties

BSTR Version [get]
 Specifies the verison of the phone. More...
 
IZoiperCall ActiveCall [get, set]
 Provides access to the current active call. More...
 
LONG NumberOfCalls [get]
 Specfies the number of current calls available. More...
 
BSTR DefaultFilterText [get, set]
 Specifies the filter field of the phone. More...
 
VARIANT_BOOL MuteSpeaker [get, set]
 Enables and disables the audio output. More...
 
VARIANT_BOOL MuteMicrophone [get, set]
 Enables and disables the audio input. More...
 

Detailed Description

The Phone interface.

The Phone interface represents the phone as a whole. It provides facilities for general configuration, creation and management of accounts, calls and contacts objects.

Member Function Documentation

IZoiperAccount* IZoiperPhone::AddAccount ( [in] BSTR  name,
[in] EAccountType  type 
)

Create new account.

Create new account or retrieve an existing one by the provided account name. The name of the account is used as unique identifier.

Parameters
[in]namethe account name.
[in]typethe account protocol type.
Returns
the newly created account object. If an error occurs during the account creation, this parameter will be set to NULL.
IZoiperContact* IZoiperPhone::AddContact ( [in] BSTR  phone)

Create new contact.

Create new contact or retrieve an existing one by the provided phone number.

Parameters
[in]phonethe phone number by which the contact is going to be matched and eventually created with.
Returns
the contact object.
void IZoiperPhone::AddSMS ( [in] BSTR  ident,
[in] BSTR  sender,
[in] BSTR  message,
[in] VARIANT_BOOL  unread 
)

Add SMS.

Note
SMS functionality is not currently availabale.
Parameters
[in]identSMS identification string.
[in]senderthe sender of the SMS.
[in]messagethe content of the message.
[in]unreada flag if the message is already read.
void IZoiperPhone::DelAccount ( [in] BSTR  name)

Delete account by name.

Parameters
[in]namethe name of the account.
IZoiperContact* IZoiperPhone::DelContact ( [in] BSTR  phone)

Delete a contact by phone number.

Parameters
[in]phonethe phone number by which the contact is going to be matched.
Returns
the contact object.
void IZoiperPhone::DelDialog ( [in] BSTR  name)

Not used.

void IZoiperPhone::DelSMS ( [in] BSTR  ident)

Delete SMS by identification string.

Note
SMS functionality is not currently availabale.
Parameters
[in]identthe identification string of the SMS.
IZoiperCall* IZoiperPhone::Dial ( [in] BSTR  phone,
[in] INT  video 
)

Dial a number.

Create a new call object and dials a desired phone number/extension. Any current active call is put on hold and the new call becomes the active one. The call is made for the current active account. If there is no active account, the first account in the list will be used.

Parameters
[in]phonethe number to dial
[in]videoThe parameter is used to govern if the phone is going to start a video call instead of a regular audio call.
Returns
the newly created call object. If the call creation is not successful or there are no accounts at all, this parameter will be set to NULL.
IZoiperAccount* IZoiperPhone::GetAccount ( [in] BSTR  name)

Get account by name.

Parameters
[in]namea string associated with the account.
Returns
the account object. If there is no account with name matching the one provided, this parameter will be set to NULL.
IZoiperAccount* IZoiperPhone::GetAccountByIndex ( [in] INT  index)

Get account by index.

This method is used to enumerate all the accounts.

Parameters
[in]indexthe index of the contact. It starts from 0.
Returns
the account object. If a account object with such index does not exist, this parameter will be set to NULL.
IZoiperAudio* IZoiperPhone::GetAudio ( )

Get audio configuration.

Obtain the reference to the audio object, which is responsible for the audio configuration of the phone. Only one instance of this class can be obtained and it can be done by this method only.

Returns
the audio configuration object.
IZoiperConfig* IZoiperPhone::GetConfig ( )

Get general configuration.

Obtain the reference to the configuration object, which is responsible for the general configuration of the phone. Only one instance of this class can be obtained and it can be done by this method only.

Returns
the configuration object.
IZoiperContact* IZoiperPhone::GetContact ( [in] BSTR  phone)

Get contact by phone number.

Parameters
[in]phonethe phone number by which the contact is going to be matched.
Returns
the contact object. If a contact with the provided phone number does not exist, this parameter will be set to NULL.
IZoiperContact* IZoiperPhone::GetContactByIndex ( [in] INT  index)

Get contact by index.

This method is used to enumerate all the contacts.

Parameters
[in]indexthe index of the contact. It starts from 0.
Returns
the contact object. If a contact object with such index does not exist, this parameter will be set to NULL.
IZoiperVideo* IZoiperPhone::GetVideo ( )

Get video configuration.

Obtain the reference to the Video object, which is responsible for the Video configuration of the phone. Only one instance of this class can be obtained and it can be done by this method only.

Returns
the video configuration object.
void IZoiperPhone::Hang ( )

Hang up.

Hangs up the active call.

IZoiperPlayback* IZoiperPhone::LoadPlaybackSoundFromFile ( [in] BSTR  filename)

Load playback sound from file.

Parameters
[in]filenamethe file name pointing to an audio playback sound. The sound file must be of type 8 kHz mono 16 bits.
Returns
the playback object. If there is an error loading the file with the name, this parameter will be set to NULL.
void IZoiperPhone::LoadPlaybackSoundFromURL ( [in] BSTR  url)

Load playback sound from URL.

Parameters
[in]urlthe url pointing to an audio playback sound. The sound file must be of type 8 kHz mono 16 bits.
void IZoiperPhone::SaveContact ( )

Save contact.

Governs if phone is going to save its contact entries locally upon creation and editing.

void IZoiperPhone::SaveOptions ( )

Save the phone configuration.

Save the phone configuration, placed in the current user's application data folder.

void IZoiperPhone::SavePrivacy ( )

Save the privacy rules.

Save the privacy rules, placed in the current user is application data folder. If the privacy rules exist, they will be loaded upon the phone start-up.

void IZoiperPhone::SetRecordingProperty ( [in] BSTR  name,
[in] BSTR  value 
)

Sets a new custom recording file name property.

Sets a new custom recording file name property. This method is used along with the IZoiperConfig::RecordFileName property.

Parameters
[in]namethe name of the property.
[in]valuethe value of the property.
void IZoiperPhone::ShowAudioWizard ( )

Show audio wizard dialog.

void IZoiperPhone::ShowLogDialog ( )

Show log dialog.

Show log window containing text information about the actions done by the phone. If IZoiperConfig::EnableDebugLog property is set to true, the log will provide and additional debug information as well.

void IZoiperPhone::ShowTransferDialog ( )

Show the transfer dialog.

Shows the transfer dialog if there is an active call that could be transferred.

IZoiperAccount* IZoiperPhone::UseAccount ( [in] BSTR  name)

Set default account.

Parameters
[in]namethe name of the account.
Returns
the account object. If there is no account with name matching the one provided, this parameter will be set to NULL.

Property Documentation

IZoiperCall IZoiperPhone::ActiveCall
getset

Provides access to the current active call.

Read ActiveCall to obtain the current active call. This is the call that is not on hold and has the speaker output and the microphone input. If there is no active call it will contain NULL.

BSTR IZoiperPhone::DefaultFilterText
getset

Specifies the filter field of the phone.

VARIANT_BOOL IZoiperPhone::MuteMicrophone
getset

Enables and disables the audio input.

VARIANT_BOOL IZoiperPhone::MuteSpeaker
getset

Enables and disables the audio output.

LONG IZoiperPhone::NumberOfCalls
get

Specfies the number of current calls available.

Read this property to obtain the number of calls that are taking place. Calls in all states are included in the count.

BSTR IZoiperPhone::Version
get

Specifies the verison of the phone.

This property is used to get the version string of the currently running phone. It can be used to inform the user that there is a newer version and guide him to download and install it.


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