le_audio_interface.h
Go to the documentation of this file.
50 * An audio profile can be retrieved with le_audio_GetProfile() and set with le_audio_SetProfile().52 * Then, the following functions let you enable or disable the audio settings on the selected audio58 * - le_audio_EnableIirFilter()/ le_audio_DisableIirFilter(): downlink IIR Filter (Infinite Impulse66 * To configure the encoding format, use le_audio_GetEncodingFormat() and le_audio_SetEncodingFormat().72 * - le_audio_GetPcmSamplingResolution() and le_audio_SetPcmSamplingResolution() for bit/sample settings.74 * - le_audio_GetSamplePcmChannelNumber() and le_audio_SetSamplePcmChannelNumber() for channel numbers.100 * - le_audio_OpenModemVoiceRx(): returns an Audio Stream Reference of the digitized audio signal103 * - le_audio_OpenModemVoiceTx(): returns an Audio Stream Reference of the digitized audio signal128 * On most platforms, it only allocates a context in memory. The audio path becomes active when the134 * Once the users get an Audio Stream reference, they can control it with the following functions:143 * @note Multimedia (playback and recording) must be controlled separately from the main audio path145 * muting/unmuting the multimedia stream, and not the other connected stream. For example, in case155 * - le_audio_SetPlatformSpecificGain(): adjust the value of a platform specific gain in the audio180 * A sample code that implements audio connectors and audio streams during voice call can be found in184 * In particular, a connector using Modem Voice Rx or Tx interfaces has to be created before dialing201 * - AMR_NB (AMR Narrowband) codec that encodes narrowband (200--3400 Hz) signals at variable bit203 * - AMR-WB (AMR Wideband) is an ITU-T standard speech codec which improved speech quality due to a230 * "I2S Rx", "Modem Voice Tx" and "Recorder" must be previously connected before recording a file.261 * - The playback/record stops playing/recording, and the read/write position indicator associated262 * with the file stream is rewound to the beginning of the file. A new file can be played/recorded264 * - le_audio_Pause(): can be called to pause a play/record. The file playing/recording is put on279 * @note The @c LE_AUDIO_MEDIA_NO_MORE_SAMPLES event indicates when all samples put into the pipe282 * A sample code that implements audio playback and capture can be found in \b audioPlaybackRec.c287 * The le_audio_PlayDtmf() function allows the application to play one or several DTMF on a playback288 * stream. The duration and the pause of the DTMFs must also be specified with the input parameters.290 * The le_audio_PlaySignallingDtmf() function allows the application to ask the Mobile Network to292 * le_audio_PlaySignallingDtmf() function may offer a better signal quality, but the the duration295 * The application must register a handler function to detect incoming DTMF characters on a specific296 * input audio stream. The le_audio_AddDtmfDetectorHandler() function installs a handler for DTMF305 * A sample code that implements DTMF playback and decoding can be found in \b audioDtmfTest.c file342 //--------------------------------------------------------------------------------------------------346 //--------------------------------------------------------------------------------------------------349 //--------------------------------------------------------------------------------------------------352 * Connect the current client thread to the service providing this API. Block until the service is355 * For each thread that wants to use this API, either ConnectService or TryConnectService must be356 * called before any other functions in this API. Normally, ConnectService is automatically called361 //--------------------------------------------------------------------------------------------------367 //--------------------------------------------------------------------------------------------------370 * Try to connect the current client thread to the service providing this API. Return with an error373 * For each thread that wants to use this API, either ConnectService or TryConnectService must be374 * called before any other functions in this API. Normally, ConnectService is automatically called383 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).386 //--------------------------------------------------------------------------------------------------392 //--------------------------------------------------------------------------------------------------396 * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants399 //--------------------------------------------------------------------------------------------------406 //--------------------------------------------------------------------------------------------------412 * longer a connection to the service, and the functions in this API can't be used. For details, see417 //--------------------------------------------------------------------------------------------------424 //--------------------------------------------------------------------------------------------------428 //--------------------------------------------------------------------------------------------------431 //--------------------------------------------------------------------------------------------------436 //--------------------------------------------------------------------------------------------------439 //--------------------------------------------------------------------------------------------------443 //--------------------------------------------------------------------------------------------------446 //--------------------------------------------------------------------------------------------------450 //--------------------------------------------------------------------------------------------------453 //--------------------------------------------------------------------------------------------------458 //--------------------------------------------------------------------------------------------------461 //--------------------------------------------------------------------------------------------------465 //--------------------------------------------------------------------------------------------------480 //--------------------------------------------------------------------------------------------------484 //--------------------------------------------------------------------------------------------------497 //--------------------------------------------------------------------------------------------------501 //--------------------------------------------------------------------------------------------------518 //--------------------------------------------------------------------------------------------------522 //--------------------------------------------------------------------------------------------------535 //--------------------------------------------------------------------------------------------------539 //--------------------------------------------------------------------------------------------------582 //--------------------------------------------------------------------------------------------------586 //--------------------------------------------------------------------------------------------------590 //--------------------------------------------------------------------------------------------------594 //--------------------------------------------------------------------------------------------------598 //--------------------------------------------------------------------------------------------------602 //--------------------------------------------------------------------------------------------------606 //--------------------------------------------------------------------------------------------------610 //--------------------------------------------------------------------------------------------------614 //--------------------------------------------------------------------------------------------------619 //--------------------------------------------------------------------------------------------------621 (630 //--------------------------------------------------------------------------------------------------635 //--------------------------------------------------------------------------------------------------637 (646 //--------------------------------------------------------------------------------------------------652 //--------------------------------------------------------------------------------------------------658 //--------------------------------------------------------------------------------------------------664 //--------------------------------------------------------------------------------------------------670 //--------------------------------------------------------------------------------------------------676 //--------------------------------------------------------------------------------------------------682 //--------------------------------------------------------------------------------------------------688 //--------------------------------------------------------------------------------------------------694 //--------------------------------------------------------------------------------------------------700 //--------------------------------------------------------------------------------------------------707 //--------------------------------------------------------------------------------------------------713 //--------------------------------------------------------------------------------------------------720 //--------------------------------------------------------------------------------------------------726 //--------------------------------------------------------------------------------------------------733 //--------------------------------------------------------------------------------------------------739 //--------------------------------------------------------------------------------------------------746 //--------------------------------------------------------------------------------------------------752 //--------------------------------------------------------------------------------------------------758 //--------------------------------------------------------------------------------------------------764 //--------------------------------------------------------------------------------------------------770 //--------------------------------------------------------------------------------------------------776 //--------------------------------------------------------------------------------------------------782 //--------------------------------------------------------------------------------------------------788 //--------------------------------------------------------------------------------------------------794 //--------------------------------------------------------------------------------------------------801 //--------------------------------------------------------------------------------------------------812 //--------------------------------------------------------------------------------------------------816 //--------------------------------------------------------------------------------------------------823 //--------------------------------------------------------------------------------------------------832 //--------------------------------------------------------------------------------------------------839 //--------------------------------------------------------------------------------------------------851 //--------------------------------------------------------------------------------------------------860 //--------------------------------------------------------------------------------------------------871 //--------------------------------------------------------------------------------------------------880 //--------------------------------------------------------------------------------------------------891 //--------------------------------------------------------------------------------------------------898 //--------------------------------------------------------------------------------------------------909 //--------------------------------------------------------------------------------------------------916 //--------------------------------------------------------------------------------------------------922 //--------------------------------------------------------------------------------------------------928 //--------------------------------------------------------------------------------------------------935 //--------------------------------------------------------------------------------------------------942 //--------------------------------------------------------------------------------------------------954 //--------------------------------------------------------------------------------------------------963 //--------------------------------------------------------------------------------------------------970 //--------------------------------------------------------------------------------------------------979 //--------------------------------------------------------------------------------------------------986 //--------------------------------------------------------------------------------------------------997 //--------------------------------------------------------------------------------------------------1001 //--------------------------------------------------------------------------------------------------1008 //--------------------------------------------------------------------------------------------------1017 //--------------------------------------------------------------------------------------------------1024 //--------------------------------------------------------------------------------------------------1033 //--------------------------------------------------------------------------------------------------1040 //--------------------------------------------------------------------------------------------------1049 //--------------------------------------------------------------------------------------------------1056 //--------------------------------------------------------------------------------------------------1065 //--------------------------------------------------------------------------------------------------1072 //--------------------------------------------------------------------------------------------------1082 //--------------------------------------------------------------------------------------------------1091 //--------------------------------------------------------------------------------------------------1101 //--------------------------------------------------------------------------------------------------1110 //--------------------------------------------------------------------------------------------------1119 //--------------------------------------------------------------------------------------------------1126 //--------------------------------------------------------------------------------------------------1135 //--------------------------------------------------------------------------------------------------1142 //--------------------------------------------------------------------------------------------------1151 //--------------------------------------------------------------------------------------------------1158 //--------------------------------------------------------------------------------------------------1167 //--------------------------------------------------------------------------------------------------1174 //--------------------------------------------------------------------------------------------------1176 * This function must be called to enable the automatic gain control on the selected audio stream.1183 //--------------------------------------------------------------------------------------------------1190 //--------------------------------------------------------------------------------------------------1192 * This function must be called to disable the automatic gain control on the selected audio stream.1199 //--------------------------------------------------------------------------------------------------1206 //--------------------------------------------------------------------------------------------------1214 //--------------------------------------------------------------------------------------------------1221 //--------------------------------------------------------------------------------------------------1229 //--------------------------------------------------------------------------------------------------1236 //--------------------------------------------------------------------------------------------------1245 //--------------------------------------------------------------------------------------------------1252 //--------------------------------------------------------------------------------------------------1261 //--------------------------------------------------------------------------------------------------1268 //--------------------------------------------------------------------------------------------------1277 //--------------------------------------------------------------------------------------------------1284 //--------------------------------------------------------------------------------------------------1290 //--------------------------------------------------------------------------------------------------1296 //--------------------------------------------------------------------------------------------------1302 //--------------------------------------------------------------------------------------------------1308 //--------------------------------------------------------------------------------------------------1314 //--------------------------------------------------------------------------------------------------1320 //--------------------------------------------------------------------------------------------------1326 //--------------------------------------------------------------------------------------------------1332 //--------------------------------------------------------------------------------------------------1338 //--------------------------------------------------------------------------------------------------1344 //--------------------------------------------------------------------------------------------------1359 * thus share file offset. So, once a playback has reached the end of file, the application must1368 //--------------------------------------------------------------------------------------------------1377 //--------------------------------------------------------------------------------------------------1385 * @note The fd is closed by the IPC API. To use again the same pipe, the fd parameter can be set1387 * If the fd as to be kept on its side, the application should duplicate the fd (e.g., using dup() )1392 //--------------------------------------------------------------------------------------------------1401 //--------------------------------------------------------------------------------------------------1410 * @note the fd is closed by the API. To record again the same file, the fd parameter can be set to1412 * If the fd as to be kept on its side, the application should duplicate the fd (e.g., using dup() )1416 //--------------------------------------------------------------------------------------------------1425 //--------------------------------------------------------------------------------------------------1433 * @note The fd is closed by the API. To use again the same pipe, the fd parameter can be set to1435 * If the fd as to be kept on its side, the application should duplicate the fd (e.g., using dup() )1440 //--------------------------------------------------------------------------------------------------1449 //--------------------------------------------------------------------------------------------------1459 //--------------------------------------------------------------------------------------------------1466 //--------------------------------------------------------------------------------------------------1474 //--------------------------------------------------------------------------------------------------1481 //--------------------------------------------------------------------------------------------------1489 //--------------------------------------------------------------------------------------------------1496 //--------------------------------------------------------------------------------------------------1504 //--------------------------------------------------------------------------------------------------1511 //--------------------------------------------------------------------------------------------------1519 //--------------------------------------------------------------------------------------------------1528 //--------------------------------------------------------------------------------------------------1536 //--------------------------------------------------------------------------------------------------1545 //--------------------------------------------------------------------------------------------------1553 //--------------------------------------------------------------------------------------------------1562 //--------------------------------------------------------------------------------------------------1570 //--------------------------------------------------------------------------------------------------1579 //--------------------------------------------------------------------------------------------------1587 //--------------------------------------------------------------------------------------------------1596 //--------------------------------------------------------------------------------------------------1604 //--------------------------------------------------------------------------------------------------1613 //--------------------------------------------------------------------------------------------------1626 //--------------------------------------------------------------------------------------------------1639 //--------------------------------------------------------------------------------------------------1641 * This function must be called to ask to the Mobile Network to generate on the remote audio party1652 //--------------------------------------------------------------------------------------------------1663 //--------------------------------------------------------------------------------------------------1671 //--------------------------------------------------------------------------------------------------1680 //--------------------------------------------------------------------------------------------------1691 //--------------------------------------------------------------------------------------------------1700 //--------------------------------------------------------------------------------------------------1708 //--------------------------------------------------------------------------------------------------1717 //--------------------------------------------------------------------------------------------------1727 //--------------------------------------------------------------------------------------------------1736 //--------------------------------------------------------------------------------------------------1744 //--------------------------------------------------------------------------------------------------1753 //--------------------------------------------------------------------------------------------------1761 //--------------------------------------------------------------------------------------------------1770 //--------------------------------------------------------------------------------------------------1781 //--------------------------------------------------------------------------------------------------1790 //--------------------------------------------------------------------------------------------------1800 //--------------------------------------------------------------------------------------------------1809 //--------------------------------------------------------------------------------------------------1816 //--------------------------------------------------------------------------------------------------1822 //--------------------------------------------------------------------------------------------------1829 //--------------------------------------------------------------------------------------------------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:489le_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:587AMR Narrowband in 7.4kbps (default value)Definition: le_audio_interface.h:552le_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:637le_audio_StreamRef_t le_audio_OpenSpeaker(void)struct le_audio_Connector * le_audio_ConnectorRef_tDefinition: le_audio_interface.h:595le_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:611le_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:347void 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:487le_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:603le_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:472void 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:621le_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)