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 file350 //--------------------------------------------------------------------------------------------------354 //--------------------------------------------------------------------------------------------------357 //--------------------------------------------------------------------------------------------------360 * Connect the current client thread to the service providing this API. Block until the service is363 * For each thread that wants to use this API, either ConnectService or TryConnectService must be364 * called before any other functions in this API. Normally, ConnectService is automatically called369 //--------------------------------------------------------------------------------------------------375 //--------------------------------------------------------------------------------------------------378 * Try to connect the current client thread to the service providing this API. Return with an error381 * For each thread that wants to use this API, either ConnectService or TryConnectService must be382 * called before any other functions in this API. Normally, ConnectService is automatically called391 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).394 //--------------------------------------------------------------------------------------------------400 //--------------------------------------------------------------------------------------------------404 * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants407 //--------------------------------------------------------------------------------------------------414 //--------------------------------------------------------------------------------------------------420 * longer a connection to the service, and the functions in this API can't be used. For details, see425 //--------------------------------------------------------------------------------------------------432 //--------------------------------------------------------------------------------------------------436 //--------------------------------------------------------------------------------------------------439 //--------------------------------------------------------------------------------------------------443 //--------------------------------------------------------------------------------------------------446 //--------------------------------------------------------------------------------------------------450 //--------------------------------------------------------------------------------------------------453 //--------------------------------------------------------------------------------------------------457 //--------------------------------------------------------------------------------------------------460 //--------------------------------------------------------------------------------------------------464 //--------------------------------------------------------------------------------------------------467 //--------------------------------------------------------------------------------------------------471 //--------------------------------------------------------------------------------------------------474 //--------------------------------------------------------------------------------------------------478 //--------------------------------------------------------------------------------------------------481 //--------------------------------------------------------------------------------------------------486 //--------------------------------------------------------------------------------------------------489 //--------------------------------------------------------------------------------------------------493 //--------------------------------------------------------------------------------------------------496 //--------------------------------------------------------------------------------------------------501 //--------------------------------------------------------------------------------------------------504 //--------------------------------------------------------------------------------------------------508 //--------------------------------------------------------------------------------------------------511 //--------------------------------------------------------------------------------------------------517 //--------------------------------------------------------------------------------------------------523 //--------------------------------------------------------------------------------------------------529 //--------------------------------------------------------------------------------------------------535 //--------------------------------------------------------------------------------------------------541 //--------------------------------------------------------------------------------------------------547 //--------------------------------------------------------------------------------------------------553 //--------------------------------------------------------------------------------------------------559 //--------------------------------------------------------------------------------------------------565 //--------------------------------------------------------------------------------------------------572 //--------------------------------------------------------------------------------------------------578 //--------------------------------------------------------------------------------------------------585 //--------------------------------------------------------------------------------------------------591 //--------------------------------------------------------------------------------------------------598 //--------------------------------------------------------------------------------------------------604 //--------------------------------------------------------------------------------------------------611 //--------------------------------------------------------------------------------------------------617 //--------------------------------------------------------------------------------------------------623 //--------------------------------------------------------------------------------------------------629 //--------------------------------------------------------------------------------------------------635 //--------------------------------------------------------------------------------------------------641 //--------------------------------------------------------------------------------------------------647 //--------------------------------------------------------------------------------------------------653 //--------------------------------------------------------------------------------------------------659 //--------------------------------------------------------------------------------------------------666 //--------------------------------------------------------------------------------------------------677 //--------------------------------------------------------------------------------------------------681 //--------------------------------------------------------------------------------------------------688 //--------------------------------------------------------------------------------------------------697 //--------------------------------------------------------------------------------------------------704 //--------------------------------------------------------------------------------------------------717 //--------------------------------------------------------------------------------------------------726 //--------------------------------------------------------------------------------------------------738 //--------------------------------------------------------------------------------------------------747 //--------------------------------------------------------------------------------------------------759 //--------------------------------------------------------------------------------------------------766 //--------------------------------------------------------------------------------------------------778 //--------------------------------------------------------------------------------------------------785 //--------------------------------------------------------------------------------------------------791 //--------------------------------------------------------------------------------------------------797 //--------------------------------------------------------------------------------------------------804 //--------------------------------------------------------------------------------------------------811 //--------------------------------------------------------------------------------------------------824 //--------------------------------------------------------------------------------------------------833 //--------------------------------------------------------------------------------------------------840 //--------------------------------------------------------------------------------------------------849 //--------------------------------------------------------------------------------------------------856 //--------------------------------------------------------------------------------------------------867 //--------------------------------------------------------------------------------------------------871 //--------------------------------------------------------------------------------------------------878 //--------------------------------------------------------------------------------------------------889 //--------------------------------------------------------------------------------------------------896 //--------------------------------------------------------------------------------------------------907 //--------------------------------------------------------------------------------------------------914 //--------------------------------------------------------------------------------------------------925 //--------------------------------------------------------------------------------------------------932 //--------------------------------------------------------------------------------------------------943 //--------------------------------------------------------------------------------------------------950 //--------------------------------------------------------------------------------------------------961 //--------------------------------------------------------------------------------------------------970 //--------------------------------------------------------------------------------------------------981 //--------------------------------------------------------------------------------------------------990 //--------------------------------------------------------------------------------------------------1001 //--------------------------------------------------------------------------------------------------1008 //--------------------------------------------------------------------------------------------------1019 //--------------------------------------------------------------------------------------------------1026 //--------------------------------------------------------------------------------------------------1037 //--------------------------------------------------------------------------------------------------1044 //--------------------------------------------------------------------------------------------------1055 //--------------------------------------------------------------------------------------------------1062 //--------------------------------------------------------------------------------------------------1064 * This function must be called to enable the automatic gain control on the selected audio stream.1073 //--------------------------------------------------------------------------------------------------1080 //--------------------------------------------------------------------------------------------------1082 * This function must be called to disable the automatic gain control on the selected audio stream.1091 //--------------------------------------------------------------------------------------------------1098 //--------------------------------------------------------------------------------------------------1107 //--------------------------------------------------------------------------------------------------1114 //--------------------------------------------------------------------------------------------------1123 //--------------------------------------------------------------------------------------------------1130 //--------------------------------------------------------------------------------------------------1139 //--------------------------------------------------------------------------------------------------1146 //--------------------------------------------------------------------------------------------------1155 //--------------------------------------------------------------------------------------------------1162 //--------------------------------------------------------------------------------------------------1171 //--------------------------------------------------------------------------------------------------1178 //--------------------------------------------------------------------------------------------------1184 //--------------------------------------------------------------------------------------------------1190 //--------------------------------------------------------------------------------------------------1196 //--------------------------------------------------------------------------------------------------1202 //--------------------------------------------------------------------------------------------------1208 //--------------------------------------------------------------------------------------------------1214 //--------------------------------------------------------------------------------------------------1220 //--------------------------------------------------------------------------------------------------1226 //--------------------------------------------------------------------------------------------------1232 //--------------------------------------------------------------------------------------------------1238 //--------------------------------------------------------------------------------------------------1253 * thus share file offset. So, once a playback has reached the end of file, the application must1262 //--------------------------------------------------------------------------------------------------1271 //--------------------------------------------------------------------------------------------------1279 * @note The fd is closed by the IPC API. To use again the same pipe, the fd parameter can be set1281 * If the fd as to be kept on its side, the application should duplicate the fd (e.g., using dup() )1286 //--------------------------------------------------------------------------------------------------1295 //--------------------------------------------------------------------------------------------------1304 * @note the fd is closed by the API. To record again the same file, the fd parameter can be set to1306 * If the fd as to be kept on its side, the application should duplicate the fd (e.g., using dup() )1310 //--------------------------------------------------------------------------------------------------1319 //--------------------------------------------------------------------------------------------------1327 * @note The fd is closed by the API. To use again the same pipe, the fd parameter can be set to1329 * If the fd as to be kept on its side, the application should duplicate the fd (e.g., using dup() )1334 //--------------------------------------------------------------------------------------------------1343 //--------------------------------------------------------------------------------------------------1353 //--------------------------------------------------------------------------------------------------1360 //--------------------------------------------------------------------------------------------------1368 //--------------------------------------------------------------------------------------------------1375 //--------------------------------------------------------------------------------------------------1383 //--------------------------------------------------------------------------------------------------1390 //--------------------------------------------------------------------------------------------------1398 //--------------------------------------------------------------------------------------------------1405 //--------------------------------------------------------------------------------------------------1413 //--------------------------------------------------------------------------------------------------1422 //--------------------------------------------------------------------------------------------------1430 //--------------------------------------------------------------------------------------------------1439 //--------------------------------------------------------------------------------------------------1447 //--------------------------------------------------------------------------------------------------1456 //--------------------------------------------------------------------------------------------------1464 //--------------------------------------------------------------------------------------------------1473 //--------------------------------------------------------------------------------------------------1481 //--------------------------------------------------------------------------------------------------1490 //--------------------------------------------------------------------------------------------------1498 //--------------------------------------------------------------------------------------------------1507 //--------------------------------------------------------------------------------------------------1520 //--------------------------------------------------------------------------------------------------1533 //--------------------------------------------------------------------------------------------------1535 * This function must be called to ask to the Mobile Network to generate on the remote audio party1546 //--------------------------------------------------------------------------------------------------1557 //--------------------------------------------------------------------------------------------------1565 //--------------------------------------------------------------------------------------------------1574 //--------------------------------------------------------------------------------------------------1585 //--------------------------------------------------------------------------------------------------1594 //--------------------------------------------------------------------------------------------------1602 //--------------------------------------------------------------------------------------------------1611 //--------------------------------------------------------------------------------------------------1621 //--------------------------------------------------------------------------------------------------1630 //--------------------------------------------------------------------------------------------------1640 //--------------------------------------------------------------------------------------------------1649 //--------------------------------------------------------------------------------------------------1659 //--------------------------------------------------------------------------------------------------1668 //--------------------------------------------------------------------------------------------------1683 //--------------------------------------------------------------------------------------------------1692 //--------------------------------------------------------------------------------------------------1706 //--------------------------------------------------------------------------------------------------1715 //--------------------------------------------------------------------------------------------------1723 //--------------------------------------------------------------------------------------------------1729 //--------------------------------------------------------------------------------------------------1737 //--------------------------------------------------------------------------------------------------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)le_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)le_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)le_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)le_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_FULL_API void le_audio_SetServerDisconnectHandler(le_audio_DisconnectHandler_t disconnectHandler, void *contextPtr)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:355void le_audio_Close(le_audio_StreamRef_t streamRef)le_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)le_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)void 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)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)