etLine Events

OnAddressForward
OnAddressState
OnBusy
OnCallBegin
OnCalledID
OnCallEnd
OnCallerID
OnCallInfo
OnCallMediaModeChange
OnCallOwnerChange
OnCallState
OnConferenced
OnConnected
OnConnectedID
OnDevSpecific
OnDevSpecificFeature
OnDialing
OnDialtone
OnDigitReceived
OnDigitSent
OnDigitsGathered
OnDisconnected
OnError
OnHold
OnHoldPendingConference
OnHoldPendingTransfer
OnIdle
OnLineState
OnMessageOff
OnMessageOn
OnOffering
OnProceeding
OnRedirectingID
OnRedirectionID
OnRing
OnRingBack
OnSilence
OnSpecialInfo
OnTAPIMessage
OnTAPIReply
OnToneSent
 

etLine.OnAddressForward

Parameters: Address: Integer
                             State: Integer
Edition: Professional, Enterprise
This event indicates that the etLine.Address.Forward properties have changed.

The Address parameter contains the address ID for the address for which the event fired. Also see the etLine.Address.ID property.

Availability: This event will fire only if the bit flag LINEADDRESSSTATE_FORWARD is set in the property etLine.Address.Capabilities.States.

In TAPI terms: This can happen when TAPI sends the LINE_ADDRESSSTATE message with the first parameter LINEADDRESSSTATE_FORWARD.

etLine.OnAddressState

Parameters: Address: Integer
                             State: Integer
Edition: Professional, Enterprise
This event indicates that the etLine.Address.Forward properties have changed.

The Address parameter contains the address ID for the address for which the event fired. Also see the etLine.Address.ID property.

Availability: This event will fire only if the bit flag LINEADDRESSSTATE_FORWARD is set in the property etLine.Address.Capabilities.States.

In TAPI terms: This can happen when TAPI sends the LINE_ADDRESSSTATE message with the first parameter LINEADDRESSSTATE_FORWARD.

etLine.OnBusy

Parameters: CallHandle: Integer
Edition: Express, Standard, Professional, Enterprise
<Click here for example>

This event is called when the telephony device hears a busy tone.

The OnCallState event fires immediately before this event. The Call.BusyMode property is updated when this event fires.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_BUSY is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This can happen when TAPI sends the LINE_CALLSTATE message with the first parameter LINECALLSTATE_BUSY or the first parameter is LINECALLSTATE_DISCONNECTED and second parameter is LINEDISCONNECTMODE_BUSY.

etLine.OnCallBegin

Parameters: CallHandle: Integer
Edition: Express, Standard, Professional, Enterprise
<Click here for example>

This event is called when a Call begins. The etLine.Call.Began property is set to the current date and time.

In most cases the etLine.OnCallBegin and etLine.OnCallEnd events are the first and last events to fire for each call. These events are not directly generated by TAPI. The etLine.OnCallBegin event fires as soon as TAPI informs etLine that a call has been created, at which time etLine dynamically creates a memory structure to hold the call information. When etLine identifies that the call no longer exists, the etLine.OnCallEnded event fires and the memory structure is releases.

etLine.OnCalledID

Parameters: CallHandle: Integer
Edition: Standard, Professional, Enterprise
<Click here for example>

This event is fired when TAPI indicates that the Called ID information has become available or has changed. The etLine.Call.CalledID properties are updated to reflect the available information. The etLine.OnCallInfo event is fired just before this event.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLINFOSTATE_CALLEDID is set in the property etLine.Address.Capabilities.CallInfoStates.

In TAPI terms: This event is fired when the message LINE_CALLINFO is received with the parameter

LINECALLINFOSTATE_CALLEDID.

etLine.OnCallEnd

Parameters: CallHandle: Integer
Edition: Express, Standard, Professional, Enterprise
<Click here for example>

When this event is fired, the etLine.Call.Ended property is set. This event can be fired at two different times.

In most cases the etLine.OnCallBegin and etLine.OnCallEnd events are the first and last events to fire for each call. These events are not directly generated by TAPI. The etLine.OnCallBegin event fires as soon as TAPI informs etLine that a call has been created, at which time etLine dynamically creates a memory structure to hold the call information. When etLine identifies that the call no longer exists, the etLine.OnCallEnded event fires and the memory structure is releases.

etLine.OnCallerID

Parameters: CallHandle: Integer
Edition: Express, Standard, Professional, Enterprise
<Click here for example>

This event is fired when TAPI indicates that the Caller ID information has become available or has changed. The etLine.Call.CallerID properties are updated to reflect the available information. The etLine.OnCallInfo event is fired just before this event.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLINFOSTATE_CALLERID is set in the property etLine.Address.Capabilities.CallInfoStates.

In TAPI terms: This event is fired when the message LINE_CALLINFO is received with the parameter LINECALLINFOSTATE_CALLERID.

NOTE: In some cases this event has been known to fire multiple times for a single call. It is important to remember that this event signals that the Caller ID information has changed.

etLine.OnCallInfo

Parameters: CallHandle: Integer
     CallInfoState: Integer
Edition: Enterprise
This event is fired each time the call information changes.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

The CallInfoState parameter indicate the call information that has changed. Can be one or more of the LINECALLINFOSTATE_ constants.

Note: This event will not be displayed in the TeleScope log unless the etLine.Popup.OnCallInfo property is set to true. The value of the property etLine.Popup.OnCallInfo does not affect the firing of this property.

In TAPI terms: This is fired when the LINE_CALLINFO message is received.

etLine.OnCallMediaModeChange

Parameters: CallHandle: Integer
Edition: Professional, Enterprise

This event is fired when TAPI indicates that the media mode of the call has changed. The etLine.Call.MonitorMediaMode.Active property must first be set to true and the property etLine.Call.MonitorMediaMode.MediaModes must also be set.

The etLine.Call.MediaMode property is updated. The etLine.OnCallInfo event may or may not be fired.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLFEATURE_MONITORMEDIA is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: The LINE_MONITORMEDIA message is received from TAPI, the function lineMonitorMedia must first be called.

The following example shows the call being handed off to another application when it is identified to be from a fax machine:

Visual Basic

Private Sub etLine1_OnCallMediaModeChange(ByVal CallHandle As Long)

    If ((etLine1.CallMediaMode And LINEMEDIAMODE_G3FAX) <> 0) Then

        etLine1.CallHandOff(TextApplication.Text)

    End If

End Sub

Delphi

procedure TForm1.etLine1CallMediaModeChange(Sender: TObject; CallHandle: Integer);

begin

  if (etLine1.Call.MediaMode and LINEMEDIAMODE_G3FAX) <> 0 then

    etLine1.Call.HandOff(EditApplication.Text)

end;

etLine.OnCallOwnerChange

Parameters: CallHandle: Integer
Edition: Standard, Professional, Enterprise
This event is fired when the application's ownership of the current call changes. The Call.Owner property is updated.

Other applications may cause the ownership to change and therefore this event will fire. When the etLine.Call.Handoff method is call successfully will also cause this event to be fired.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

In TAPI terms: This event will fire when the LINE_CALLSTATE message is received then the function lineGetCallStatus is called and the value of the dwCallPrivilege is different.

etLine.OnCallState

Parameters: CallHandle: Integer
     State: Integer
     StateMode: Integer
     Privilege: Integer
Edition: Enterprise
This event is fired each time that the LINE_CALLSTATE message is received from TAPI.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

The State parameter is equivalent to the new value of the property etLine.Call.State.

The StateMode parameter is equivalent to the new value of the property etLine.Call.StateMode.

If the Privilege parameter is zero, there has been no change in the application's privilege for the call.

If nonzero, it specifies the application's privilege for the call. This occurs in the following situations: (1) when the call is created; (2) When the application is the target of a call handoff (even if the application already was an owner of the call). This parameter uses one of the following LINECALLPRIVILEGE_ constants

Note: This event will not be displayed in the TeleScope log unless the etLine.Popup.OnCallState property is set to true. The value of the property etLine.Popup.OnCallState does not affect the firing of this property.

In TAPI terms: This event will fire when the LINE_CALLSTATE message is received.

etLine.OnConferenced

Parameters: CallHandle: Integer
Edition: Enterprise
The call is currently a member of a multiparty conference call.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_CONFERENCED is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This event fires when the LINE_CALLSTATE message is received with the parameter LINECALLSTATE_CONFERENCED.

etLine.OnConnected

Parameters: CallHandle: Integer
Edition: Express, Standard, Professional, Enterprise
<Click here for example>

For outbound calls this event is fired when the called party answers the call. Sophisticated telephony devices listen for voice energy, such as someone saying "Hello".

For inbound calls, this event will fire when the etLine.CallAnswer method is called and returns True.

The OnCallState event fires immediately before this event. Several Call properties are updated when this event fires.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_CONNECTED is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This event fires when the LINE_CALLSTATE message is received with the parameter LINECALLSTATE_CONNECTED.

Note: For outbound calls with voice modems, this event will fire immediately after dialing. Voice modems are not capable of outbound Call Progress Monitoring (CPM). Therefore the etLine.OnConnected event is called immediately after dialing is complete. This is a limitation of modems and the UnimodemV Telephony Service Provider (TSP) supplied by Microsoft. If your application requires outbound CPM, consider a more sophisticated telephony device See the "Products | Telephony Hardware" section of our web site at http://www.exceletel.com for more information.

etLine.OnConnectedID

Parameters: CallHandle: Integer
Edition: Professional, Enterprise
<Click here for example>

This event is fired when TAPI indicates that the Connected ID information has become available or has changed. The etLine.Call.ConnectedID properties are updated to reflect the available information. The etLine.OnCallInfo event is fired just before this event.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLINFOSTATE_CONNECTEDID is set in the property etLine.Address.Capabilities.CallInfoStates.

In TAPI terms: This event is fired when the message LINE_CALLINFO is received with the parameter LINECALLINFOSTATE_CONNECTEDID.

etLine.OnDevSpecific

Parameters: hDevice: Integer
                             lParam1: Integer
                             lParam2: Integer
                             lParam3: Integer
Edition: Enterprise

This event fires to notify the application about device-specific events occurring on a line, address, or call. The meaning of the message and the interpretation of the parameters are device specific.

In TAPI terms: This event fires each time that the LINE_DEVSPECIFIC message is received.

etLine.OnDevSpecificFeature

Parameters: hDevice: Integer
                             lParam1: Integer
                             lParam2: Integer
                             lParam3: Integer
Edition: Enterprise

This event fires to notify the application about device-specific events occurring on a line, address, or call. The meaning of the message and the interpretation of the parameters are device specific.

In TAPI terms: This event fires each time that the LINE_DEVSPECIFICFEATURE message is received.

etLine.OnDialing

Parameters: CallHandle: Integer
Edition: Standard, Professional, Enterprise
<Click here for example>

This event fires each time that the device dials.

The OnCallState event fires immediately before this event.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_DIALING is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This event fires each time that the LINE_CALLSTATE message is received with the parameter LINECALLSTATE_DIALING.

etLine.OnDialtone

Parameters: CallHandle: Integer
Edition: Expess, Standard, Professional, Enterprise
<Click here for example>

This event is called when the device detects a dial tone.

The OnCallState event fires immediately before this event. The Call.DialToneMode is updated when this event fires.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_DIALTONE is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This event fires when the LINE_CALLSTATE message is received with the parameter LINECALLSTATE_DIALTONE.

Note: When using a Dialogic card you will need to add the capital letter "L" to the begining of the phone number other wise the etLine.OnDialtone event will fire even when a dialtone is not detected. This tells the card to listen for a local dialtone.

When the "L" is added to the phone number the etLine1.CallDialtoneMode will have a value of LINEDIALTONEMODE_NORMAL or LINEDIALTONEMODE_???. If the "L" is not used it will always have a value of LINEDIALTONEMODE_???. The setting for the etLine.DeviceTranslatePhoneNumber and etLine.DeviceUnformatPhoneNumber properties will not cause the "L" to be removed.

etLine.OnDigitReceived

Parameters: CallHandle: Integer
                    Digit: Char
                    Tag: Integer
Edition: Standard, Professional, Enterprise
<Click here for example>

This event is fired when the telephony device detects a digit, pulse or DTMF depending on the capabilities of the device. The etLine.Call.MonitorDigits.Active property must first be set to true. A call must exist in the the Connected state, the etLine.OnConnected event must have fired.

The CallHandle parameter contains the call handle for the call for which this event fired. Also see the etLine.Call.Handle property.

The digit is returned in the Digit parameter as a number that represents the ASCII value of the digit. This can be converted to a character.

The Tag parameter has no defined meaning. It is provided for the convenience of storing additional integer value or pointer information for special needs in an application. This event passes the current value of this property in its Tag parameter. The combination of etLine.Call.Tag property and the Tag parameter for this event may be used to manage the flow of your application. The IVR4Line sample program use this methodology to manage the menu of the Interactive Voice Response (IVR) system.

Availability: This event will fire only if the bit flag LINECALLFEATURE_MONITORDIGITS is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: This event fires when the LINE_MONITORDIGITS message is received.

etLine.OnDigitsSent

Parameters: CallHandle: Integer
Edition: Express, Standard, Professional, Enterprise
This event fires to notify the application that the current etLine.Call.SendDigit operation has finished. The event also fires when digit generation is canceled.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLFEATURE_GENERATEDIGITS is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: This event fires each time that the LINE_GENERATE message is received.

etLine.OnDigitsGathered

Parameters: CallHandle: Integer
                             Digits: String
                             Termination: Integer
                             Tag: Integer
Edition: Professional, Enterprise
After setting the property etLine.Call.GatherDigits.Active to True this event fires when the gathering of digits has terminated. After this event fires the property etLine.Call.GatherDigits.Active will have a value of False.

The CallHandle parameter contains the call handle for the call for which this event fired. Also see the etLine.Call.Handle property.

The Digits parameter will contain a string of the digitis gathered.

The Termination parameter is a flag which indicates how the gathering terminated see the LINEGATHERTERM_xxx constants in the etTTConst file.

The Tag parameter has no defined meaning. It is provided for the convenience of storing additional integer value or pointer information for special needs in an application. This event passes the current value of this property in its Tag parameter. The combination of etLine.Call.Tag property and the Tag parameter for this event may be used to manage the flow of your application. The IVR4Line sample program use this methodology to manage the menu of the Interactive Voice Response (IVR) system.

Availability: This event will fire only if the bit flag LINECALLFEATURE_GATHERDIGITS is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: This event fires when the LINE_GATHERDIGITS message is received.

etLine.OnDisconnected

Parameters: CallHandle: Integer
Edition: Express, Standard, Professional, Enterprise
<Click here for example>

This event fires when the telephony device identifies that the other party has hung up. In the US this is done by detecting the Loop Current Drop, not all modem can detect this. Most sophisticated telephony devices can detect Loop Current Drop. See the "Products | Telephony Hardware" section of our web site at http://www.exceletel.com for more information.

In most cases, call the etLine.Call.Hangup method within the event handler routine for this event.

When using etPlay and/or etRecord along with etLine, remember to stop playing and recording .wav files before hanging up a call or when the etLine.OnDisconnected event is fired. An example of this is found in the CommandHangup_Click and etLine1_OnDisconnected subroutines of the DialAnswer sample program.

The OnCallState event fires immediately before this event. The Call.DisconnectMode is updated when this event fires.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_DISCONNECTED is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This event fires when the LINE_CALLSTATE message is received with the parameter LINECALLSTATE_DISCONNECTED.

etLine.OnError

This event is common to all controls, so see OnError.

etLine.OnHold

Parameters: CallHandle: Integer
Edition: Standard, Professional, Enterprise
The call is on hold by the switch.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_ONHOLD is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This event fires when the LINE_CALLSTATE message is received with the parameter LINECALLSTATE_ONHOLD.

etLine.OnHoldPendingConference

Parameters: CallHandle: Integer
Edition: Enterprise
The call is currently on hold while it is being added to a conference.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_ONHOLDPENDCONF is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This event fires when the LINE_CALLSTATE message is received with the parameter LINECALLSTATE_ONHOLDPENDCONF.

etLine.OnHoldPendingTransfer

Parameters: CallHandle: Integer
Edition: Professional, Enterprise
The call is currently on hold awaiting transfer to another number.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_ONHOLDPENDTRANSF is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This event fires when the LINE_CALLSTATE message is received with the parameter LINECALLSTATE_ONHOLDPENTRANSFER.

etLine.OnIdle

Parameters: CallHandle: Integer
Edition: Express, Standard, Professional, Enterprise
<Click here for example>

The event is fired when TAPI indicates that the call is in an idle state and a no longer exists. The call will be removed from the etLine.Call.List property.

This should not be confused with the device being in an idle states. Unfortunately TAPI does not give a way to identify when a device is idle and ready for the next call. Some telephony devices such as voice modems require sometime to reset. For this reason the etLine.Device.IdleDelay property was introduced. This property will cause the etLine.OnIdle event to delay the given number of milliseconds before it fires.

Just prior to this event firing the etLine.OnCallEnd event will fire.

The following properties are still available to your application with in your etLine.OnIdle event handler routine. These values are cleared when your event handler routine is finished executing:

      Call.Handle
      Call.OriginatingApp
      Call.Owners
      Call.Monitors
      Call.State
      Call.StateMode
      Call.BearerMode
 

The OnCallState event fires immediately before this event.

This event is commonly used to trigger the dialing of a new call. If your application uses this event for this reason make sure that you experiment with the Device.IdleDelay property.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_IDLE is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This event fires when the LINE_CALLSTATE message is received with the parameter LINECALLSTATE_IDLE.

etLine.OnLineState

Parameters: State: Integer
                             Param2: Integer
                             Param3: Integer
Edition: Enterprise
This event fires when the state of a line device has changed.

See the property etLine.Device.Capabilities.States for a list of the available Line Device States.

In TAPI terms: This event is fired when the message LINE_LINEDEVSTATE is received.

etLine.OnMessageOff

Parameters: none
Edition: Professional, Enterprise
The “message waiting” indicator is turned off.

Availability: This event will fire only if the bit flag LINEDEVSTATE_MSGWAITOFF is set in the property etLine.Device.Capabilities.States.

In TAPI terms: This event is fired when the message LINE_LINEDEVSTATE is received with the parameter LINEDEVSTATE_MSGWAITON.

etLine.OnMessageOn

Parameters: none
Edition: Professional, Enterprise
The “message waiting” indicator is turned on.

Availability: This event will fire only if the bit flag LINEDEVSTATE_MSGWAITON is set in the property etLine.Device.Capabilities.States.

In TAPI terms: This event is fired when the message LINE_LINEDEVSTATE is received with the parameter LINEDEVSTATE_MSGWAITOFF.

etLine.OnOffering

Parameters: CallHandle: Integer
Edition: Express, Standard, Professional, Enterprise
<Click here for example>

This event is fired when the telephony device indicates that an incoming call is detected. In many cases, the next event to fire is the etLine.OnRing event.

The OnCallState event fires immediately before this event.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_OFFERING is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This event will fire when the LINE_CALLSTATE message is received with the parameter LINECALLSTATE_OFFERING.

etLine.OnProceeding

Parameters: CallHandle: Integer
Edition: Standard, Professional, Enterprise
<Click here for example>

Dialing has completed and the call is proceeding through the switch or telephone network.

The OnCallState event fires immediately before this event.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_PROCEEDING is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This event fires each time that the LINE_CALLSTATE message is received with the parameter LINECALLSTATE_PROCEEDING.

etLine.OnRedirectingID

Parameters: CallHandle: Integer
Edition: Professional, Enterprise
<Click here for example>

This event is fired when TAPI indicates that the Redirecting ID information has become available or has changed. The etLine.Call.RedirectingID properties are updated to reflect the available information. The etLine.OnCallInfo event is fired just before this event.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLINFOSTATE_REDIRECTINGID is set in the property etLine.Address.Capabilities.CallInfoStates.

In TAPI terms: This event is fired when the message LINE_CALLINFO is received with the parameter LINECALLINFOSTATE_REDIRECTINGID.

etLine.OnRedirectionID

Parameters: CallHandle: Integer
Edition: Professional, Enterprise
<Click here for example>

This event is fired when TAPI indicates that the Redirection ID information has become available or has changed. The etLine.Call.RedirectionID properties are updated to reflect the available information. The etLine.OnCallInfo event is fired just before this event.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLINFOSTATE_REDIRECTIONID is set in the property etLine.Address.Capabilities.CallInfoStates.

In TAPI terms: This event is fired when the message LINE_CALLINFO is received with the parameter LINECALLINFOSTATE_REDIRECTIONID.

etLine.OnRing

Parameters: Count: Integer
                    RingMode: Integer
Edition: Express, Standard, Professional, Enterprise
<Click here for example>

This event fires when the telephony device indicates that it has detected an incoming ring.

The Count parameter indicates the number of rings. Some devices start with 0 others with 1. Some devices allow you to ignore the first ring.

The RingMode parameter indicates the ring mode of the current ring as defined by the manufacturer. The number and type of ring modes is provided in Most devices have only one ring mode. An example of two different ring modes

Availability: This event will fire only if the bit flag LINEDEVSTATE_RINGING is set in the property etLine.Device.Capabilities.States.

In TAPI terms: This event is fired when the message LINE_LINEDEVSTATE is received with the parameter LINEDEVSTATE_RINGING.

etLine.OnRingBack

Parameters: CallHandle: Integer
Edition: Express, Standard, Professional, Enterprise
<Click here for example>

This event fires when the telephony device detects a ringback. This is normally detected with outbound call.

The OnCallState event fires immediately before this event.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_RINGBACK is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This event is fired when the message LINE_CALLSTATE is received with the parameter LINECALLSTATE_RINGBACK.

etLine.OnSilence

Parameters: CallHandle: Integer
Edition: Professional, Enterprise
<Click here for example>

This event is fired when the telephony device indicates that it has detected silence. The etLine.Call.MonitorSilence.Active property must first be set to true and the etLine.Call.MonitorSilence.Duration must be set to a value greater than 0 milliseconds. A call must also be in the connected state, meaning the etLine.OnConnected event must have been fired.

Some telephony device must reset the etLine.Call.MonitorSilence.Active property to true after each time this event fires.

See the etLine.Call.MonitorSilence properties for more information.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLFEATURE_MONITORTONES is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: The function lineMonitorTones is called using 0 for all frequencies. This event is fired when the LINE_MONITORTONE message is received.

etLine.OnSpecialInfo

Parameters: CallHandle: Integer
Edition: Professional, Enterprise
Special information is sent by the network. Special information is typically sent when the destination cannot be reached. See the etLine.Call.SpecialInfo property.

The OnCallState event fires immediately before this event.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLSTATE_SPECIALINFO is set in the property etLine.Address.Capabilities.CallStates.

In TAPI terms: This event is fired when the LINE_CALLSTATE message is received with the parameter LINECALLSTATE_SPECIALINFO.

etLine.OnTAPIMessage

Parameters: CallHandle: Integer
                    Message: Integer
                    Param1: Integer
                    Param2: Integer
                    Param3: Integer
Edition: Enterprise
This event allow all TAPI messages returned to be captured. This is useful for programmers that need to use TAPI functions that are not directly supported by TeleTools.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Note: This event will not be displayed in the TeleScope log unless the etLine.Popup.OnTAPIMessage property is set to true. The value of the property etLine.Popup.OnTAPIMessage does not affect the firing of this property.

etLine.OnTAPIReply

Parameters: Param1: Integer
                    Param2: Integer
                    Param3: Integer
Edition: Enterprise
This allows all TAPI reply messages to be captured, these are the LINE_REPLY messages. This is useful when working directly with TAPI function that work in an asynchronous manner.

etLine.OnToneSent

Parameters: CallHandle: Integer
Edition: Standard, Professional, Enterprise
This event fires to notify the application that the current etLine.Call.SendTone operation has finished. The event also fires when tone generation is canceled.

The CallHandle parameter contains the call handle for the call in which the event fired. Also see the etLine.Call.Handle property.

Availability: This event will fire only if the bit flag LINECALLFEATURE_GENERATETONE is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: This event fires each time that the LINE_GENERATE message is received.


etLine Errors etLine Methods