components/modemServices/platformAdaptor/interfaces/inc/pa_mcc.h File Reference

#include "legato.h"
#include "le_mdm_defs.h"

Go to the source code of this file.

Data Structures
struct	pa_mcc_CallEventData_t
Typedefs
typedef void(*	pa_mcc_CallEventHandlerFunc_t )(pa_mcc_CallEventData_t *dataPtr)
Enumerations
enum	pa_mcc_clir_t { PA_MCC_ACTIVATE_CLIR = 0, PA_MCC_DEACTIVATE_CLIR = 1 }
enum	pa_mcc_cug_t { PA_MCC_ACTIVATE_CUG = 0, PA_MCC_DEACTIVATE_CUG = 1 }
Functions
le_result_t	pa_mcc_SetCallEventHandler (pa_mcc_CallEventHandlerFunc_t handlerFuncPtr)
void	pa_mcc_ClearCallEventHandler (void)
le_result_t	pa_mcc_VoiceDial (const char *pn, pa_mcc_clir_t clir, pa_mcc_cug_t cug, uint8_t *callIdPtr)
le_result_t	pa_mcc_Answer (void)
le_result_t	pa_mcc_Hangup (void)

---

Detailed Description

Legato Modem Call Control Platform Adapter API include file.

Copyright (C) Sierra Wireless, Inc. 2013. All rights reserved. Use of this work is subject to license.

---

Typedef Documentation

typedef void(* pa_mcc_CallEventHandlerFunc_t)(pa_mcc_CallEventData_t *dataPtr)

A handler that is called whenever a call event is received by the modem.

Parameters:

pData

Data information that the handler may require.

---

Enumeration Type Documentation

enum pa_mcc_clir_t

CLIR supplementary service subscription. If present, the CLIR supplementary service subscription is overridden temporary for this call only.

Enumerator:

PA_MCC_ACTIVATE_CLIR	Disable presentation of own phone number to remote.
PA_MCC_DEACTIVATE_CLIR	Enable presentation of own phone number to remote.

enum pa_mcc_cug_t

CUG supplementary service information. If present, the CUG supplementary service information is overridden temporary for this call only.

Enumerator:

PA_MCC_ACTIVATE_CUG	Activate.
PA_MCC_DEACTIVATE_CUG	Deactivate.

---

Function Documentation

le_result_t pa_mcc_Answer

(

void

)

This function must be called to answer a call.

Returns:

LE_NOT_POSSIBLE The function failed.

LE_TIMEOUT No response was received.

LE_OK The function succeeded.

void pa_mcc_ClearCallEventHandler

(

void

)

This function must be called to unregister the handler for incoming calls handling.

le_result_t pa_mcc_Hangup

(

void

)

This function must be called to disconnect the remote user.

Returns:

LE_NOT_POSSIBLE The function failed.

LE_TIMEOUT No response was received.

LE_OK The function succeeded.

le_result_t pa_mcc_SetCallEventHandler

(

pa_mcc_CallEventHandlerFunc_t

handlerFuncPtr

)

This function must be called to register a handler for Call event notifications.

Returns:

LE_NOT_POSSIBLE The function failed to register the handler.

LE_OK The function succeeded.

Parameters:

[in]

handlerFuncPtr

The event handler function.

le_result_t pa_mcc_VoiceDial	(	const char *	pn,
		pa_mcc_clir_t	clir,
		pa_mcc_cug_t	cug,
		uint8_t *	callIdPtr
	)

This function must be called to set a voice call.

Returns:

LE_NOT_POSSIBLE The function failed.

LE_OK The function succeeded.

Parameters:

[in]	pn	The phone number.
[in]	clir	The CLIR supplementary service subscription.
[in]	cug	The CUG supplementary service information.
[out]	callIdPtr	The outgoing call ID.