3.1.7.29 TSPI_phoneSetVolume

Syntax

LONG TSPI_phoneSetVolume(dwRequestID, hdPhone, dwHookSwitchDev, dwVolume)
This function either sets the volume of the speaker component of the specified hookswitch device to the specified level.

Parameters

DRV_REQUESTID dwRequestID
Specifies the identifier of the asynchronous request. The Service Provider returns this value if the function completes asynchronously.

HDRVPHONE hdPhone
Specifies the Service Provider's opaque handle to the phone containing the speaker whose volume is to be set.

DWORD dwHookSwitchDev
Identifies the hook switch device whose speaker's volume is to be set.

PHONEHOOKSWITCH_HANDSET
This is the phone's handset.

PHONEHOOKSWITCH_SPEAKER
This is the phone's speakerphone or adjunct.

PHONEHOOKSWITCH_HEADSET
This is the phone's headset.

DWORD dwVolume
A DWORD specifying the new volume level of the hookswitch device. This is a number in the range 0x00000000, which is silence to 0x0000FFFF which is maximum volume. The actual granularity and quantization of volume settings in this range are service provider specific.

Return Value

Returns zero if the function is successful, the (positive) dwRequestID value if the function will be completed asynchronously, or a negative error number if an error has occurred. Possible error returns are:

PHONEERR_INVALPHONEHANDLE
The specified device handle is invalid.

PHONEERR_INVALPHONESTATE
The phone device is not in a valid state for the requested operation.

PHONEERR_INVALHOOKSWITCHDEV
The hookswitch dev parameter is invalid.

PHONEERR_OPERATIONUNAVAIL
The specified operation is not available.

PHONEERR_OPERATIONFAILED
The specified operation failed for unspecified reason.

Comments

None.

See Also

Functions: TSPI_phoneGetDevCaps, TSPI_phoneSetVolume
Data Types: PHONECAPS