Device.Active
Device.ActiveCalls
Device.Capabilities
Device.Count
Device.ID
Device.IdleDelay
Device.List
Device.MediaModes
Device.Name
Device.OnHoldCalls
Device.OnHoldPendCalls
Device.OpenCount
Device.RingMode
Device.TranslatePhoneNumber
Device.UnformatPhoneNumber
ActiveX: etLine.DeviceActive
Type: Boolean
When: Design-Time and Run-Time
Read/Write: Read and Write
Edition: Express, Standard, Professional, Enterprise
<Click
here for example>
This property activates and deactivates the telephony line device. The media modes defined in the Device.MediaModes.Open property and the ownership privleges defined in the Privilege sub-properties are used when opening (activating) the telephony line device.
ActiveX: etLine.DeviceActiveCalls
Type: Integer
When: Run-Time
Read/Write: Read Only
Edition: Express, Standard, Professional, Enterprise
This property indicates the number of calls currently active on the TAPI line device identified
in the Device.ID property.
ActiveX: etLine.DeviceCount
Type: Integer
When: Design-Time and Run-Time
Read/Write: Read Only
Version 2.x: LineDevices
Edition: Express, Standard, Professional, Enterprise
<Click
here for example>
This is the number of TAPI line devices available.
ActiveX: etLine.DeviceID
Type: Integer
When: Design-Time and Run-Time
Read/Write: Read and Write
Edition: Express, Standard, Professional, Enterprise
<Click
here for example>
Set this property to indicate which TAPI line device should be used. Legal values for this property are 0 to Device.Count -1. The Device.Name property holds the name.
ActiveX: etLine.DeviceIdleDelay
Type: Integer
When: Design-Time and Run-Time
Read/Write: Read and Write
Edition: Express, Standard, Professional, Enterprise
This is the number of milliseconds that the OnIdle event will delay before firing. The OnIdle
event indicates when the current call is idle, meaning that it not longer exists. Some telephony device
must reset after a call is complete and this may take a bit of time. During this time the TAPI line device
is not actually ready to handle another call. Set this property to a value long enough to take into consideration
the time need to reset the device. With voice modems this can range from 2500 milliseconds (2 1/2 seconds)
to 5000 milliseconds (5 seconds).
See the OnIdle event for more inforamtion.
ActiveX: etLine.DeviceList
Type: TStrings
When: Design-Time and Run-Time
Read/Write: Read Only
Edition: Express, Standard, Professional, Enterprise
<Click
here for example>
This is a list of the available TAPI line devices according to the Windows operating system. There are (Device.Count - 1) devices listed in the order of their ID value. The first device in the list has an ID of 0, the last device has an ID of (Device.Count -1).
ActiveX: etLine.DeviceName
Type: String
When: Design-Time and Run-Time
Read/Write: Read and Write
Edition: Express, Standard, Professional, Enterprise
<Click
here for example>
This is the name of the device identified in the Device.ID property. This property can also be set to the exact name of the telephony device. If an exact match is found the the Device.ID is updated.
This is useful for your application configuration bacause the name of the device is less likely to change than the device ID. The device ID is assigned by the Windows operating system and may change if other devices are added or deleted. For example, save the Device.Name property when exiting your application. When starting your application retrieve the stored name and set this property.
ActiveX: etLine.DeviceOnHoldCalls
Type: Integer
When: Run-Time
Read/Write: Read Only
Edition: Express, Standard, Professional, Enterprise
This property contains a count of all calls in the onhold state for the TAPI line device
defined in etLine.Device.ID.
ActiveX: etLine.DeviceOnHoldPendCalls
Type: Integer
When: Run-Time
Read/Write: Read Only
Edition: Express, Standard, Professional, Enterprise
This property contains a count of all calls in the onholdpendingtransfer or onholdpendingconference
state for the TAPI line device defined in etLine.Device.ID.
ActiveX: etLine.DeviceOpenCount
Type: Integer
When: Run-Time
Read/Write: Read Only
Edition: Express, Standard, Professional, Enterprise
This property contains a count of all the instances of objects that have currently openned (activated)
the TAPI line device defined in etLine.Device.ID.
ActiveX: etLine.DeviceRingMode
Type: Integer
When: Run-Time
Read/Write: Read Only
Edition: Express, Standard, Professional, Enterprise
This indicates the current ring mode for the TAPI line device defined in Device.ID. The telephony
hardware manufacture can supply this information.
There is only one ring mode for modems using the Unimodem or UnimodemV Telephony Service Provider (TSP).
ActiveX: etLine.DeviceTranslatePhoneNumber
Type: Boolean
When: Design-Time and Run-Time
Read/Write: Read and Write
Edition: Express, Standard, Professional, Enterprise
The property is used to control the format of phone number for inbound and outbound calls.
Inbound Calls
Most Telephony Service Providers (TSP) supply the CallerID phone number as a simple string without formatting. Some TSP's will format the CallerID phone numbers to appear in canonical address format. Set this property to False to remove the formatting. Set this property to True to leave the number as is it supplied by the TSP. The etLine.Call.CallerID.MaskNumber will be applied after this property causes the number to be unformatted.
This property will effect the following properties: etLine.Call.CalledID.Number, etLine.Call.CallerID.Number, etLine.Call.ConnectedID.Number, etLine.Call.RedirectingID.Number and etLine.Call.Redirection.Number.
For example if the TSP supplies the CallerID number "+1 (919) 233-2232", this property is set to True and the etLine.Call.CallerID.MaskNumber is blank then etLine.Call.CallerID.Number will have the value "+1 (919) 233-2232". If this property is false then etLine.Call.CallerID.Number will have the value "19192332232"
If the TSP supplies the CallerID number "9192332232", this property is set to True and the etLine.Call.CallerID.MaskNumber is "000-000-0000;*" then etLine.Call.CallerID.Number will have the value "919-233-2232". If this property is false then etLine.Call.CallerID.Number will have the same value, "919-233-2232"
Outbound Calls
If this property is set to true then when setting the value of the Phone Number properties the value be modified according to the dialing properties for the selected Device.ID.
See the properties etLine.Call.PhoneNumber, etLine.Conference.PhoneNumber and etLine.Transfer.PhoneNumber.
When this property is set to True the Phone Number properties must use Canonical Addresses to take advantage of the dialing properties.
Canonical Address Format
The canonical address (phone number) format is intended to be a universally constant directory number. For this reason, numbers in address books are best stored using canonical format. A canonical address is an ASCII string with the following structure:
+ CountryCode Space [(AreaCode) Space] SubscriberNumber | Subaddress ^ Name CRLF ...
The components of this structure are described in the following table.
|
Component |
Meaning |
|
+ |
Equivalent to ASCII Hex (2B). Indicates that the number that follows it uses the canonical format. |
|
CountryCode |
A variably sized string containing one or more of the digits "0" through "9". The CountryCode is delimited by the following Space. It identifies the country in which the address is located. |
|
Space |
Exactly one ASCII space character (0x20). It is used to delimit the end of the CountryCode part of an address. |
|
AreaCode |
A variably sized string containing zero or more of the digits "0" through "9". AreaCode is the area code part of the address and is optional. If the area code is present, it must be preceded by exactly one ASCII left parenthesis character (0x28), and be followed by exactly one ASCII right parenthesis character (0x29) and one ASCII Space character (0x20). |
|
SubscriberNumber |
A variably sized string containing one or more of the digits "0" through "9". It may include other formatting characters as well, including any of the dialing control characters described in the Dialable Address Format: AaBbCcDdPpTtWw*#!,@$? The subscriber number should not contain the left parenthesis or right parenthesis character (which are used only to delimit the area code), nor should it contain the "|", "^", or CRLF characters (which are used to begin following fields). Most commonly, nondigit characters in the subscriber number would include only spaces, periods ("."), and dashes ("-"). Any allowable nondigit characters that appear in the subscriber number are omitted from the DialableString returned by the lineTranslateAddress function, but are retained in the DisplayableString. |
|
| |
ASCII Hex (7C). If this optional character is present, the information following it up to the next + | ^ CRLF, or the end of the canonical address string is treated as subaddress information, as for an ISDN subaddress. |
|
Subaddress |
A variably sized string containing a subaddress. The string is delimited by + | ^ CRLF or the end of the address string. During dialing, subaddress information is passed to the remote party. It can be such things as an ISDN subaddress or an e-mail address. |
|
^ |
ASCII Hex (5E). If this optional character is present, the information following it up to the next CRLF or the end of the canonical address string is treated as an ISDN name. |
|
Name |
A variably sized string treated as name information. Name is delimited by CRLF or the end of the canonical address string and can contain other delimiters. During dialing, name information is passed to the remote party. |
|
CRLF |
ASCII Hex (0D) followed by ASCII Hex (0A), and is optional. If present, it indicates that another canonical number is following this one. It is used to separate multiple canonical addresses as part of a single address string (inverse multiplexing). For example, the canonical representation of the main switchboard telephone number at Microsoft Corporation would be: +1 (425) 882-8080 |
ActiveX: etLine.DeviceUnformatPhoneNumber
Type: Boolean
When: Design-Time and Run-Time
Read/Write: Read and Write
Edition: Express, Standard, Professional, Enterprise
Some TSPs cannot handle phone numbers with any characters other than legal TAPI digits. When this
property is set to true, formatting characters such as plus ("+"), open paren ("("),
close paren (")"), dash ("-"), and period (".") are stripped from Call.PhoneNumber
when the Call.Dial method is called.
See the Call.PhoneNumber property.
|
|