Snapdragon® Telematics Application Framework (TelAF) Interface Specification
Functions
taf_voicecall_server.h File Reference
#include "legato.h"
#include "taf_types_server.h"
#include "taf_voicecall_common.h"

Go to the source code of this file.

Functions

le_msg_ServiceRef_t taf_voicecall_GetServiceRef (void)
 
le_msg_SessionRef_t taf_voicecall_GetClientSessionRef (void)
 
void taf_voicecall_AdvertiseService (void)
 
taf_voicecall_StateHandlerRef_t taf_voicecall_AddStateHandler (taf_voicecall_StateHandlerFunc_t handlerPtr, void *contextPtr)
 
void taf_voicecall_RemoveStateHandler (taf_voicecall_StateHandlerRef_t handlerRef)
 
taf_voicecall_CallRef_t taf_voicecall_Start (const char *LE_NONNULL destinationID, uint8_t phoneId)
 
le_result_t taf_voicecall_End (taf_voicecall_CallRef_t reference)
 
le_result_t taf_voicecall_Delete (taf_voicecall_CallRef_t reference)
 
le_result_t taf_voicecall_Answer (taf_voicecall_CallRef_t reference)
 
le_result_t taf_voicecall_GetEndCause (taf_voicecall_CallRef_t reference, taf_voicecall_CallEndCause_t *causePtr)
 
le_result_t taf_voicecall_Hold (taf_voicecall_CallRef_t reference)
 
le_result_t taf_voicecall_Resume (taf_voicecall_CallRef_t reference)
 
le_result_t taf_voicecall_Swap (taf_voicecall_CallRef_t reference)
 

Function Documentation

◆ taf_voicecall_GetServiceRef()

le_msg_ServiceRef_t taf_voicecall_GetServiceRef ( void  )

Get the server service reference

◆ taf_voicecall_GetClientSessionRef()

le_msg_SessionRef_t taf_voicecall_GetClientSessionRef ( void  )

Get the client session reference for the current message

◆ taf_voicecall_AdvertiseService()

void taf_voicecall_AdvertiseService ( void  )

Initialize the server and advertise the service.

◆ taf_voicecall_AddStateHandler()

taf_voicecall_StateHandlerRef_t taf_voicecall_AddStateHandler ( taf_voicecall_StateHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Uses the call reference returned from start defined in le_voicecall.api Call events. Call end causes. Reference type used by Add/Remove functions for EVENT 'taf_voicecall_State' Add handler function for EVENT 'taf_voicecall_State'

Add handler function for EVENT 'taf_voicecall_State'

Parameters
[in]handlerPtr
[in]contextPtr

◆ taf_voicecall_RemoveStateHandler()

void taf_voicecall_RemoveStateHandler ( taf_voicecall_StateHandlerRef_t  handlerRef)

Remove handler function for EVENT 'taf_voicecall_State'

Parameters
[in]handlerRef

◆ taf_voicecall_Start()

taf_voicecall_CallRef_t taf_voicecall_Start ( const char *LE_NONNULL  destinationID,
uint8_t  phoneId 
)

Starts a call according to a given phone number and slot ID.

Returns
  • Reference to the voice call.
  • NULL if the voice call can not be processed.
Parameters
[in]destinationIDDestination phone number for
[in]phoneIdSIM slot ID.

◆ taf_voicecall_End()

le_result_t taf_voicecall_End ( taf_voicecall_CallRef_t  reference)

Stops a call according to the given reference ID.

Returns
  • LE_OK – Succeeded.
  • Others – Failed.
Parameters
[in]referenceThe call reference.

◆ taf_voicecall_Delete()

le_result_t taf_voicecall_Delete ( taf_voicecall_CallRef_t  reference)

Deletes a call according to the given call reference.

Returns
  • LE_OK – Succeeded.
  • Others – Failed.
Parameters
[in]referenceThe call reference.

◆ taf_voicecall_Answer()

le_result_t taf_voicecall_Answer ( taf_voicecall_CallRef_t  reference)

Answers an incoming or a waiting call. The call reference can be retrieved from the call state handler.If a Waiting call is being answered and the existing call is Active, then the existing call will move to Hold state. If the existing call is on Hold already, then it will remain on Hold. The waiting call state transitions from Waiting to Active. If a Waiting call is being answered and the existing call is Active, then the existing call will move to Hold state. If the existing call is on Hold already, then it will remain on Hold. The waiting call state transitions from Waiting to Active.

Returns
  • LE_OK – Succeeded.
  • Others – Failed.
Parameters
[in]referenceThe call reference.

◆ taf_voicecall_GetEndCause()

le_result_t taf_voicecall_GetEndCause ( taf_voicecall_CallRef_t  reference,
taf_voicecall_CallEndCause_t *  causePtr 
)

Gets the call end reason according to the call reference. This call should be in the END state. The call should be in the idle state when calling this API.

Returns
  • LE_OK – Succeeded.
  • Others – Failed.
Parameters
[in]referenceThe call reference.
[out]causePtrThe end cause enumeration.

◆ taf_voicecall_Hold()

le_result_t taf_voicecall_Hold ( taf_voicecall_CallRef_t  reference)

Holds the active call. This call should be in the ACTIVE state.

Returns
  • LE_OK – Succeeded.
  • Others – Failed.
Parameters
[in]referenceThe call reference.

◆ taf_voicecall_Resume()

le_result_t taf_voicecall_Resume ( taf_voicecall_CallRef_t  reference)

Resumes the holding call. This call should be in the HOLD state.

Returns
  • LE_OK – Succeeded.
  • Others – Failed.
Parameters
[in]referenceThe call reference.

◆ taf_voicecall_Swap()

le_result_t taf_voicecall_Swap ( taf_voicecall_CallRef_t  reference)

Swaps calls to make one active and put the another on hold. This should be two calls, where one is in the holding state and the another is in the active state.

Returns
  • LE_OK – Succeeded.
  • Others – Failed.
Parameters
[in]referenceThe call reference.