le_audio_interface.h
Go to the documentation of this file.
54 * An audio profile can be retrieved with le_audio_GetProfile() and set with le_audio_SetProfile().56 * Then, the following functions let you enable or disable the audio settings on the selected audio62 * - le_audio_EnableIirFilter()/ le_audio_DisableIirFilter(): downlink IIR Filter (Infinite Impulse70 * To configure the encoding format, use le_audio_GetEncodingFormat() and le_audio_SetEncodingFormat().76 * - le_audio_GetPcmSamplingResolution() and le_audio_SetPcmSamplingResolution() for bit/sample settings.78 * - le_audio_GetSamplePcmChannelNumber() and le_audio_SetSamplePcmChannelNumber() for channel numbers.107 * - le_audio_OpenModemVoiceRx(): returns an Audio Stream Reference of the digitized audio signal110 * - le_audio_OpenModemVoiceTx(): returns an Audio Stream Reference of the digitized audio signal135 * On most platforms, it only allocates a context in memory. The audio path becomes active when the141 * Once the users get an Audio Stream reference, they can control it with the following functions:150 * @note Multimedia (playback and recording) must be controlled separately from the main audio path152 * muting/unmuting the multimedia stream, and not the other connected stream. For example, in case162 * - le_audio_SetPlatformSpecificGain(): adjust the value of a platform specific gain in the audio187 * A sample code that implements audio connectors and audio streams during voice call can be found in191 * In particular, a connector using Modem Voice Rx or Tx interfaces has to be created before dialing208 * - AMR_NB (AMR Narrowband) codec that encodes narrowband (200--3400 Hz) signals at variable bit210 * - AMR-WB (AMR Wideband) is an ITU-T standard speech codec which improved speech quality due to a237 * "I2S Rx", "Modem Voice Tx" and "Recorder" must be previously connected before recording a file.268 * - The playback/record stops playing/recording, and the read/write position indicator associated269 * with the file stream is rewound to the beginning of the file. A new file can be played/recorded271 * - le_audio_Pause(): can be called to pause a play/record. The file playing/recording is put on286 * @note The @c LE_AUDIO_MEDIA_NO_MORE_SAMPLES event indicates when all samples put into the pipe289 * A sample code that implements audio playback and capture can be found in \b audioPlaybackRec.c294 * The le_audio_PlayDtmf() function allows the application to play one or several DTMF on a playback295 * stream. The duration and the pause of the DTMFs must also be specified with the input parameters.297 * The le_audio_PlaySignallingDtmf() function allows the application to ask the Mobile Network to299 * le_audio_PlaySignallingDtmf() function may offer a better signal quality, but the the duration302 * The application must register a handler function to detect incoming DTMF characters on a specific303 * input audio stream. The le_audio_AddDtmfDetectorHandler() function installs a handler for DTMF312 * A sample code that implements DTMF playback and decoding can be found in \b audioDtmfTest.c file349 //--------------------------------------------------------------------------------------------------353 //--------------------------------------------------------------------------------------------------356 //--------------------------------------------------------------------------------------------------359 * Connect the current client thread to the service providing this API. Block until the service is362 * For each thread that wants to use this API, either ConnectService or TryConnectService must be363 * called before any other functions in this API. Normally, ConnectService is automatically called368 //--------------------------------------------------------------------------------------------------374 //--------------------------------------------------------------------------------------------------377 * Try to connect the current client thread to the service providing this API. Return with an error380 * For each thread that wants to use this API, either ConnectService or TryConnectService must be381 * called before any other functions in this API. Normally, ConnectService is automatically called390 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).393 //--------------------------------------------------------------------------------------------------399 //--------------------------------------------------------------------------------------------------403 * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants406 //--------------------------------------------------------------------------------------------------413 //--------------------------------------------------------------------------------------------------419 * longer a connection to the service, and the functions in this API can't be used. For details, see424 //--------------------------------------------------------------------------------------------------431 //--------------------------------------------------------------------------------------------------435 //--------------------------------------------------------------------------------------------------438 //--------------------------------------------------------------------------------------------------443 //--------------------------------------------------------------------------------------------------446 //--------------------------------------------------------------------------------------------------450 //--------------------------------------------------------------------------------------------------453 //--------------------------------------------------------------------------------------------------457 //--------------------------------------------------------------------------------------------------460 //--------------------------------------------------------------------------------------------------465 //--------------------------------------------------------------------------------------------------468 //--------------------------------------------------------------------------------------------------472 //--------------------------------------------------------------------------------------------------487 //--------------------------------------------------------------------------------------------------491 //--------------------------------------------------------------------------------------------------504 //--------------------------------------------------------------------------------------------------508 //--------------------------------------------------------------------------------------------------525 //--------------------------------------------------------------------------------------------------529 //--------------------------------------------------------------------------------------------------542 //--------------------------------------------------------------------------------------------------546 //--------------------------------------------------------------------------------------------------589 //--------------------------------------------------------------------------------------------------593 //--------------------------------------------------------------------------------------------------597 //--------------------------------------------------------------------------------------------------601 //--------------------------------------------------------------------------------------------------605 //--------------------------------------------------------------------------------------------------609 //--------------------------------------------------------------------------------------------------613 //--------------------------------------------------------------------------------------------------617 //--------------------------------------------------------------------------------------------------621 //--------------------------------------------------------------------------------------------------626 //--------------------------------------------------------------------------------------------------628 (637 //--------------------------------------------------------------------------------------------------642 //--------------------------------------------------------------------------------------------------644 (653 //--------------------------------------------------------------------------------------------------659 //--------------------------------------------------------------------------------------------------665 //--------------------------------------------------------------------------------------------------671 //--------------------------------------------------------------------------------------------------677 //--------------------------------------------------------------------------------------------------683 //--------------------------------------------------------------------------------------------------689 //--------------------------------------------------------------------------------------------------695 //--------------------------------------------------------------------------------------------------701 //--------------------------------------------------------------------------------------------------707 //--------------------------------------------------------------------------------------------------714 //--------------------------------------------------------------------------------------------------720 //--------------------------------------------------------------------------------------------------727 //--------------------------------------------------------------------------------------------------733 //--------------------------------------------------------------------------------------------------740 //--------------------------------------------------------------------------------------------------746 //--------------------------------------------------------------------------------------------------753 //--------------------------------------------------------------------------------------------------759 //--------------------------------------------------------------------------------------------------765 //--------------------------------------------------------------------------------------------------771 //--------------------------------------------------------------------------------------------------777 //--------------------------------------------------------------------------------------------------783 //--------------------------------------------------------------------------------------------------789 //--------------------------------------------------------------------------------------------------795 //--------------------------------------------------------------------------------------------------801 //--------------------------------------------------------------------------------------------------808 //--------------------------------------------------------------------------------------------------819 //--------------------------------------------------------------------------------------------------823 //--------------------------------------------------------------------------------------------------830 //--------------------------------------------------------------------------------------------------839 //--------------------------------------------------------------------------------------------------846 //--------------------------------------------------------------------------------------------------859 //--------------------------------------------------------------------------------------------------868 //--------------------------------------------------------------------------------------------------880 //--------------------------------------------------------------------------------------------------889 //--------------------------------------------------------------------------------------------------901 //--------------------------------------------------------------------------------------------------908 //--------------------------------------------------------------------------------------------------920 //--------------------------------------------------------------------------------------------------927 //--------------------------------------------------------------------------------------------------933 //--------------------------------------------------------------------------------------------------939 //--------------------------------------------------------------------------------------------------946 //--------------------------------------------------------------------------------------------------953 //--------------------------------------------------------------------------------------------------966 //--------------------------------------------------------------------------------------------------975 //--------------------------------------------------------------------------------------------------982 //--------------------------------------------------------------------------------------------------991 //--------------------------------------------------------------------------------------------------998 //--------------------------------------------------------------------------------------------------1009 //--------------------------------------------------------------------------------------------------1013 //--------------------------------------------------------------------------------------------------1020 //--------------------------------------------------------------------------------------------------1031 //--------------------------------------------------------------------------------------------------1038 //--------------------------------------------------------------------------------------------------1049 //--------------------------------------------------------------------------------------------------1056 //--------------------------------------------------------------------------------------------------1067 //--------------------------------------------------------------------------------------------------1074 //--------------------------------------------------------------------------------------------------1085 //--------------------------------------------------------------------------------------------------1092 //--------------------------------------------------------------------------------------------------1103 //--------------------------------------------------------------------------------------------------1112 //--------------------------------------------------------------------------------------------------1123 //--------------------------------------------------------------------------------------------------1132 //--------------------------------------------------------------------------------------------------1143 //--------------------------------------------------------------------------------------------------1150 //--------------------------------------------------------------------------------------------------1161 //--------------------------------------------------------------------------------------------------1168 //--------------------------------------------------------------------------------------------------1179 //--------------------------------------------------------------------------------------------------1186 //--------------------------------------------------------------------------------------------------1197 //--------------------------------------------------------------------------------------------------1204 //--------------------------------------------------------------------------------------------------1206 * This function must be called to enable the automatic gain control on the selected audio stream.1215 //--------------------------------------------------------------------------------------------------1222 //--------------------------------------------------------------------------------------------------1224 * This function must be called to disable the automatic gain control on the selected audio stream.1233 //--------------------------------------------------------------------------------------------------1240 //--------------------------------------------------------------------------------------------------1249 //--------------------------------------------------------------------------------------------------1256 //--------------------------------------------------------------------------------------------------1265 //--------------------------------------------------------------------------------------------------1272 //--------------------------------------------------------------------------------------------------1281 //--------------------------------------------------------------------------------------------------1288 //--------------------------------------------------------------------------------------------------1297 //--------------------------------------------------------------------------------------------------1304 //--------------------------------------------------------------------------------------------------1313 //--------------------------------------------------------------------------------------------------1320 //--------------------------------------------------------------------------------------------------1326 //--------------------------------------------------------------------------------------------------1332 //--------------------------------------------------------------------------------------------------1338 //--------------------------------------------------------------------------------------------------1344 //--------------------------------------------------------------------------------------------------1350 //--------------------------------------------------------------------------------------------------1356 //--------------------------------------------------------------------------------------------------1362 //--------------------------------------------------------------------------------------------------1368 //--------------------------------------------------------------------------------------------------1374 //--------------------------------------------------------------------------------------------------1380 //--------------------------------------------------------------------------------------------------1395 * thus share file offset. So, once a playback has reached the end of file, the application must1404 //--------------------------------------------------------------------------------------------------1413 //--------------------------------------------------------------------------------------------------1421 * @note The fd is closed by the IPC API. To use again the same pipe, the fd parameter can be set1423 * If the fd as to be kept on its side, the application should duplicate the fd (e.g., using dup() )1428 //--------------------------------------------------------------------------------------------------1437 //--------------------------------------------------------------------------------------------------1446 * @note the fd is closed by the API. To record again the same file, the fd parameter can be set to1448 * If the fd as to be kept on its side, the application should duplicate the fd (e.g., using dup() )1452 //--------------------------------------------------------------------------------------------------1461 //--------------------------------------------------------------------------------------------------1469 * @note The fd is closed by the API. To use again the same pipe, the fd parameter can be set to1471 * If the fd as to be kept on its side, the application should duplicate the fd (e.g., using dup() )1476 //--------------------------------------------------------------------------------------------------1485 //--------------------------------------------------------------------------------------------------1495 //--------------------------------------------------------------------------------------------------1502 //--------------------------------------------------------------------------------------------------1510 //--------------------------------------------------------------------------------------------------1517 //--------------------------------------------------------------------------------------------------1525 //--------------------------------------------------------------------------------------------------1532 //--------------------------------------------------------------------------------------------------1540 //--------------------------------------------------------------------------------------------------1547 //--------------------------------------------------------------------------------------------------1555 //--------------------------------------------------------------------------------------------------1564 //--------------------------------------------------------------------------------------------------1572 //--------------------------------------------------------------------------------------------------1581 //--------------------------------------------------------------------------------------------------1589 //--------------------------------------------------------------------------------------------------1598 //--------------------------------------------------------------------------------------------------1606 //--------------------------------------------------------------------------------------------------1615 //--------------------------------------------------------------------------------------------------1623 //--------------------------------------------------------------------------------------------------1632 //--------------------------------------------------------------------------------------------------1640 //--------------------------------------------------------------------------------------------------1649 //--------------------------------------------------------------------------------------------------1662 //--------------------------------------------------------------------------------------------------1675 //--------------------------------------------------------------------------------------------------1677 * This function must be called to ask to the Mobile Network to generate on the remote audio party1688 //--------------------------------------------------------------------------------------------------1699 //--------------------------------------------------------------------------------------------------1707 //--------------------------------------------------------------------------------------------------1716 //--------------------------------------------------------------------------------------------------1727 //--------------------------------------------------------------------------------------------------1736 //--------------------------------------------------------------------------------------------------1744 //--------------------------------------------------------------------------------------------------1753 //--------------------------------------------------------------------------------------------------1763 //--------------------------------------------------------------------------------------------------1772 //--------------------------------------------------------------------------------------------------1782 //--------------------------------------------------------------------------------------------------1791 //--------------------------------------------------------------------------------------------------1801 //--------------------------------------------------------------------------------------------------1810 //--------------------------------------------------------------------------------------------------1825 //--------------------------------------------------------------------------------------------------1834 //--------------------------------------------------------------------------------------------------1848 //--------------------------------------------------------------------------------------------------1857 //--------------------------------------------------------------------------------------------------1865 //--------------------------------------------------------------------------------------------------1871 //--------------------------------------------------------------------------------------------------1879 //--------------------------------------------------------------------------------------------------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:496le_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)void(* le_audio_DtmfDetectorHandlerFunc_t)(le_audio_StreamRef_t streamRef, char dtmf, void *contextPtr)Definition: le_audio_interface.h:644le_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:594AMR Narrowband in 7.4kbps (default value)Definition: le_audio_interface.h:559le_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)le_audio_StreamRef_t le_audio_OpenSpeaker(void)struct le_audio_Connector * le_audio_ConnectorRef_tDefinition: le_audio_interface.h:602le_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:618le_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)void(* le_audio_MediaHandlerFunc_t)(le_audio_StreamRef_t streamRef, le_audio_MediaEvent_t event, void *contextPtr)Definition: le_audio_interface.h:628le_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:354void 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:494le_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:610le_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:479void 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)le_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)