etPhone Events


OnDevSpecific
OnDigitDown
OnDigitUp
OnError
OnHandsetGain
OnHandsetHookSwitch
OnHandsetVolume
OnHeadsetGain
OnHeadsetHookSwitch
OnHeadsetVolume
OnPhoneState
OnSpeakerphoneGain
OnSpeakerphoneHookSwitch
OnSpeakerphoneVolume
OnTAPIMessage
OnTAPIReply
 


etPhone.OnDevSpecific

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

This event fires to notify the application about device-specific events occurring at the phone device. The meaning of the message and the interpretation of the parameters are device specific.

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

etPhone.OnDigitDown

Parameters: Digit: Char
Edition:
Professional, Enterprise
<Click here for example>

The etPhone.OnDigitDown event fires when the button on the handset is pressed down. The etPhone.OnDigitUp fires when the button is released. These events are not supported by voice modems that use the UnimodemV TSP. Some devices support etPhone.OnDigitDown but not etPhone.OnDigitUp.

The Digit parameter indicates the button that is pressed. Valid values are “0” – “9”, “*", and “#”.

etPhone.OnDigitUp

Parameters: Digit: Char
Edition:
Professional, Enterprise
<Click here for example>

The etPhone.OnDigitDown event fires when the button on the handset is pressed down. The etPhone.OnDigitUp fires when the button is released. These events are not supported by voice modems that use the UnimodemV TSP. Some devices support etPhone.OnDigitDown but not etPhone.OnDigitUp.

The Digit parameter indicates the button that is pressed. Valid values are “0” – “9”, “*", and “#”.

etPhone.OnError

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

OnError - See Common Events

etPhone.OnHandsetGain

Parameters: none
Edition:
Professional, Enterprise
This event fires when the Handset hookswitch device microphone gain has been changed. The Handset.Gain property value will have changed. This event will fire only if the property values Handset.Available and Handset.VolumeAvailable are true.

Voice modems that use the UnimodemV TSP do not support this event.

etPhone.OnHandsetHookSwitch

Parameters: none
Edition:
Professional, Enterprise
This event fires when the state of the Handset changes. The following property values will have changed:

etPhone.Handset.MicrophoneAndSpeaker
etPhone.Handset.MicrophoneOnly
etPhone.Handset.OnHook
etPhone.Handset.SpeakerOnly

Voice modems that use the UnimodemV TSP have the following limitations:

They do not support the property etPhone.Handset.MicrophoneOnly or etPhone.Handset.SpeakerOnly.

They do not detect handset hookswitch changes until a call exists, the etLine.Call.Active property must be True.

This event will fire only if the property Handset.Available is true.

etPhone.OnHandsetVolume

Parameters: none
Edition:
Professional, Enterprise
This event fires when the Handset hookswitch device volume has been changed. The Handset.Volume property value will have changed. This event will fire only if the property values Handset.Available and Handset.VolumeAvailable are true.

Voice modems that use the UnimodemV TSP do not support this event.

etPhone.OnHeadsetHookSwitch

Parameters: none
Edition:
Professional, Enterprise
This event fires when the state of the Headset changes. The following property values will have changed:

etPhone.Headset.MicrophoneAndSpeaker
etPhone.Headset.MicrophoneOnly
etPhone.Headset.OnHook
etPhone.Headset.SpeakerOnly

Voice modems that use the UnimodemV TSP do not support this event or any of the above properties.

This event will fire only if the property Headset.Available is true.

etPhone.OnHeadsetGain

Parameters: none
Edition:
Professional, Enterprise
This event fires when the Headset hookswitch device microphone gain has been changed. The Headset.Gain property value will have changed. This event will fire only if the property values Headset.Available and Headset.VolumeAvailable are true.

Voice modems that use the UnimodemV TSP do not support this event.

etPhone.OnHeadsetVolume

Parameters: none
Edition:
Professional, Enterprise
This event fires when the Headset hookswitch device volume has been changed. The Headset.Volume property value will have changed. This event will fire only if the property values Headset.Available and Headset.VolumeAvailable are true.

Voice modems that use the UnimodemV TSP do not support this event.

etPhone.OnPhoneState

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

This event fires when the state of the device changes. The property values etPhone.Device.State and etPhone.Device.StateDetails will have changed.

etPhone.OnSpeakerphoneGain

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

This event fires when the Speakerphone hookswitch device microphone gain has been changed. The Speakerphone.Gain property value will have changed. This event will fire only if the property values Speakerphone.Available and Speakerphone.VolumeAvailable are true.

etPhone.OnSpeakerphoneHookSwitch

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

This event fires when the state of the Speakerphone changes. The following property values will have changed:

etPhone.Speakerphone.MicrophoneAndSpeaker
etPhone.Speakerphone.MicrophoneOnly
etPhone.Speakerphone.OnHook
etPhone.Speakerphone.SpeakerOnly

Voice modems that use the UnimodemV TSP do not support the property etPhone. Speakerphone.MicrophoneOnly or etPhone. Speakerphone.SpeakerOnly.

This event will fire only if the property Speakerphone.Available is true.

etPhone.OnSpeakerphoneVolume

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

This event fires when the Speakerphone hookswitch device volume has been changed. The Speakerphone.Volume property value will have changed. This event will fire only if the property values Speakerphone.Available and Speakerphone.VolumeAvailable are true.

etPhone.OnTAPIMessage

Parameters: CallHandle: Integer
                    Message: Integer
                    Param1: Integer
                    Param2: Integer
                    Param3: Integer
Edition:
Enterprise
See the etLine event of the same name for details.

etPhone.OnTAPIReply

Parameters: Param1: Integer
                    Param2: Integer
                    Param3: Integer
Edition:
Enterprise
See the etLine event of the same name for details.



etPhone Errors etPhone Methods