etPhone.Handset, etPhone.Headset & etPhone.Speakerphone Properties


etPhone.Handset

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.

Handset.Available
Handset.Gain
Handset.GainAvailable
Handset.MicrophoneOnly
Handset.Modes
Handset.OnHook
Handset.SpeakerOnly
Handset.Volume
Handset.VolumeAvailable

etPhone.Headset

Voice modems that use the UnimodemV TSP do not support etPhone.Headset properties.

The same subproperties that are available for the Handset are also available for the Headset and Speakerphone.

In many cases the Speakerphone properties can be used to support a headset. for example with a voice modem you can use a headset with dual plugs connecting one to the speaker jack and the other to the microphone jack.

Headset.Available
Headset.Gain
Headset.GainAvailable
Headset.MicrophoneOnly
Headset.Modes
Headset.OnHook
Headset.SpeakerOnly
Headset.Volume
Headset.VolumeAvailable

etPhone.Speakerphone

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

The same subproperties that are available for the Handset are also available for the Headset and Speakerphone.

Speakerphone.Available
Speakerphone.Gain
Speakerphone.GainAvailable
Speakerphone.MicrophoneOnly
Speakerphone.Modes
Speakerphone.OnHook
Speakerphone.SpeakerOnly
Speakerphone.Volume
Speakerphone.VolumeAvailable
 


etPhone.Handset.Available
etPhone.Headset.Available
etPhone.Speakerphone.Available

ActiveX: etPhone.HandsetAvailable
              etPhone.HeadsetAvailable
              etPhone.SpeakerphoneAvailable
Type:
Boolean
When:
Run-Time
Read/Write:
Read Only
Edition:
Standard, Professional, Enterprise
<Click here for example>

This property indicates whether the handset hookswitch is available to the TAPI Phone device. The value of these properties directly correspond with the property Phone.HookSwitchDevs.

etPhone.Handset.Gain
etPhone.Headset.Gain
etPhone.Speakerphone.Gain

ActiveX: etPhone.HandsetGain
              etPhone.HeadsetGain
              etPhone.SpeakerphoneGain
Type:
Integer
When:
Design-Time and Run-Time
Read/Write:
Read and Write
Edition:
Standard, Professional, Enterprise
<Click here for example>

This sets and/or inspects the value of the microphone gain. The valid values are 0 to 100.

Also see the events OnHandsetGain, OnHeadsetGain and OnSpeakerphoneGain.

etPhone.Handset.GainAvailable
etPhone.Headset.GainAvailable
etPhone.Speakerphone.GainAvailable

ActiveX: etPhone.HandsetGainAvailable
              etPhone.HeadsetGainAvailable
              etPhone.SpeakerphoneGainAvailable
Type:
Boolean
When:
Run-Time
Read/Write:
Read Only
Edition:
Standard, Professional, Enterprise
<Click here for example>

This property indicates whether the etPhone.<>.Gain property is available for the given TAPI Phone device.

etPhone.Handset.MicrophoneAndSpeaker
etPhone.Headset.MicrophoneAndSpeaker
etPhone.Speakerphone.MicrophoneAndSpeaker

ActiveX: etPhone.HandsetMicrophoneAndSpeaker
              etPhone.HeadsetMicrophoneAndSpeaker
              etPhone.SpeakerphoneMicrophoneAndSpeaker
Type:
Boolean
When:
Run-Time
Read/Write:
Read and Write
Edition:
Standard, Professional, Enterprise
<Click here for example>

This property sets and/or inspects the state of the microphone and speaker for the hookswitch.

Setting this property to true will cause the microphone and speaker to be active. This is used when the first party must hear the second party and the second party also must hear the first party.

If this property is set to true, the following properties are set to false: <>.MicrophoneOnly, <>.OnHook, and <>.SpeakerOnly.

Also see the event OnHandsetHookSwitch, OnHeadsetHookSwitch and OnSpeakerphoneHookSwitch.

etPhone.Handset.MicrophoneOnly
etPhone.Headset.MicrophoneOnly
etPhone.Speakerphone.MicrophoneOnly

ActiveX: etPhone.HandsetMicrophoneOnly
              
etPhone.HeadsetMicrophoneOnly
              etPhone.SpeakerphoneMicrophoneOnly
Type:
Boolean
When:
Run-Time
Read/Write:
Read and Write
Edition:
Standard, Professional, Enterprise
<Click here for example>

This property sets and/or inspects the state of the microphone and speaker for the hookswitch.

Setting this property to true will cause the microphone to be active and the speaker to be inactive. This is used when the first party does not need to hear the second party and the second party must hear the first party.

If this property is set to true, the following properties are set to false: <>.MicrophoneAndSpeaker, <>.OnHook and <>.SpeakerOnly.

Also see the event OnHandsetHookSwitch, OnHeadsetHookSwitch and OnSpeakerphoneHookSwitch.

etPhone.Handset.Modes
etPhone.Headset.Modes
etPhone.Speakerphone.Modes

ActiveX: etPhone.HandsetModes
              etPhone.HeadsetModes
              etPhone.SpeakerphoneModes
Type:
Boolean
When:
Run-Time
Read/Write:
Read and Write
Edition:
Standard, Professional, Enterprise
This is a set of bit flags that indicate the available modes for the hook switch device defined in the Device.ID property.

PHONEHOOKSWITCHMODE_ONHOOK

The device's microphone and speaker are both onhook.

PHONEHOOKSWITCHMODE_MIC

The device's microphone is active, the speaker is mute.

PHONEHOOKSWITCHMODE_SPEAKER

The device's speaker is active, the microphone is mute.

PHONEHOOKSWITCHMODE_MICSPEAKER

The device's microphone and speaker are both active.

 

etPhone.Handset.OnHook
etPhone.Headset.OnHook
etPhone.Speakerphone.OnHook

ActiveX: etPhone.HandsetOnHook
              etPhone.HeadsetOnHook
              etPhone.SpeakerphoneOnHook
Type:
Boolean
When:
Run-Time
Read/Write:
Read and Write
Edition:
Standard, Professional, Enterprise
<Click here for example>

This property sets and/or inspects the state of the microphone and speaker for the hookswitch.

Setting this property to true will cause the microphone and speaker to be inactive. This is used when the first party and the second party do not need to hear each other.

If this property is set to true, the following properties are set to false: <>.MicrophoneAndSpeaker, <>.SpeakerOnly and <>.MicrophoneOnly.

Also see the event OnHandsetHookSwitch, OnHeadsetHookSwitch and OnSpeakerphoneHookSwitch.

etPhone.Handset.SpeakerOnly
etPhone.Headset.SpeakerOnly
etPhone.Speakerphone.SpeakerOnly

ActiveX: etPhone.HandsetSpeakerOnly
              
etPhone.HeadsetSpeakerOnly
              etPhone.SpeakerphoneSpeakerOnly
Type:
Boolean
When:
Run-Time
Read/Write:
Read and Write
Edition:
Standard, Professional, Enterprise
<Click here for example>

This property sets and/or inspects the state of the microphone and speaker for the hookswitch.

Setting this property to true will cause the microphone to be inactive and the speaker to be active. This is used when the first party must hear the second party and the second party does not need to hear the first party.

If this property is set to true, the following properties are set to false: <>.MicrophoneAndSpeaker, <>.OnHook and <>.MicrophoneOnly.

Also see the event OnHandsetHookSwitch, OnHeadsetHookSwitch and OnSpeakerphoneHookSwitch.

etPhone.Handset.Volume
etPhone.Headset.Volume
etPhone.Speakerphone.Volume

ActiveX: etPhone.HandsetVolume
              
etPhone.HeadsetVolume
              etPhone.SpeakerphoneVolume
Type:
Integer
When:
Design-Time and Run-Time
Read/Write:
Read and Write
Edition:
Standard, Professional, Enterprise
<Click here for example>

This sets and/or inspects the value of the speaker volume. The valid values are 0 to 100.

Also see the events OnHandsetVolume, OnHeadsetVolume and OnSpeakerphoneVolume.

etPhone.Handset.VolumeAvailable
etPhone.Headset.VolumeAvailable
etPhone.Speakerphone.VolumeAvailable

ActiveX: etPhone.HandsetVolumeAvailable
              
etPhone.HeadsetVolumeAvailable
              etPhone.SpeakerphoneVolumeAvailable
Type:
Boolean
When:
Run-Time
Read/Write:
Read Only
Edition:
Standard, Professional, Enterprise
<Click here for example>

This property indicates whether the etPhone.<>.Volume property is available for the given TAPI Phone device.



etPhone Properties - Device etPhone Properties - Line