IPPhone Class

Properties   Methods   Events   Config Settings   Errors  

TBD.

Class Name

IPWorksVoIP_IPPhone

Procedural Interface

 ipworksvoip_ipphone_open();
 ipworksvoip_ipphone_close($res);
 ipworksvoip_ipphone_register_callback($res, $id, $function);
 ipworksvoip_ipphone_get_last_error($res);
 ipworksvoip_ipphone_get_last_error_code($res);
 ipworksvoip_ipphone_set($res, $id, $index, $value);
 ipworksvoip_ipphone_get($res, $id, $index);
 ipworksvoip_ipphone_do_activate($res, $host, $port);
 ipworksvoip_ipphone_do_answer($res, $callid);
 ipworksvoip_ipphone_do_config($res, $configurationstring);
 ipworksvoip_ipphone_do_deactivate($res);
 ipworksvoip_ipphone_do_decline($res, $callid);
 ipworksvoip_ipphone_do_dial($res, $number, $callernumber, $wait);
 ipworksvoip_ipphone_do_doevents($res);
 ipworksvoip_ipphone_do_hangup($res, $callid);
 ipworksvoip_ipphone_do_hangupall($res);
 ipworksvoip_ipphone_do_hold($res, $callid);
 ipworksvoip_ipphone_do_joinconference($res, $callid, $conferenceid);
 ipworksvoip_ipphone_do_leaveconference($res, $callid);
 ipworksvoip_ipphone_do_listconferences($res);
 ipworksvoip_ipphone_do_listmicrophones($res);
 ipworksvoip_ipphone_do_listspeakers($res);
 ipworksvoip_ipphone_do_playfile($res, $callid, $wavfile);
 ipworksvoip_ipphone_do_playtext($res, $callid, $text);
 ipworksvoip_ipphone_do_recordtofile($res, $callid, $recordfile);
 ipworksvoip_ipphone_do_reset($res);
 ipworksvoip_ipphone_do_setmicrophone($res, $microphone);
 ipworksvoip_ipphone_do_setspeaker($res, $speaker);
 ipworksvoip_ipphone_do_stopplaying($res, $callid);
 ipworksvoip_ipphone_do_stoprecording($res, $callid);
 ipworksvoip_ipphone_do_transfer($res, $callid, $number, $wait);
 ipworksvoip_ipphone_do_typedigit($res, $callid, $digit);
 ipworksvoip_ipphone_do_unhold($res, $callid);

Remarks

TBD.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Active	TBD.
CallCount	The number of records in the Call arrays.
CallCallId	TBD.
CallConferenceId	TBD.
CallDuration	TBD.
CallLastStatus	TBD.
CallLocalAddress	TBD.
CallLocalPort	TBD.
CallMicrophone	TBD.
CallMuteMicrophone	TBD.
CallMuteSpeaker	TBD.
CallOutgoing	TBD.
CallPlaying	TBD.
CallRecording	TBD.
CallRemoteAddress	TBD.
CallRemotePort	TBD.
CallRemoteURI	TBD.
CallRemoteUser	TBD.
CallSpeaker	TBD.
CallStartedAt	TBD.
CallState	TBD.
CallUserInput	TBD.
CallVia	TBD.
Extension	TBD.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The UDP port in the local host where UDP binds.
MicrophoneCount	The number of records in the Microphone arrays.
MicrophoneChannels	Number specifying whether the device supports mono (1) or stereo (2) output.
MicrophoneManufacturerId	Manufacturer identifier for the device driver for the device.
MicrophoneName	TBD.
MicrophoneProductId	Product identifier for the device.
MicrophoneSupport	Optional functionality supported by the device.
MicrophoneSupportedFormats	Standard formats that are supported.
Password	TBD.
SpeakerCount	The number of records in the Speaker arrays.
SpeakerChannels	Number specifying whether the device supports mono (1) or stereo (2) output.
SpeakerManufacturerId	Manufacturer identifier for the device driver for the device.
SpeakerName	TBD.
SpeakerProductId	Product identifier for the device.
SpeakerSupport	Optional functionality supported by the device.
SpeakerSupportedFormats	Standard formats that are supported.
STUNServer	TBD.
User	TBD.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Activate	TBD.
Answer	TBD.
Config	Sets or retrieves a configuration setting.
Deactivate	TBD.
Decline	TBD.
Dial	TBD.
DoEvents	Processes events from the internal message queue.
Hangup	TBD.
HangupAll	TBD.
Hold	TBD.
JoinConference	TBD.
LeaveConference	TBD.
ListConferences	TBD.
ListMicrophones	TBD.
ListSpeakers	TBD.
PlayFile	TBD.
PlayText	TBD.
RecordToFile	TBD.
Reset	Reset the class.
SetMicrophone	TBD.
SetSpeaker	TBD.
StopPlaying	TBD.
StopRecording	TBD.
Transfer	TBD.
TypeDigit	TBD.
Unhold	TBD.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Activated	TBD.
CallReady	TBD.
CallTerminated	TBD.
Deactivated	TBD.
Digit	TBD.
Error	Information about errors during data delivery.
IncomingCall	TBD.
Log	TBD.
OutgoingCall	TBD.
Played	TBD.
Silence	TBD.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

STUNPort	TBD.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

Active Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getActive();

Procedural Interface

ipworksvoip_ipphone_get($res, 1 );

Default Value

false

Remarks

TBD TBD.

This property is read-only and not available at design time.

Data Type

Boolean

CallCount Property (IPWorksVoIP_IPPhone Class)

The number of records in the Call arrays.

Object Oriented Interface

public function getCallCount();

Procedural Interface

ipworksvoip_ipphone_get($res, 2 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CallCallId
• CallConferenceId
• CallDuration
• CallLastStatus
• CallLocalAddress
• CallLocalPort
• CallMicrophone
• CallMuteMicrophone
• CallMuteSpeaker
• CallOutgoing
• CallPlaying
• CallRecording
• CallRemoteAddress
• CallRemotePort
• CallRemoteURI
• CallRemoteUser
• CallSpeaker
• CallStartedAt
• CallState
• CallUserInput
• CallVia

The array indices start at 0 and end at CallCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

CallCallId Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallCallId($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 3 , $callindex);

Default Value

''

Remarks

TBD

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallConferenceId Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallConferenceId($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 4 , $callindex);

Default Value

''

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallDuration Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallDuration($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 5 , $callindex);

Default Value

0

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Integer

CallLastStatus Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallLastStatus($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 6 , $callindex);

Default Value

0

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Integer

CallLocalAddress Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallLocalAddress($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 7 , $callindex);

Default Value

''

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallLocalPort Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallLocalPort($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 8 , $callindex);

Default Value

0

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Integer

CallMicrophone Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallMicrophone($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 9 , $callindex);

Default Value

''

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallMuteMicrophone Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallMuteMicrophone($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 10 , $callindex);

Default Value

false

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CallMuteSpeaker Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallMuteSpeaker($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 11 , $callindex);

Default Value

false

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CallOutgoing Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallOutgoing($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 12 , $callindex);

Default Value

false

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CallPlaying Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallPlaying($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 13 , $callindex);

Default Value

false

Remarks

TBD. Indicate whether the current call is playing text, wav file or wav stream. After the playing is done, this flag will be changed to false.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CallRecording Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallRecording($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 14 , $callindex);

Default Value

false

Remarks

TBD. Indicate whether the current call is recording the received voice from the peer. When the recording is done, this flag will be changed to false.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CallRemoteAddress Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallRemoteAddress($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 15 , $callindex);

Default Value

''

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallRemotePort Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallRemotePort($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 16 , $callindex);

Default Value

0

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Integer

CallRemoteURI Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallRemoteURI($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 17 , $callindex);

Default Value

''

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallRemoteUser Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallRemoteUser($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 18 , $callindex);

Default Value

''

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallSpeaker Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallSpeaker($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 19 , $callindex);

Default Value

''

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallStartedAt Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallStartedAt($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 20 , $callindex);

Default Value

0

Remarks

TBD. in milliseconds

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Long64

CallState Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallState($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 21 , $callindex);

Default Value

0

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Integer

CallUserInput Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallUserInput($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 22 , $callindex);

Default Value

''

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallVia Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getCallVia($callindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 23 , $callindex);

Default Value

''

Remarks

TBD.

The $callindex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

Extension Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getExtension();


public function setExtension($value);

Procedural Interface

ipworksvoip_ipphone_get($res, 24 );


ipworksvoip_ipphone_set($res, 24, $value );

Default Value

''

Remarks

TBD.

This property is not available at design time.

Data Type

String

LocalHost Property (IPWorksVoIP_IPPhone Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();


public function setLocalHost($value);

Procedural Interface

ipworksvoip_ipphone_get($res, 25 );


ipworksvoip_ipphone_set($res, 25, $value );

Default Value

''

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (IPWorksVoIP_IPPhone Class)

The UDP port in the local host where UDP binds.

Object Oriented Interface

public function getLocalPort();


public function setLocalPort($value);

Procedural Interface

ipworksvoip_ipphone_get($res, 26 );


ipworksvoip_ipphone_set($res, 26, $value );

Default Value

0

Remarks

The LocalPort property must be set before UDP is activated (Active is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting it to 0 (default) enables the TCP/IP stack to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established.

LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class is Active will generate an error.

The LocalPort property is useful when trying to connect to services that require a trusted port in the client side.

Data Type

Integer

MicrophoneCount Property (IPWorksVoIP_IPPhone Class)

The number of records in the Microphone arrays.

Object Oriented Interface

public function getMicrophoneCount();

Procedural Interface

ipworksvoip_ipphone_get($res, 27 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MicrophoneChannels
• MicrophoneManufacturerId
• MicrophoneName
• MicrophoneProductId
• MicrophoneSupport
• MicrophoneSupportedFormats

The array indices start at 0 and end at MicrophoneCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

MicrophoneChannels Property (IPWorksVoIP_IPPhone Class)

Number specifying whether the device supports mono (1) or stereo (2) output.

Object Oriented Interface

public function getMicrophoneChannels($microphoneindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 28 , $microphoneindex);

Default Value

0

Remarks

Number specifying whether the device supports mono (1) or stereo (2) output. TBD

The $microphoneindex parameter specifies the index of the item in the array. The size of the array is controlled by the MicrophoneCount property.

This property is read-only and not available at design time.

Data Type

Integer

MicrophoneManufacturerId Property (IPWorksVoIP_IPPhone Class)

Manufacturer identifier for the device driver for the device.

Object Oriented Interface

public function getMicrophoneManufacturerId($microphoneindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 29 , $microphoneindex);

Default Value

0

Remarks

Manufacturer identifier for the device driver for the device. TBD

The $microphoneindex parameter specifies the index of the item in the array. The size of the array is controlled by the MicrophoneCount property.

This property is read-only and not available at design time.

Data Type

Integer

MicrophoneName Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getMicrophoneName($microphoneindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 30 , $microphoneindex);

Default Value

''

Remarks

TBD

The $microphoneindex parameter specifies the index of the item in the array. The size of the array is controlled by the MicrophoneCount property.

This property is read-only and not available at design time.

Data Type

String

MicrophoneProductId Property (IPWorksVoIP_IPPhone Class)

Product identifier for the device.

Object Oriented Interface

public function getMicrophoneProductId($microphoneindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 31 , $microphoneindex);

Default Value

0

Remarks

Product identifier for the device. TBD

The $microphoneindex parameter specifies the index of the item in the array. The size of the array is controlled by the MicrophoneCount property.

This property is read-only and not available at design time.

Data Type

Integer

MicrophoneSupport Property (IPWorksVoIP_IPPhone Class)

Optional functionality supported by the device.

Object Oriented Interface

public function getMicrophoneSupport($microphoneindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 32 , $microphoneindex);

Default Value

0

Remarks

Optional functionality supported by the device. TBD

The $microphoneindex parameter specifies the index of the item in the array. The size of the array is controlled by the MicrophoneCount property.

This property is read-only and not available at design time.

Data Type

Integer

MicrophoneSupportedFormats Property (IPWorksVoIP_IPPhone Class)

Standard formats that are supported.

Object Oriented Interface

public function getMicrophoneSupportedFormats($microphoneindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 33 , $microphoneindex);

Default Value

0

Remarks

Standard formats that are supported. TBD

The $microphoneindex parameter specifies the index of the item in the array. The size of the array is controlled by the MicrophoneCount property.

This property is read-only and not available at design time.

Data Type

Integer

Password Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

ipworksvoip_ipphone_get($res, 34 );


ipworksvoip_ipphone_set($res, 34, $value );

Default Value

''

Remarks

TBD.

This property is not available at design time.

Data Type

String

SpeakerCount Property (IPWorksVoIP_IPPhone Class)

The number of records in the Speaker arrays.

Object Oriented Interface

public function getSpeakerCount();

Procedural Interface

ipworksvoip_ipphone_get($res, 35 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SpeakerChannels
• SpeakerManufacturerId
• SpeakerName
• SpeakerProductId
• SpeakerSupport
• SpeakerSupportedFormats

The array indices start at 0 and end at SpeakerCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SpeakerChannels Property (IPWorksVoIP_IPPhone Class)

Number specifying whether the device supports mono (1) or stereo (2) output.

Object Oriented Interface

public function getSpeakerChannels($speakerindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 36 , $speakerindex);

Default Value

0

Remarks

Number specifying whether the device supports mono (1) or stereo (2) output. TBD

The $speakerindex parameter specifies the index of the item in the array. The size of the array is controlled by the SpeakerCount property.

This property is read-only and not available at design time.

Data Type

Integer

SpeakerManufacturerId Property (IPWorksVoIP_IPPhone Class)

Manufacturer identifier for the device driver for the device.

Object Oriented Interface

public function getSpeakerManufacturerId($speakerindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 37 , $speakerindex);

Default Value

0

Remarks

Manufacturer identifier for the device driver for the device. TBD

The $speakerindex parameter specifies the index of the item in the array. The size of the array is controlled by the SpeakerCount property.

This property is read-only and not available at design time.

Data Type

Integer

SpeakerName Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getSpeakerName($speakerindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 38 , $speakerindex);

Default Value

''

Remarks

TBD

The $speakerindex parameter specifies the index of the item in the array. The size of the array is controlled by the SpeakerCount property.

This property is read-only and not available at design time.

Data Type

String

SpeakerProductId Property (IPWorksVoIP_IPPhone Class)

Product identifier for the device.

Object Oriented Interface

public function getSpeakerProductId($speakerindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 39 , $speakerindex);

Default Value

0

Remarks

Product identifier for the device. TBD

The $speakerindex parameter specifies the index of the item in the array. The size of the array is controlled by the SpeakerCount property.

This property is read-only and not available at design time.

Data Type

Integer

SpeakerSupport Property (IPWorksVoIP_IPPhone Class)

Optional functionality supported by the device.

Object Oriented Interface

public function getSpeakerSupport($speakerindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 40 , $speakerindex);

Default Value

0

Remarks

Optional functionality supported by the device. TBD

The $speakerindex parameter specifies the index of the item in the array. The size of the array is controlled by the SpeakerCount property.

This property is read-only and not available at design time.

Data Type

Integer

SpeakerSupportedFormats Property (IPWorksVoIP_IPPhone Class)

Standard formats that are supported.

Object Oriented Interface

public function getSpeakerSupportedFormats($speakerindex);

Procedural Interface

ipworksvoip_ipphone_get($res, 41 , $speakerindex);

Default Value

0

Remarks

Standard formats that are supported. TBD

The $speakerindex parameter specifies the index of the item in the array. The size of the array is controlled by the SpeakerCount property.

This property is read-only and not available at design time.

Data Type

Integer

STUNServer Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getSTUNServer();


public function setSTUNServer($value);

Procedural Interface

ipworksvoip_ipphone_get($res, 42 );


ipworksvoip_ipphone_set($res, 42, $value );

Default Value

''

Remarks

TBD.

This property is not available at design time.

Data Type

String

User Property (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function getUser();


public function setUser($value);

Procedural Interface

ipworksvoip_ipphone_get($res, 43 );


ipworksvoip_ipphone_set($res, 43, $value );

Default Value

''

Remarks

TBD.

This property is not available at design time.

Data Type

String

Activate Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doActivate($host, $port);

Procedural Interface

ipworksvoip_ipphone_do_activate($res, $host, $port);

Remarks

TBD.

Answer Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doAnswer($callid);

Procedural Interface

ipworksvoip_ipphone_do_answer($res, $callid);

Remarks

TBD.

Config Method (IPWorksVoIP_IPPhone Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksvoip_ipphone_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Deactivate Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doDeactivate();

Procedural Interface

ipworksvoip_ipphone_do_deactivate($res);

Remarks

TBD.

Decline Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doDecline($callid);

Procedural Interface

ipworksvoip_ipphone_do_decline($res, $callid);

Remarks

TBD.

Dial Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doDial($number, $callernumber, $wait);

Procedural Interface

ipworksvoip_ipphone_do_dial($res, $number, $callernumber, $wait);

Remarks

TBD.

DoEvents Method (IPWorksVoIP_IPPhone Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksvoip_ipphone_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Hangup Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doHangup($callid);

Procedural Interface

ipworksvoip_ipphone_do_hangup($res, $callid);

Remarks

TBD.

HangupAll Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doHangupAll();

Procedural Interface

ipworksvoip_ipphone_do_hangupall($res);

Remarks

TBD.

Hold Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doHold($callid);

Procedural Interface

ipworksvoip_ipphone_do_hold($res, $callid);

Remarks

TBD.

JoinConference Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doJoinConference($callid, $conferenceid);

Procedural Interface

ipworksvoip_ipphone_do_joinconference($res, $callid, $conferenceid);

Remarks

TBD.

LeaveConference Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doLeaveConference($callid);

Procedural Interface

ipworksvoip_ipphone_do_leaveconference($res, $callid);

Remarks

TBD.

ListConferences Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doListConferences();

Procedural Interface

ipworksvoip_ipphone_do_listconferences($res);

Remarks

TBD.

ListMicrophones Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doListMicrophones();

Procedural Interface

ipworksvoip_ipphone_do_listmicrophones($res);

Remarks

TBD.

ListSpeakers Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doListSpeakers();

Procedural Interface

ipworksvoip_ipphone_do_listspeakers($res);

Remarks

TBD.

PlayFile Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doPlayFile($callid, $wavfile);

Procedural Interface

ipworksvoip_ipphone_do_playfile($res, $callid, $wavfile);

Remarks

TBD.

PlayText Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doPlayText($callid, $text);

Procedural Interface

ipworksvoip_ipphone_do_playtext($res, $callid, $text);

Remarks

TBD.

RecordToFile Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doRecordToFile($callid, $recordfile);

Procedural Interface

ipworksvoip_ipphone_do_recordtofile($res, $callid, $recordfile);

Remarks

TBD.

Reset Method (IPWorksVoIP_IPPhone Class)

Reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksvoip_ipphone_do_reset($res);

Remarks

This method will reset the class's properties to their default values.

SetMicrophone Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doSetMicrophone($microphone);

Procedural Interface

ipworksvoip_ipphone_do_setmicrophone($res, $microphone);

Remarks

TBD.

SetSpeaker Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doSetSpeaker($speaker);

Procedural Interface

ipworksvoip_ipphone_do_setspeaker($res, $speaker);

Remarks

TBD.

StopPlaying Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doStopPlaying($callid);

Procedural Interface

ipworksvoip_ipphone_do_stopplaying($res, $callid);

Remarks

TBD.

StopRecording Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doStopRecording($callid);

Procedural Interface

ipworksvoip_ipphone_do_stoprecording($res, $callid);

Remarks

TBD.

Transfer Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doTransfer($callid, $number, $wait);

Procedural Interface

ipworksvoip_ipphone_do_transfer($res, $callid, $number, $wait);

Remarks

TBD.

TypeDigit Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doTypeDigit($callid, $digit);

Procedural Interface

ipworksvoip_ipphone_do_typedigit($res, $callid, $digit);

Remarks

TBD.

Unhold Method (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function doUnhold($callid);

Procedural Interface

ipworksvoip_ipphone_do_unhold($res, $callid);

Remarks

TBD.

Activated Event (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function fireActivated($param);

Procedural Interface

ipworksvoip_ipphone_register_callback($res, 1, array($this, 'fireActivated'));

Parameter List

Remarks

TBD

CallReady Event (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function fireCallReady($param);

Procedural Interface

ipworksvoip_ipphone_register_callback($res, 2, array($this, 'fireCallReady'));

Parameter List

 'callid'

Remarks

TBD

CallTerminated Event (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function fireCallTerminated($param);

Procedural Interface

ipworksvoip_ipphone_register_callback($res, 3, array($this, 'fireCallTerminated'));

Parameter List

 'callid'

Remarks

TBD

Deactivated Event (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function fireDeactivated($param);

Procedural Interface

ipworksvoip_ipphone_register_callback($res, 4, array($this, 'fireDeactivated'));

Parameter List

Remarks

TBD

Digit Event (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function fireDigit($param);

Procedural Interface

ipworksvoip_ipphone_register_callback($res, 5, array($this, 'fireDigit'));

Parameter List

 'callid'
 'digit'

Remarks

TBD

Error Event (IPWorksVoIP_IPPhone Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksvoip_ipphone_register_callback($res, 6, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

IncomingCall Event (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function fireIncomingCall($param);

Procedural Interface

ipworksvoip_ipphone_register_callback($res, 7, array($this, 'fireIncomingCall'));

Parameter List

 'callid'

Remarks

TBD

Log Event (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksvoip_ipphone_register_callback($res, 8, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

TBD

OutgoingCall Event (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function fireOutgoingCall($param);

Procedural Interface

ipworksvoip_ipphone_register_callback($res, 9, array($this, 'fireOutgoingCall'));

Parameter List

 'callid'

Remarks

TBD

Played Event (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function firePlayed($param);

Procedural Interface

ipworksvoip_ipphone_register_callback($res, 10, array($this, 'firePlayed'));

Parameter List

 'callid'

Remarks

TBD

Silence Event (IPWorksVoIP_IPPhone Class)

TBD.

Object Oriented Interface

public function fireSilence($param);

Procedural Interface

ipworksvoip_ipphone_register_callback($res, 11, array($this, 'fireSilence'));

Parameter List

 'callid'

Remarks

TBD

Config Settings (IPPhone Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

IPPhone Config Settings

STUNPort:   TBD. TBD.

Base Config Settings

BuildInfo:   Information about the product's build. When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations. The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: Identifier Name 037 IBM EBCDIC - U.S./Canada 437 OEM - United States 500 IBM EBCDIC - International 708 Arabic - ASMO 708 709 Arabic - ASMO 449+, BCON V4 710 Arabic - Transparent Arabic 720 Arabic - Transparent ASMO 737 OEM - Greek (formerly 437G) 775 OEM - Baltic 850 OEM - Multilingual Latin I 852 OEM - Latin II 855 OEM - Cyrillic (primarily Russian) 857 OEM - Turkish 858 OEM - Multilingual Latin I + Euro symbol 860 OEM - Portuguese 861 OEM - Icelandic 862 OEM - Hebrew 863 OEM - Canadian-French 864 OEM - Arabic 865 OEM - Nordic 866 OEM - Russian 869 OEM - Modern Greek 870 IBM EBCDIC - Multilingual/ROECE (Latin-2) 874 ANSI/OEM - Thai (same as 28605, ISO 8859-15) 875 IBM EBCDIC - Modern Greek 932 ANSI/OEM - Japanese, Shift-JIS 936 ANSI/OEM - Simplified Chinese (PRC, Singapore) 949 ANSI/OEM - Korean (Unified Hangul Code) 950 ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) 1026 IBM EBCDIC - Turkish (Latin-5) 1047 IBM EBCDIC - Latin 1/Open System 1140 IBM EBCDIC - U.S./Canada (037 + Euro symbol) 1141 IBM EBCDIC - Germany (20273 + Euro symbol) 1142 IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) 1143 IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) 1144 IBM EBCDIC - Italy (20280 + Euro symbol) 1145 IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) 1146 IBM EBCDIC - United Kingdom (20285 + Euro symbol) 1147 IBM EBCDIC - France (20297 + Euro symbol) 1148 IBM EBCDIC - International (500 + Euro symbol) 1149 IBM EBCDIC - Icelandic (20871 + Euro symbol) 1200 Unicode UCS-2 Little-Endian (BMP of ISO 10646) 1201 Unicode UCS-2 Big-Endian 1250 ANSI - Central European 1251 ANSI - Cyrillic 1252 ANSI - Latin I 1253 ANSI - Greek 1254 ANSI - Turkish 1255 ANSI - Hebrew 1256 ANSI - Arabic 1257 ANSI - Baltic 1258 ANSI/OEM - Vietnamese 1361 Korean (Johab) 10000 MAC - Roman 10001 MAC - Japanese 10002 MAC - Traditional Chinese (Big5) 10003 MAC - Korean 10004 MAC - Arabic 10005 MAC - Hebrew 10006 MAC - Greek I 10007 MAC - Cyrillic 10008 MAC - Simplified Chinese (GB 2312) 10010 MAC - Romania 10017 MAC - Ukraine 10021 MAC - Thai 10029 MAC - Latin II 10079 MAC - Icelandic 10081 MAC - Turkish 10082 MAC - Croatia 12000 Unicode UCS-4 Little-Endian 12001 Unicode UCS-4 Big-Endian 20000 CNS - Taiwan 20001 TCA - Taiwan 20002 Eten - Taiwan 20003 IBM5550 - Taiwan 20004 TeleText - Taiwan 20005 Wang - Taiwan 20105 IA5 IRV International Alphabet No. 5 (7-bit) 20106 IA5 German (7-bit) 20107 IA5 Swedish (7-bit) 20108 IA5 Norwegian (7-bit) 20127 US-ASCII (7-bit) 20261 T.61 20269 ISO 6937 Non-Spacing Accent 20273 IBM EBCDIC - Germany 20277 IBM EBCDIC - Denmark/Norway 20278 IBM EBCDIC - Finland/Sweden 20280 IBM EBCDIC - Italy 20284 IBM EBCDIC - Latin America/Spain 20285 IBM EBCDIC - United Kingdom 20290 IBM EBCDIC - Japanese Katakana Extended 20297 IBM EBCDIC - France 20420 IBM EBCDIC - Arabic 20423 IBM EBCDIC - Greek 20424 IBM EBCDIC - Hebrew 20833 IBM EBCDIC - Korean Extended 20838 IBM EBCDIC - Thai 20866 Russian - KOI8-R 20871 IBM EBCDIC - Icelandic 20880 IBM EBCDIC - Cyrillic (Russian) 20905 IBM EBCDIC - Turkish 20924 IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) 20932 JIS X 0208-1990 & 0121-1990 20936 Simplified Chinese (GB2312) 21025 IBM EBCDIC - Cyrillic (Serbian, Bulgarian) 21027 Extended Alpha Lowercase 21866 Ukrainian (KOI8-U) 28591 ISO 8859-1 Latin I 28592 ISO 8859-2 Central Europe 28593 ISO 8859-3 Latin 3 28594 ISO 8859-4 Baltic 28595 ISO 8859-5 Cyrillic 28596 ISO 8859-6 Arabic 28597 ISO 8859-7 Greek 28598 ISO 8859-8 Hebrew 28599 ISO 8859-9 Latin 5 28605 ISO 8859-15 Latin 9 29001 Europa 3 38598 ISO 8859-8 Hebrew 50220 ISO 2022 Japanese with no halfwidth Katakana 50221 ISO 2022 Japanese with halfwidth Katakana 50222 ISO 2022 Japanese JIS X 0201-1989 50225 ISO 2022 Korean 50227 ISO 2022 Simplified Chinese 50229 ISO 2022 Traditional Chinese 50930 Japanese (Katakana) Extended 50931 US/Canada and Japanese 50933 Korean Extended and Korean 50935 Simplified Chinese Extended and Simplified Chinese 50936 Simplified Chinese 50937 US/Canada and Traditional Chinese 50939 Japanese (Latin) Extended and Japanese 51932 EUC - Japanese 51936 EUC - Simplified Chinese 51949 EUC - Korean 51950 EUC - Traditional Chinese 52936 HZ-GB2312 Simplified Chinese 54936 Windows XP: GB18030 Simplified Chinese (4 Byte) 57002 ISCII Devanagari 57003 ISCII Bengali 57004 ISCII Tamil 57005 ISCII Telugu 57006 ISCII Assamese 57007 ISCII Oriya 57008 ISCII Kannada 57009 ISCII Malayalam 57010 ISCII Gujarati 57011 ISCII Punjabi 65000 Unicode UTF-7 65001 Unicode UTF-8 The following is a list of valid code page identifiers for Mac OS only: Identifier Name 1 ASCII 2 NEXTSTEP 3 JapaneseEUC 4 UTF8 5 ISOLatin1 6 Symbol 7 NonLossyASCII 8 ShiftJIS 9 ISOLatin2 10 Unicode 11 WindowsCP1251 12 WindowsCP1252 13 WindowsCP1253 14 WindowsCP1254 15 WindowsCP1250 21 ISO2022JP 30 MacOSRoman 10 UTF16String 0x90000100 UTF16BigEndian 0x94000100 UTF16LittleEndian 0x8c000100 UTF32String 0x98000100 UTF32BigEndian 0x9c000100 UTF32LittleEndian 65536 Proprietary

LicenseInfo:   Information about the current license. When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: Product: The product the license is for. Product Key: The key the license was generated from. License Source: Where the license was found (e.g., RuntimeLicense, License File). License Type: The type of license installed (e.g., Royalty Free, Single Server). Last Valid Build: The last valid build number for which the license will work.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle. If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation. By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to true tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (IPPhone Class)