le_audio_interface.h
Go to the documentation of this file.
51 * An audio profile can be retrieved with le_audio_GetProfile() and set with le_audio_SetProfile().53 * Then, the following functions let you enable or disable the audio settings on the selected audio59 * - le_audio_EnableIirFilter()/ le_audio_DisableIirFilter(): downlink IIR Filter (Infinite Impulse67 * To configure the encoding format, use le_audio_GetEncodingFormat() and le_audio_SetEncodingFormat().73 * - le_audio_GetPcmSamplingResolution() and le_audio_SetPcmSamplingResolution() for bit/sample settings.75 * - le_audio_GetSamplePcmChannelNumber() and le_audio_SetSamplePcmChannelNumber() for channel numbers.101 * - le_audio_OpenModemVoiceRx(): returns an Audio Stream Reference of the digitized audio signal104 * - le_audio_OpenModemVoiceTx(): returns an Audio Stream Reference of the digitized audio signal129 * On most platforms, it only allocates a context in memory. The audio path becomes active when the135 * Once the users get an Audio Stream reference, they can control it with the following functions:144 * @note Multimedia (playback and recording) must be controled separatly from the main audio path146 * muting/unmuting the multimedia stream, and not the other connected stream. For example, in case156 * - le_audio_SetPlatformSpecificGain(): adjust the value of a platform specific gain in the audio181 * A sample code that implements audio connectors and audio streams during voice call can be found in185 * In particular, a connector using Modem Voice Rx or Tx interfaces has to be created before dialing202 * - AMR_NB (AMR Narrowband) codec that encodes narrowband (200--3400 Hz) signals at variable bit204 * - AMR-WB (AMR Wideband) is an ITU-T standard speech codec which improved speech quality due to a231 * "I2S Rx", "Modem Voice Tx" and "Recorder" must be previously connected before recording a file.262 * - The playback/record stops playing/recording, and the read/write position indicator associated263 * with the file stream is rewound to the beginning of the file. A new file can be played/recorded265 * - le_audio_Pause(): can be called to pause a play/record. The file playing/recording is put on280 * @note The @c LE_AUDIO_MEDIA_NO_MORE_SAMPLES event indicates when all samples put into the pipe283 * A sample code that implements audio playback and capture can be found in \b audioPlaybackRec.c288 * The le_audio_PlayDtmf() function allows the application to play one or several DTMF on a playback289 * stream. The duration and the pause of the DTMFs must also be specified with the input parameters.291 * The le_audio_PlaySignallingDtmf() function allows the application to ask the Mobile Network to293 * le_audio_PlaySignallingDtmf() function may offer a better signal quality, but the the duration296 * The application must register a handler function to detect incoming DTMF characters on a specific297 * input audio stream. The le_audio_AddDtmfDetectorHandler() function installs a handler for DTMF306 * A sample code that implements DTMF playback and decoding can be found in \b audioDtmfTest.c file343 //--------------------------------------------------------------------------------------------------347 //--------------------------------------------------------------------------------------------------350 //--------------------------------------------------------------------------------------------------353 * Connect the current client thread to the service providing this API. Block until the service is356 * For each thread that wants to use this API, either ConnectService or TryConnectService must be357 * called before any other functions in this API. Normally, ConnectService is automatically called362 //--------------------------------------------------------------------------------------------------368 //--------------------------------------------------------------------------------------------------371 * Try to connect the current client thread to the service providing this API. Return with an error374 * For each thread that wants to use this API, either ConnectService or TryConnectService must be375 * called before any other functions in this API. Normally, ConnectService is automatically called384 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).387 //--------------------------------------------------------------------------------------------------393 //--------------------------------------------------------------------------------------------------397 * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants400 //--------------------------------------------------------------------------------------------------407 //--------------------------------------------------------------------------------------------------413 * longer a connection to the service, and the functions in this API can't be used. For details, see418 //--------------------------------------------------------------------------------------------------425 //--------------------------------------------------------------------------------------------------429 //--------------------------------------------------------------------------------------------------432 //--------------------------------------------------------------------------------------------------437 //--------------------------------------------------------------------------------------------------440 //--------------------------------------------------------------------------------------------------444 //--------------------------------------------------------------------------------------------------447 //--------------------------------------------------------------------------------------------------451 //--------------------------------------------------------------------------------------------------454 //--------------------------------------------------------------------------------------------------459 //--------------------------------------------------------------------------------------------------462 //--------------------------------------------------------------------------------------------------466 //--------------------------------------------------------------------------------------------------481 //--------------------------------------------------------------------------------------------------485 //--------------------------------------------------------------------------------------------------498 //--------------------------------------------------------------------------------------------------502 //--------------------------------------------------------------------------------------------------519 //--------------------------------------------------------------------------------------------------523 //--------------------------------------------------------------------------------------------------536 //--------------------------------------------------------------------------------------------------540 //--------------------------------------------------------------------------------------------------583 //--------------------------------------------------------------------------------------------------587 //--------------------------------------------------------------------------------------------------591 //--------------------------------------------------------------------------------------------------595 //--------------------------------------------------------------------------------------------------599 //--------------------------------------------------------------------------------------------------603 //--------------------------------------------------------------------------------------------------607 //--------------------------------------------------------------------------------------------------611 //--------------------------------------------------------------------------------------------------615 //--------------------------------------------------------------------------------------------------620 //--------------------------------------------------------------------------------------------------622 (631 //--------------------------------------------------------------------------------------------------636 //--------------------------------------------------------------------------------------------------638 (647 //--------------------------------------------------------------------------------------------------653 //--------------------------------------------------------------------------------------------------659 //--------------------------------------------------------------------------------------------------665 //--------------------------------------------------------------------------------------------------671 //--------------------------------------------------------------------------------------------------677 //--------------------------------------------------------------------------------------------------683 //--------------------------------------------------------------------------------------------------689 //--------------------------------------------------------------------------------------------------695 //--------------------------------------------------------------------------------------------------701 //--------------------------------------------------------------------------------------------------708 //--------------------------------------------------------------------------------------------------714 //--------------------------------------------------------------------------------------------------721 //--------------------------------------------------------------------------------------------------727 //--------------------------------------------------------------------------------------------------734 //--------------------------------------------------------------------------------------------------740 //--------------------------------------------------------------------------------------------------747 //--------------------------------------------------------------------------------------------------753 //--------------------------------------------------------------------------------------------------759 //--------------------------------------------------------------------------------------------------765 //--------------------------------------------------------------------------------------------------771 //--------------------------------------------------------------------------------------------------777 //--------------------------------------------------------------------------------------------------783 //--------------------------------------------------------------------------------------------------789 //--------------------------------------------------------------------------------------------------795 //--------------------------------------------------------------------------------------------------802 //--------------------------------------------------------------------------------------------------813 //--------------------------------------------------------------------------------------------------817 //--------------------------------------------------------------------------------------------------824 //--------------------------------------------------------------------------------------------------833 //--------------------------------------------------------------------------------------------------840 //--------------------------------------------------------------------------------------------------852 //--------------------------------------------------------------------------------------------------861 //--------------------------------------------------------------------------------------------------872 //--------------------------------------------------------------------------------------------------881 //--------------------------------------------------------------------------------------------------892 //--------------------------------------------------------------------------------------------------899 //--------------------------------------------------------------------------------------------------910 //--------------------------------------------------------------------------------------------------917 //--------------------------------------------------------------------------------------------------923 //--------------------------------------------------------------------------------------------------929 //--------------------------------------------------------------------------------------------------936 //--------------------------------------------------------------------------------------------------943 //--------------------------------------------------------------------------------------------------955 //--------------------------------------------------------------------------------------------------964 //--------------------------------------------------------------------------------------------------971 //--------------------------------------------------------------------------------------------------980 //--------------------------------------------------------------------------------------------------987 //--------------------------------------------------------------------------------------------------998 //--------------------------------------------------------------------------------------------------1002 //--------------------------------------------------------------------------------------------------1009 //--------------------------------------------------------------------------------------------------1018 //--------------------------------------------------------------------------------------------------1025 //--------------------------------------------------------------------------------------------------1034 //--------------------------------------------------------------------------------------------------1041 //--------------------------------------------------------------------------------------------------1050 //--------------------------------------------------------------------------------------------------1057 //--------------------------------------------------------------------------------------------------1066 //--------------------------------------------------------------------------------------------------1073 //--------------------------------------------------------------------------------------------------1083 //--------------------------------------------------------------------------------------------------1092 //--------------------------------------------------------------------------------------------------1102 //--------------------------------------------------------------------------------------------------1111 //--------------------------------------------------------------------------------------------------1120 //--------------------------------------------------------------------------------------------------1127 //--------------------------------------------------------------------------------------------------1136 //--------------------------------------------------------------------------------------------------1143 //--------------------------------------------------------------------------------------------------1152 //--------------------------------------------------------------------------------------------------1159 //--------------------------------------------------------------------------------------------------1168 //--------------------------------------------------------------------------------------------------1175 //--------------------------------------------------------------------------------------------------1177 * This function must be called to enable the automatic gain control on the selected audio stream.1184 //--------------------------------------------------------------------------------------------------1191 //--------------------------------------------------------------------------------------------------1193 * This function must be called to disable the automatic gain control on the selected audio stream.1200 //--------------------------------------------------------------------------------------------------1207 //--------------------------------------------------------------------------------------------------1215 //--------------------------------------------------------------------------------------------------1222 //--------------------------------------------------------------------------------------------------1230 //--------------------------------------------------------------------------------------------------1237 //--------------------------------------------------------------------------------------------------1246 //--------------------------------------------------------------------------------------------------1253 //--------------------------------------------------------------------------------------------------1262 //--------------------------------------------------------------------------------------------------1269 //--------------------------------------------------------------------------------------------------1278 //--------------------------------------------------------------------------------------------------1285 //--------------------------------------------------------------------------------------------------1291 //--------------------------------------------------------------------------------------------------1297 //--------------------------------------------------------------------------------------------------1303 //--------------------------------------------------------------------------------------------------1309 //--------------------------------------------------------------------------------------------------1315 //--------------------------------------------------------------------------------------------------1321 //--------------------------------------------------------------------------------------------------1327 //--------------------------------------------------------------------------------------------------1333 //--------------------------------------------------------------------------------------------------1339 //--------------------------------------------------------------------------------------------------1345 //--------------------------------------------------------------------------------------------------1360 * thus share file offset. So, once a playback has reached the end of file, the application must1369 //--------------------------------------------------------------------------------------------------1378 //--------------------------------------------------------------------------------------------------1386 * @note The fd is closed by the IPC API. To use again the same pipe, the fd parameter can be set1388 * If the fd as to be kept on its side, the application should duplicate the fd (e.g., using dup() )1393 //--------------------------------------------------------------------------------------------------1402 //--------------------------------------------------------------------------------------------------1411 * @note the fd is closed by the API. To record again the same file, the fd parameter can be set to1413 * If the fd as to be kept on its side, the application should duplicate the fd (e.g., using dup() )1417 //--------------------------------------------------------------------------------------------------1426 //--------------------------------------------------------------------------------------------------1434 * @note The fd is closed by the API. To use again the same pipe, the fd parameter can be set to1436 * If the fd as to be kept on its side, the application should duplicate the fd (e.g., using dup() )1441 //--------------------------------------------------------------------------------------------------1450 //--------------------------------------------------------------------------------------------------1460 //--------------------------------------------------------------------------------------------------1467 //--------------------------------------------------------------------------------------------------1475 //--------------------------------------------------------------------------------------------------1482 //--------------------------------------------------------------------------------------------------1490 //--------------------------------------------------------------------------------------------------1497 //--------------------------------------------------------------------------------------------------1505 //--------------------------------------------------------------------------------------------------1512 //--------------------------------------------------------------------------------------------------1520 //--------------------------------------------------------------------------------------------------1529 //--------------------------------------------------------------------------------------------------1537 //--------------------------------------------------------------------------------------------------1546 //--------------------------------------------------------------------------------------------------1554 //--------------------------------------------------------------------------------------------------1563 //--------------------------------------------------------------------------------------------------1571 //--------------------------------------------------------------------------------------------------1580 //--------------------------------------------------------------------------------------------------1588 //--------------------------------------------------------------------------------------------------1597 //--------------------------------------------------------------------------------------------------1605 //--------------------------------------------------------------------------------------------------1614 //--------------------------------------------------------------------------------------------------1627 //--------------------------------------------------------------------------------------------------1640 //--------------------------------------------------------------------------------------------------1642 * This function must be called to ask to the Mobile Network to generate on the remote audio party1653 //--------------------------------------------------------------------------------------------------1664 //--------------------------------------------------------------------------------------------------1672 //--------------------------------------------------------------------------------------------------1681 //--------------------------------------------------------------------------------------------------1692 //--------------------------------------------------------------------------------------------------1701 //--------------------------------------------------------------------------------------------------1709 //--------------------------------------------------------------------------------------------------1718 //--------------------------------------------------------------------------------------------------1728 //--------------------------------------------------------------------------------------------------1737 //--------------------------------------------------------------------------------------------------1745 //--------------------------------------------------------------------------------------------------1754 //--------------------------------------------------------------------------------------------------1762 //--------------------------------------------------------------------------------------------------1771 //--------------------------------------------------------------------------------------------------1782 //--------------------------------------------------------------------------------------------------1791 //--------------------------------------------------------------------------------------------------1801 //--------------------------------------------------------------------------------------------------1810 //--------------------------------------------------------------------------------------------------1817 //--------------------------------------------------------------------------------------------------1823 //--------------------------------------------------------------------------------------------------1830 //--------------------------------------------------------------------------------------------------le_result_t le_audio_SetSamplePcmSamplingRate(le_audio_StreamRef_t streamRef, uint32_t rate)le_result_t le_audio_GetSamplePcmSamplingRate(le_audio_StreamRef_t streamRef, uint32_t *ratePtr)le_result_t le_audio_DisableNoiseSuppressor(le_audio_StreamRef_t streamRef)le_result_t le_audio_Pause(le_audio_StreamRef_t streamRef)uint32_t le_audio_GetPcmSamplingResolution(void)le_result_t le_audio_SetSamplePcmChannelNumber(le_audio_StreamRef_t streamRef, uint32_t nbChannel)void le_audio_RemoveMediaHandler(le_audio_MediaHandlerRef_t handlerRef)le_result_t le_audio_GetSamplePcmChannelNumber(le_audio_StreamRef_t streamRef, uint32_t *nbChannelPtr)le_result_t le_audio_DisableEchoCanceller(le_audio_StreamRef_t streamRef)le_result_t le_audio_SetPcmSamplingRate(uint32_t rate)le_result_t le_audio_RecordFile(le_audio_StreamRef_t streamRef, int fd)MU-law PCM (i.e. North America and Japan).Definition: le_audio_interface.h:490le_audio_StreamRef_t le_audio_OpenModemVoiceTx(void)le_result_t le_audio_IsEchoCancellerEnabled(le_audio_StreamRef_t streamRef, bool *statusPtr)le_result_t le_audio_GetSampleAmrDtx(le_audio_StreamRef_t streamRef, bool *dtxPtr)le_audio_StreamRef_t le_audio_OpenI2sTx(le_audio_I2SChannel_t mode)void le_audio_RemoveDtmfDetectorHandler(le_audio_DtmfDetectorHandlerRef_t handlerRef)le_audio_StreamRef_t le_audio_OpenI2sRx(le_audio_I2SChannel_t mode)le_result_t le_audio_GetSamples(le_audio_StreamRef_t streamRef, int fd)le_result_t le_audio_Flush(le_audio_StreamRef_t streamRef)le_result_t le_audio_DisableIirFilter(le_audio_StreamRef_t streamRef)struct le_audio_Stream * le_audio_StreamRef_tDefinition: le_audio_interface.h:588AMR Narrowband in 7.4kbps (default value)Definition: le_audio_interface.h:553le_result_t le_audio_GetPlatformSpecificGain(const char *LE_NONNULL gainName, int32_t *gainPtr)le_result_t le_audio_GetProfile(uint32_t *profilePtr)le_result_t le_audio_TryConnectService(void)le_audio_StreamRef_t le_audio_OpenUsbTx(void)le_result_t le_audio_Connect(le_audio_ConnectorRef_t connectorRef, le_audio_StreamRef_t streamRef)le_result_t le_audio_Unmute(le_audio_StreamRef_t streamRef)void(* le_audio_DtmfDetectorHandlerFunc_t)(le_audio_StreamRef_t streamRef, char dtmf, void *contextPtr)Definition: le_audio_interface.h:638le_audio_StreamRef_t le_audio_OpenSpeaker(void)struct le_audio_Connector * le_audio_ConnectorRef_tDefinition: le_audio_interface.h:596le_result_t le_audio_EnableFirFilter(le_audio_StreamRef_t streamRef)uint32_t le_audio_GetPcmSamplingRate(void)le_result_t le_audio_MuteCallWaitingTone(void)le_result_t le_audio_PlaySamples(le_audio_StreamRef_t streamRef, int fd)le_audio_I2SChannel_t le_audio_GetDefaultI2sMode(void)struct le_audio_DtmfDetectorHandler * le_audio_DtmfDetectorHandlerRef_tDefinition: le_audio_interface.h:612le_result_t le_audio_DisableAutomaticGainControl(le_audio_StreamRef_t streamRef)le_audio_ConnectorRef_t le_audio_CreateConnector(void)le_result_t le_audio_PlayFile(le_audio_StreamRef_t streamRef, int fd)le_audio_StreamRef_t le_audio_OpenPcmTx(uint32_t timeslot)le_result_t le_audio_PlayDtmf(le_audio_StreamRef_t streamRef, const char *LE_NONNULL dtmf, uint32_t duration, uint32_t pause)le_result_t le_audio_SetPcmCompanding(le_audio_Companding_t companding)le_result_t le_audio_GetSamplePcmSamplingResolution(le_audio_StreamRef_t streamRef, uint32_t *samplingResPtr)le_result_t le_audio_IsNoiseSuppressorEnabled(le_audio_StreamRef_t streamRef, bool *statusPtr)le_result_t le_audio_SetProfile(uint32_t profile)le_audio_StreamRef_t le_audio_OpenModemVoiceRx(void)le_audio_StreamRef_t le_audio_OpenRecorder(void)le_result_t le_audio_Resume(le_audio_StreamRef_t streamRef)void(* le_audio_DisconnectHandler_t)(void *)Definition: le_audio_interface.h:348void le_audio_Close(le_audio_StreamRef_t streamRef)A-law PCM (i.e. Europe and most of the rest of the world).Definition: le_audio_interface.h:488le_audio_StreamRef_t le_audio_OpenPlayer(void)void le_audio_DisconnectService(void)uint32_t le_audio_GetDefaultPcmTimeSlot(void)le_result_t le_audio_Stop(le_audio_StreamRef_t streamRef)le_result_t le_audio_SetGain(le_audio_StreamRef_t streamRef, int32_t gain)le_audio_StreamRef_t le_audio_OpenPcmRx(uint32_t timeslot)le_result_t le_audio_SetPcmSamplingResolution(uint32_t bitsPerSample)struct le_audio_MediaHandler * le_audio_MediaHandlerRef_tDefinition: le_audio_interface.h:604le_result_t le_audio_SetEncodingFormat(le_audio_StreamRef_t streamRef, le_audio_Format_t format)le_audio_StreamRef_t le_audio_OpenUsbRx(void)le_result_t le_audio_EnableEchoCanceller(le_audio_StreamRef_t streamRef)le_result_t le_audio_SetSampleAmrMode(le_audio_StreamRef_t streamRef, le_audio_AmrMode_t mode)le_result_t le_audio_DisableFirFilter(le_audio_StreamRef_t streamRef)Recording/playback has encountered an error.Definition: le_audio_interface.h:473void le_audio_ConnectService(void)le_result_t le_audio_GetGain(le_audio_StreamRef_t streamRef, int32_t *gainPtr)le_result_t le_audio_SetSampleAmrDtx(le_audio_StreamRef_t streamRef, bool dtx)void le_audio_SetServerDisconnectHandler(le_audio_DisconnectHandler_t disconnectHandler, void *contextPtr)le_result_t le_audio_SetSamplePcmSamplingResolution(le_audio_StreamRef_t streamRef, uint32_t samplingRes)le_audio_MediaHandlerRef_t le_audio_AddMediaHandler(le_audio_StreamRef_t streamRef, le_audio_MediaHandlerFunc_t handlerPtr, void *contextPtr)le_result_t le_audio_GetEncodingFormat(le_audio_StreamRef_t streamRef, le_audio_Format_t *formatPtr)le_audio_Companding_t le_audio_GetPcmCompanding(void)le_audio_DtmfDetectorHandlerRef_t le_audio_AddDtmfDetectorHandler(le_audio_StreamRef_t streamRef, le_audio_DtmfDetectorHandlerFunc_t handlerPtr, void *contextPtr)void le_audio_Disconnect(le_audio_ConnectorRef_t connectorRef, le_audio_StreamRef_t streamRef)void le_audio_DeleteConnector(le_audio_ConnectorRef_t connectorRef)le_result_t le_audio_SetPlatformSpecificGain(const char *LE_NONNULL gainName, int32_t gain)le_result_t le_audio_EnableNoiseSuppressor(le_audio_StreamRef_t streamRef)le_result_t le_audio_UnmuteCallWaitingTone(void)le_result_t le_audio_PlaySignallingDtmf(const char *LE_NONNULL dtmf, uint32_t duration, uint32_t pause)le_result_t le_audio_GetSampleAmrMode(le_audio_StreamRef_t streamRef, le_audio_AmrMode_t *modePtr)le_audio_StreamRef_t le_audio_OpenMic(void)void(* le_audio_MediaHandlerFunc_t)(le_audio_StreamRef_t streamRef, le_audio_MediaEvent_t event, void *contextPtr)Definition: le_audio_interface.h:622le_result_t le_audio_EnableIirFilter(le_audio_StreamRef_t streamRef)le_result_t le_audio_EnableAutomaticGainControl(le_audio_StreamRef_t streamRef)le_result_t le_audio_Mute(le_audio_StreamRef_t streamRef)