Snapdragon® Telematics Application Framework (TelAF) Interface Specification
Typedefs | Functions
taf_voicecall_interface.h File Reference
#include "legato.h"
#include "taf_types_interface.h"
#include "taf_voicecall_common.h"

Go to the source code of this file.

Typedefs

typedef void(* taf_voicecall_DisconnectHandler_t) (void *)
 

Functions

void taf_voicecall_ConnectService (void)
 
le_result_t taf_voicecall_TryConnectService (void)
 
LE_FULL_API void taf_voicecall_SetServerDisconnectHandler (taf_voicecall_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
LE_FULL_API void taf_voicecall_SetNonExitServerDisconnectHandler (taf_voicecall_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
void taf_voicecall_DisconnectService (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)
 

Typedef Documentation

◆ taf_voicecall_DisconnectHandler_t

typedef void(* taf_voicecall_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

◆ taf_voicecall_ConnectService()

void taf_voicecall_ConnectService ( void  )

Connect the current client thread to the service providing this API. Block until the service is available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

◆ taf_voicecall_TryConnectService()

le_result_t taf_voicecall_TryConnectService ( void  )

Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

Returns
  • LE_OK if the client connected successfully to the service.
  • LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
  • LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
  • LE_COMM_ERROR if the Service Directory cannot be reached.

◆ taf_voicecall_SetServerDisconnectHandler()

LE_FULL_API void taf_voicecall_SetServerDisconnectHandler ( taf_voicecall_DisconnectHandler_t  disconnectHandler,
void *  contextPtr 
)

Set handler called when server disconnection is detected.

When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.

◆ taf_voicecall_SetNonExitServerDisconnectHandler()

LE_FULL_API void taf_voicecall_SetNonExitServerDisconnectHandler ( taf_voicecall_DisconnectHandler_t  disconnectHandler,
void *  contextPtr 
)

Set handler called when server disconnection is detected without exiting.

When a server connection is lost, call this handler without exit.

Warning
When using the API, it needs the application developer to handle some cases like re-connecting and recycling the resources. For most of cases, it is safe to use SetServerDisconnectHandler.

◆ taf_voicecall_DisconnectService()

void taf_voicecall_DisconnectService ( void  )

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see apiFilesC_client.

This function is created automatically.

◆ taf_voicecall_AddStateHandler()

taf_voicecall_StateHandlerRef_t taf_voicecall_AddStateHandler ( taf_voicecall_StateHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

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.