IClientHandsetAddIn Interface Reference

import "CLMgrPub.idl";

Inheritance diagram for IClientHandsetAddIn:

Public Member Functions
HRESULT	CountInstalled ([out] int *piCountInstalled)
HRESULT	GetDeviceCapabilities ([in] int iDeviceIndex, [out] PubCLMgrDeviceCapabilities *pDeviceCapabilities)
HRESULT	EnableDevice ([in] int iDeviceIndex, [in] BOOL bEnable, [in] int iHookDeviceId)
HRESULT	DeviceEnabled ([in] int iDeviceIndex, [out] BOOL *pbEnabled)
HRESULT	IsOffHook ([in] int iDeviceIndex, [out] BOOL *pbOffHook)
HRESULT	Mute ([in] int iDeviceIndex, [in] BOOL bMute)
HRESULT	DeviceMuted ([in] int iDeviceIndex, [out] BOOL *pbMuted)
HRESULT	HandsfreeMode ([in] int iDeviceIndex, [in] BOOL bHandsfree)
HRESULT	DeviceInHandsfreeMode ([in] int iDeviceIndex, [out] BOOL *pbHandsfree)
HRESULT	OpenListeningMode ([in] int iDeviceIndex, [in] BOOL bOpenListening)
HRESULT	DeviceInOpenListeningMode ([in] int iDeviceIndex, [out] BOOL *pbOpenListening)
HRESULT	Ringing ([in] int iDeviceIndex, [in] BOOL bRinging)
HRESULT	DeviceRinging ([in] int iDeviceIndex, [out] BOOL *pbRinging)
HRESULT	SkinActionAreaStateChanged ([in] DWORD dwCommandId, [in] DWORD dwButtonId, [in] DWORD dwActionAreaState)
HRESULT	SkinInfoDetailChanged ([in] DWORD dwDetailIndex, [in] BSTR InfoDetail)

Detailed Description

Line Manager PlugIn interface; used by Client Line Manager for retrieving information about a handset

This interface has to be implemented by a SwyxIt! handset driver:

Member Function Documentation

CountInstalled()

HRESULT IClientHandsetAddIn::CountInstalled

(

[out] int *

piCountInstalled

)

Get Installation state from handset driver

Parameters

*piCountInstalled

returns the number of present devices

Returns

This method returns S_OK if successful

DeviceEnabled()

HRESULT IClientHandsetAddIn::DeviceEnabled	(	[in] int	iDeviceIndex,
		[out] BOOL *	pbEnabled )

Is device enabled?

Parameters

iDeviceIndex	gives the device to be used if the addin has found multiple devices (CountInstalled reported more than one device) iDeviceIndex starts with 0; if only one device has been found, set iDeviceIndex = 0
*pbEnabled	enables or disables the device

DeviceInHandsfreeMode()

HRESULT IClientHandsetAddIn::DeviceInHandsfreeMode	(	[in] int	iDeviceIndex,
		[out] BOOL *	pbHandsfree )

Is device in handsfree mode?

Parameters

iDeviceIndex	gives the device to be used if the addin has found multiple devices (CountInstalled reported more than one device) iDeviceIndex starts with 0; if only one device has been found, set iDeviceIndex = 0
*pbHandsfree	is true if the handsfree mode is enabled

DeviceInOpenListeningMode()

HRESULT IClientHandsetAddIn::DeviceInOpenListeningMode	(	[in] int	iDeviceIndex,
		[out] BOOL *	pbOpenListening )

Is device in open listening mode?

Parameters

iDeviceIndex	gives the device to be used if the addin has found multiple devices (CountInstalled reported more than one device) iDeviceIndex starts with 0; if only one device has been found, set iDeviceIndex = 0
*pbOpenListening	is true if the open listening mode mode is enabled

DeviceMuted()

HRESULT IClientHandsetAddIn::DeviceMuted	(	[in] int	iDeviceIndex,
		[out] BOOL *	pbMuted )

Is device muted?

Parameters

iDeviceIndex	gives the device to be used if the addin has found multiple devices (CountInstalled reported more than one device) iDeviceIndex starts with 0; if only one device has been found, set iDeviceIndex = 0
*pbMuted	current mute state of device

DeviceRinging()

HRESULT IClientHandsetAddIn::DeviceRinging	(	[in] int	iDeviceIndex,
		[out] BOOL *	pbRinging )

Is device ringing?

Parameters

iDeviceIndex	gives the device to be used if the addin has found multiple devices (CountInstalled reported more than one device) iDeviceIndex starts with 0; if only one device has been found, set iDeviceIndex = 0
*pbRinging	is true if the device is ringing

EnableDevice()

HRESULT IClientHandsetAddIn::EnableDevice	(	[in] int	iDeviceIndex,
		[in] BOOL	bEnable,
		[in] int	iHookDeviceId )

Enable / disable device

Parameters

iDeviceIndex	gives the device to be used if the addin has found multiple devices (CountInstalled reported more than one device) iDeviceIndex starts with 0; if only one device has been found, set iDeviceIndex = 0
bEnable	enables or disables the device
iHookDeviceId	is required for the IClientLineMgrPub4::PubExternalHookStateChanged event

Remarks

If disabled, the device should be released and not report hook state changes Will be disabled if not configured or before PC goes to power safe / suspend / hibernate mode When the plugin is loaded, the device should be initially disabled The plugin has to save iHookDeviceId and use it when calling IClientLineMgrPub4::PubExternalHookStateChanged

GetDeviceCapabilities()

HRESULT IClientHandsetAddIn::GetDeviceCapabilities	(	[in] int	iDeviceIndex,
		[out] PubCLMgrDeviceCapabilities *	pDeviceCapabilities )

Parameters

iDeviceIndex	gives the device to be used if the addin has found multiple devices (CountInstalled reported more than one device) iDeviceIndex starts with 0; if only one device has been found, set iDeviceIndex = 0
*pDeviceCapabilities	contains the list of the device capabilities

Returns

fills in PubCLMgrDeviceCapabilities with capabilities of device iDeviceIndex

HandsfreeMode()

HRESULT IClientHandsetAddIn::HandsfreeMode	(	[in] int	iDeviceIndex,
		[in] BOOL	bHandsfree )

Enable / disable handsfree mode

Parameters

iDeviceIndex	gives the device to be used if the addin has found multiple devices (CountInstalled reported more than one device) iDeviceIndex starts with 0; if only one device has been found, set iDeviceIndex = 0
bHandsfree	enables or disables the handsfree mode

Remarks

When the plugin is loaded, the handsfree mode should be initially disabled

IsOffHook()

HRESULT IClientHandsetAddIn::IsOffHook	(	[in] int	iDeviceIndex,
		[out] BOOL *	pbOffHook )

Parameters

iDeviceIndex	gives the device to be used if the addin has found multiple devices (CountInstalled reported more than one device) iDeviceIndex starts with 0; if only one device has been found, set iDeviceIndex = 0
*pbOffHook	Get hook off state from handset driver

Returns

This method returns S_OK if successful, bOff-Hook returns TRUE if the corresponding handset is off hook.

Mute()

HRESULT IClientHandsetAddIn::Mute	(	[in] int	iDeviceIndex,
		[in] BOOL	bMute )

Mute / activate device

Parameters

iDeviceIndex	gives the device to be used if the addin has found multiple devices (CountInstalled reported more than one device) iDeviceIndex starts with 0; if only one device has been found, set iDeviceIndex = 0
bMute	mute state to be set

Remarks

When the plugin is loaded, the device should be initially activated

OpenListeningMode()

HRESULT IClientHandsetAddIn::OpenListeningMode	(	[in] int	iDeviceIndex,
		[in] BOOL	bOpenListening )

Enable / disable open listening mode using additional speaker (speaker phone)

Parameters

iDeviceIndex	gives the device to be used if the addin has found multiple devices (CountInstalled reported more than one device) iDeviceIndex starts with 0; if only one device has been found, set iDeviceIndex = 0
bOpenListening	enables or disables the open listening mode

Remarks

When the plugin is loaded, the open listening mode should be initially disabled

Ringing()

HRESULT IClientHandsetAddIn::Ringing	(	[in] int	iDeviceIndex,
		[in] BOOL	bRinging )

start / stop ringing

Parameters

iDeviceIndex	gives the device to be used if the addin has found multiple devices (CountInstalled reported more than one device) iDeviceIndex starts with 0; if only one device has been found, set iDeviceIndex = 0
bRinging	lets the device ring

Remarks

When the plugin is loaded, the device should be initially not ringing :-)

SkinActionAreaStateChanged()

HRESULT IClientHandsetAddIn::SkinActionAreaStateChanged	(	[in] DWORD	dwCommandId,
		[in] DWORD	dwButtonId,
		[in] DWORD	dwActionAreaState )

Informs the handset driver about new action area state dwActionAreaState of the command dwCommandId and dwButtonId.
Some commands (line, speed dial) are indexed (line 0..line n)
The handset driver in response may switch on / off LEDs if applicable. If command is not indexed, dwButtonId is 0

Parameters

dwCommandId	contains the skin command id
dwButtonId	contains the skin button id
dwActionAreaState	contains the state of the skin action area

SkinInfoDetailChanged()

HRESULT IClientHandsetAddIn::SkinInfoDetailChanged	(	[in] DWORD	dwDetailIndex,
		[in] BSTR	InfoDetail )

Informs the handset driver about new information area detail InfoDetail of the information type dwDetailIndex.
The handset driver in response may display this information in a LCD display if applicable.

Parameters

dwDetailIndex	contains the skin area index for the InfoDetail text
InfoDetail	contains the InfoDetail text

---

The documentation for this interface was generated from the following file:

• CLMgrPub.idl