Zoiper COM API
1.1
|
The Phone interface. More...
Public Member Functions | |
IZoiperCall * | Dial ([in] BSTR phone, [in] INT video) |
Dial a number. More... | |
void | Hang () |
Hang up. More... | |
IZoiperAudio * | GetAudio () |
Get audio configuration. More... | |
IZoiperVideo * | GetVideo () |
Get video configuration. More... | |
IZoiperConfig * | GetConfig () |
Get general configuration. More... | |
IZoiperContact * | GetContact ([in] BSTR phone) |
Get contact by phone number. More... | |
IZoiperContact * | GetContactByIndex ([in] INT index) |
Get contact by index. More... | |
IZoiperContact * | AddContact ([in] BSTR phone) |
Create new contact. More... | |
IZoiperContact * | DelContact ([in] BSTR phone) |
Delete a contact by phone number. More... | |
IZoiperAccount * | UseAccount ([in] BSTR name) |
Set default account. More... | |
void | DelAccount ([in] BSTR name) |
Delete account by name. More... | |
IZoiperAccount * | GetAccount ([in] BSTR name) |
Get account by name. More... | |
IZoiperAccount * | GetAccountByIndex ([in] INT index) |
Get account by index. More... | |
IZoiperAccount * | AddAccount ([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... | |
IZoiperPlayback * | LoadPlaybackSoundFromFile ([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... | |
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.
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.
[in] | name | the account name. |
[in] | type | the account protocol type. |
IZoiperContact* IZoiperPhone::AddContact | ( | [in] BSTR | phone | ) |
Create new contact.
Create new contact or retrieve an existing one by the provided phone number.
[in] | phone | the phone number by which the contact is going to be matched and eventually created with. |
void IZoiperPhone::AddSMS | ( | [in] BSTR | ident, |
[in] BSTR | sender, | ||
[in] BSTR | message, | ||
[in] VARIANT_BOOL | unread | ||
) |
Add SMS.
[in] | ident | SMS identification string. |
[in] | sender | the sender of the SMS. |
[in] | message | the content of the message. |
[in] | unread | a flag if the message is already read. |
void IZoiperPhone::DelAccount | ( | [in] BSTR | name | ) |
Delete account by name.
[in] | name | the name of the account. |
IZoiperContact* IZoiperPhone::DelContact | ( | [in] BSTR | phone | ) |
Delete a contact by phone number.
[in] | phone | the phone number by which the contact is going to be matched. |
void IZoiperPhone::DelDialog | ( | [in] BSTR | name | ) |
Not used.
void IZoiperPhone::DelSMS | ( | [in] BSTR | ident | ) |
Delete SMS by identification string.
[in] | ident | the 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.
[in] | phone | the number to dial |
[in] | video | The parameter is used to govern if the phone is going to start a video call instead of a regular audio call. |
IZoiperAccount* IZoiperPhone::GetAccount | ( | [in] BSTR | name | ) |
Get account by name.
[in] | name | a string associated with the account. |
IZoiperAccount* IZoiperPhone::GetAccountByIndex | ( | [in] INT | index | ) |
Get account by index.
This method is used to enumerate all the accounts.
[in] | index | the index of the contact. It starts from 0. |
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.
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.
IZoiperContact* IZoiperPhone::GetContact | ( | [in] BSTR | phone | ) |
Get contact by phone number.
[in] | phone | the phone number by which the contact is going to be matched. |
IZoiperContact* IZoiperPhone::GetContactByIndex | ( | [in] INT | index | ) |
Get contact by index.
This method is used to enumerate all the contacts.
[in] | index | the index of the contact. It starts from 0. |
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.
void IZoiperPhone::Hang | ( | ) |
Hang up.
Hangs up the active call.
IZoiperPlayback* IZoiperPhone::LoadPlaybackSoundFromFile | ( | [in] BSTR | filename | ) |
Load playback sound from file.
[in] | filename | the file name pointing to an audio playback sound. The sound file must be of type 8 kHz mono 16 bits. |
void IZoiperPhone::LoadPlaybackSoundFromURL | ( | [in] BSTR | url | ) |
Load playback sound from URL.
[in] | url | the 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.
[in] | name | the name of the property. |
[in] | value | the 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.
[in] | name | the name of the account. |
|
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.
|
getset |
Specifies the filter field of the phone.
|
getset |
Enables and disables the audio input.
|
getset |
Enables and disables the audio output.
|
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.
|
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.