le_audio.h

Go to the documentation of this file.

#ifndef LEGATO_AUDIO_INCLUDE_GUARD
#define LEGATO_AUDIO_INCLUDE_GUARD

#include "legato.h"

// todo: Once the hand-coded le_audio.h file is removed, should everything be changed to use the
//       auto-generated le_audio_interface.h file, or should the name of the auto-generated file
//       be changed to le_audio.h.
#include "le_audio_interface.h"

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_audio_Stream*   le_audio_StreamRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_audio_Connector*   le_audio_ConnectorRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_audio_OpenMic
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_audio_OpenSpeaker
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_audio_OpenUsbRx
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_audio_OpenUsbTx
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_audio_OpenPcmRx
(
    uint32_t timeslot  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_audio_OpenPcmTx
(
    uint32_t timeslot  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_audio_OpenI2sRx
(
    le_audio_I2SChannel_t mode  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_audio_OpenI2sTx
(
    le_audio_I2SChannel_t mode  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_audio_OpenFilePlayback
(
    int     fd  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_audio_OpenFileRecording
(
    int     fd  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_audio_OpenModemVoiceRx
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_StreamRef_t le_audio_OpenModemVoiceTx
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_audio_GetFormat
(
    le_audio_StreamRef_t streamRef,  
    char*                formatPtr,  
    size_t               len         
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_audio_Close
(
    le_audio_StreamRef_t streamRef  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_audio_SetGain
(
    le_audio_StreamRef_t streamRef,  
    uint32_t             gain        
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_audio_GetGain
(
    le_audio_StreamRef_t streamRef,  
    uint32_t            *gainPtr     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_audio_Mute
(
    le_audio_StreamRef_t streamRef  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_audio_Unmute
(
    le_audio_StreamRef_t streamRef  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_audio_ConnectorRef_t le_audio_CreateConnector
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_audio_DeleteConnector
(
    le_audio_ConnectorRef_t connectorRef    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_audio_Connect
(
    le_audio_ConnectorRef_t connectorRef,   
    le_audio_StreamRef_t    streamRef       
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_audio_Disconnect
(
    le_audio_ConnectorRef_t connectorRef,   
    le_audio_StreamRef_t    streamRef       
);

#endif // LEGATO_AUDIO_INCLUDE_GUARD