phoneSetGain
The phoneSetGain
function sets the gain of the microphone of the specified hookswitch device to
the specified gain level.
LONG phoneSetGain(
|
HPHONE hPhone, |
|
|
DWORD dwHookSwitchDev, |
|
|
DWORD dwGain |
|
|
); |
|
Parameters
hPhone
A handle to
the open phone device. The application must be the owner of the phone.
dwHookSwitchDev
The
hookswitch device whose microphone's gain is to be set. The dwHookswitchDev
parameter can only have a single bit set. This parameter uses the following
PHONEHOOKSWITCHDEV_ constants:
PHONEHOOKSWITCHDEV_HANDSET
The phone's
handset.
PHONEHOOKSWITCHDEV_SPEAKER
The phone's
speakerphone or adjunct.
PHONEHOOKSWITCHDEV_HEADSET
The phone's
headset.
dwGain
A pointer to
a DWORD-sized location containing the current gain setting of the device. The dwGain
parameter specifies the gain level of the hookswitch device. This is a number
in the range 0x00000000 (silence) to 0x0000FFFF (maximum volume). The actual
granularity and quantization of gain settings in this range are
service-provider specific. A value for dwGain that is out of range is
set to the nearest value in the range.
Return Values
Returns a
positive request ID if the function will be completed asynchronously or a
negative error number if an error has occurred. The dwParam2 parameter
of the corresponding PHONE_REPLY message is zero if the function is successful
or it is a negative error number if an error has occurred. Possible return
values are:
PHONEERR_INVALPHONEHANDLE,
PHONEERR_NOMEM, PHONEERR_NOTOWNER, PHONEERR_RESOURCEUNAVAIL,
PHONEERR_INVALPHONESTATE, PHONEERR_OPERATIONFAILED,
PHONEERR_INVALHOOKSWITCHDEV, PHONEERR_UNINITIALIZED, PHONEERR_OPERATIONUNAVAIL.
See Also