le_mcc.h

Go to the documentation of this file.

#ifndef LEGATO_MCC_H_INCLUDE_GUARD
#define LEGATO_MCC_H_INCLUDE_GUARD


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

//--------------------------------------------------------------------------------------------------
// Symbol and Enum definitions.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MCC_PROFILE_NOT_AVAILABLE,  
    LE_MCC_PROFILE_IDLE,           
    LE_MCC_PROFILE_FORWARDED,      
    LE_MCC_PROFILE_DND,            
    LE_MCC_PROFILE_IN_USE          
}
le_mcc_profile_State_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MCC_EVENT_INCOMING,    
    LE_MCC_EVENT_ALERTING,    
    LE_MCC_EVENT_EARLY_MEDIA, 
    LE_MCC_EVENT_CONNECTED,   
    LE_MCC_EVENT_TERMINATED,  
    LE_MCC_EVENT_ON_HOLD,     
    LE_MCC_EVENT_TRANSFERED,  
}
le_mcc_call_Event_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MCC_TERM_NETWORK_FAIL,  
    LE_MCC_TERM_BAD_ADDRESS,   
    LE_MCC_TERM_BUSY,          
    LE_MCC_TERM_LOCAL_ENDED,   
    LE_MCC_TERM_REMOTE_ENDED,  
    LE_MCC_TERM_NOT_DEFINED,   
}
le_mcc_call_TerminationReason_t;

//--------------------------------------------------------------------------------------------------
// API type definitions.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mcc_profile_Obj* le_mcc_profile_ObjRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mcc_profile_StateChangeHandler* le_mcc_profile_StateChangeHandlerRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mcc_profile_CallEventHandler* le_mcc_profile_CallEventHandlerRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mcc_call_Obj* le_mcc_call_ObjRef_t;


//--------------------------------------------------------------------------------------------------
// Event handler definitions.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_mcc_profile_StateChangeHandlerFunc_t)
(
    le_mcc_profile_State_t  newState,
    void*                   contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_mcc_profile_CallEventHandlerFunc_t)
(
    le_mcc_call_ObjRef_t callRef,
    le_mcc_call_Event_t  event,
    void*                contextPtr
);


//--------------------------------------------------------------------------------------------------
// API Function definitions.
//--------------------------------------------------------------------------------------------------


//--------------------------------------------------------------------------------------------------
// CALL PROFILE.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mcc_profile_ObjRef_t le_mcc_profile_GetByName
(
    const char* profileNamePtr           
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mcc_profile_Release
(
    le_mcc_profile_ObjRef_t  profileRef    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mcc_profile_State_t le_mcc_profile_GetState
(
    le_mcc_profile_ObjRef_t    profileRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mcc_profile_StateChangeHandlerRef_t le_mcc_profile_AddStateChangeHandler
(
    le_mcc_profile_ObjRef_t                  profileRef,      
    le_mcc_profile_StateChangeHandlerFunc_t  handlerFuncPtr,  
    void*                                    contextPtr       
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mcc_profile_RemoveStateChangeHandler
(
    le_mcc_profile_StateChangeHandlerRef_t handlerRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mcc_profile_CallEventHandlerRef_t le_mcc_profile_AddCallEventHandler
(
    le_mcc_profile_ObjRef_t                profileRef,     
    le_mcc_profile_CallEventHandlerFunc_t  handlerFuncPtr, 
    void*                                  contextPtr      
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mcc_profile_RemoveCallEventHandler
(
    le_mcc_profile_CallEventHandlerRef_t handlerRef   
);

//--------------------------------------------------------------------------------------------------
// CALL.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mcc_call_ObjRef_t le_mcc_profile_CreateCall
(
    le_mcc_profile_ObjRef_t profileRef,     
    const char*             destinationPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mcc_call_Delete
(
    le_mcc_call_ObjRef_t callRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mcc_call_Start
(
    le_mcc_call_ObjRef_t callRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_mcc_call_IsConnected
(
    le_mcc_call_ObjRef_t  callRef  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mcc_call_GetRemoteTel
(
    le_mcc_call_ObjRef_t callRef,    
    char*                telPtr,     
    size_t               len         
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mcc_call_TerminationReason_t le_mcc_call_GetTerminationReason
(
    le_mcc_call_ObjRef_t callRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_mcc_call_GetTxAudioStream
(
    le_mcc_call_ObjRef_t callRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_mcc_call_GetRxAudioStream
(
    le_mcc_call_ObjRef_t callRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mcc_call_Answer
(
    le_mcc_call_ObjRef_t callRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mcc_call_HangUp
(
    le_mcc_call_ObjRef_t callRef   
);


#endif   // LEGATO_MCC_H_INCLUDE_GUARD