Snapdragon® Telematics Application Framework (TelAF) Interface Specification
taf_audio_interface.h
Go to the documentation of this file.
1 
2 
3 /*
4  * ====================== WARNING ======================
5  *
6  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
7  * DO NOT MODIFY IN ANY WAY.
8  *
9  * ====================== WARNING ======================
10  */
11 
291 #ifndef TAF_AUDIO_INTERFACE_H_INCLUDE_GUARD
292 #define TAF_AUDIO_INTERFACE_H_INCLUDE_GUARD
293 
294 
295 #include "legato.h"
296 
297 // Internal includes for this interface
298 #include "taf_audio_common.h"
299 //--------------------------------------------------------------------------------------------------
303 //--------------------------------------------------------------------------------------------------
304 typedef void (*taf_audio_DisconnectHandler_t)(void *);
305 
306 //--------------------------------------------------------------------------------------------------
318 //--------------------------------------------------------------------------------------------------
320 (
321  void
322 );
323 
324 //--------------------------------------------------------------------------------------------------
343 //--------------------------------------------------------------------------------------------------
345 (
346  void
347 );
348 
349 //--------------------------------------------------------------------------------------------------
357 //--------------------------------------------------------------------------------------------------
359 (
360  taf_audio_DisconnectHandler_t disconnectHandler,
361  void *contextPtr
362 );
363 
364 //--------------------------------------------------------------------------------------------------
375 //--------------------------------------------------------------------------------------------------
377 (
378  taf_audio_DisconnectHandler_t disconnectHandler,
379  void *contextPtr
380 );
381 
382 //--------------------------------------------------------------------------------------------------
393 //--------------------------------------------------------------------------------------------------
395 (
396  void
397 );
398 
399 //--------------------------------------------------------------------------------------------------
403 //--------------------------------------------------------------------------------------------------
404 void taf_audio_Close
405 (
408 );
409 
410 //--------------------------------------------------------------------------------------------------
415 //--------------------------------------------------------------------------------------------------
417 (
418  void
419 );
420 
421 //--------------------------------------------------------------------------------------------------
426 //--------------------------------------------------------------------------------------------------
428 (
431 );
432 
433 //--------------------------------------------------------------------------------------------------
442 //--------------------------------------------------------------------------------------------------
444 (
445  taf_audio_ConnectorRef_t connRef,
449 );
450 
451 //--------------------------------------------------------------------------------------------------
457 //--------------------------------------------------------------------------------------------------
459 (
460  taf_audio_ConnectorRef_t connRef,
464 );
465 
466 //--------------------------------------------------------------------------------------------------
472 //--------------------------------------------------------------------------------------------------
474 (
475  void
476 );
477 
478 //--------------------------------------------------------------------------------------------------
484 //--------------------------------------------------------------------------------------------------
486 (
487  void
488 );
489 
490 //--------------------------------------------------------------------------------------------------
496 //--------------------------------------------------------------------------------------------------
498 (
499  uint32_t slotId
501 );
502 
503 //--------------------------------------------------------------------------------------------------
509 //--------------------------------------------------------------------------------------------------
511 (
512  uint32_t slotId
514 );
515 
516 //--------------------------------------------------------------------------------------------------
522 //--------------------------------------------------------------------------------------------------
524 (
525  taf_audio_StreamRef_t streamRef,
527  const char* LE_NONNULL dtmf,
529  uint32_t duration,
531  uint32_t pause
533 );
534 
535 //--------------------------------------------------------------------------------------------------
543 //--------------------------------------------------------------------------------------------------
545 (
546  taf_audio_StreamRef_t streamRef
548 );
549 
550 //--------------------------------------------------------------------------------------------------
558 //--------------------------------------------------------------------------------------------------
560 (
561  taf_audio_StreamRef_t streamRef
563 );
564 
565 //--------------------------------------------------------------------------------------------------
571 //--------------------------------------------------------------------------------------------------
573 (
574  void
575 );
576 
577 //--------------------------------------------------------------------------------------------------
587 //--------------------------------------------------------------------------------------------------
589 (
590  taf_audio_StreamRef_t streamRef,
592  int fd
594 );
595 
596 //--------------------------------------------------------------------------------------------------
602 //--------------------------------------------------------------------------------------------------
604 (
605  void
606 );
607 
608 //--------------------------------------------------------------------------------------------------
618 //--------------------------------------------------------------------------------------------------
620 (
621  taf_audio_StreamRef_t streamRef,
623  int fd
625 );
626 
627 //--------------------------------------------------------------------------------------------------
633 //--------------------------------------------------------------------------------------------------
635 (
636  taf_audio_StreamRef_t streamRef,
638  taf_audio_MediaHandlerFunc_t handlerPtr,
640  void* contextPtr
642 );
643 
644 //--------------------------------------------------------------------------------------------------
648 //--------------------------------------------------------------------------------------------------
650 (
651  taf_audio_MediaHandlerRef_t handlerRef
653 );
654 
655 //--------------------------------------------------------------------------------------------------
661 //--------------------------------------------------------------------------------------------------
663 (
664  taf_audio_StreamRef_t streamRef,
668  void* contextPtr
670 );
671 
672 //--------------------------------------------------------------------------------------------------
676 //--------------------------------------------------------------------------------------------------
678 (
681 );
682 
683 //--------------------------------------------------------------------------------------------------
691 //--------------------------------------------------------------------------------------------------
693 (
694  taf_audio_StreamRef_t streamRef
696 );
697 
698 //--------------------------------------------------------------------------------------------------
706 //--------------------------------------------------------------------------------------------------
708 (
709  taf_audio_StreamRef_t streamRef,
711  int32_t gain
713 );
714 
715 //--------------------------------------------------------------------------------------------------
723 //--------------------------------------------------------------------------------------------------
725 (
726  taf_audio_StreamRef_t streamRef,
728  int32_t* gainPtr
730 );
731 
732 //--------------------------------------------------------------------------------------------------
740 //--------------------------------------------------------------------------------------------------
742 (
743  taf_audio_StreamRef_t streamRef
745 );
746 
747 //--------------------------------------------------------------------------------------------------
755 //--------------------------------------------------------------------------------------------------
757 (
758  taf_audio_StreamRef_t streamRef
760 );
761 
762 //--------------------------------------------------------------------------------------------------
770 //--------------------------------------------------------------------------------------------------
772 (
773  taf_audio_StreamRef_t streamRef
775 );
776 
777 //--------------------------------------------------------------------------------------------------
785 //--------------------------------------------------------------------------------------------------
787 (
788  taf_audio_StreamRef_t streamRef
790 );
791 
792 //--------------------------------------------------------------------------------------------------
800 //--------------------------------------------------------------------------------------------------
802 (
803  taf_audio_StreamRef_t streamRef,
805  bool* statusPtr
807 );
808 
809 //--------------------------------------------------------------------------------------------------
817 //--------------------------------------------------------------------------------------------------
819 (
820  taf_audio_StreamRef_t streamRef,
822  bool* statusPtr
824 );
825 
826 //--------------------------------------------------------------------------------------------------
835 //--------------------------------------------------------------------------------------------------
837 (
840 );
841 
842 //--------------------------------------------------------------------------------------------------
851 //--------------------------------------------------------------------------------------------------
853 (
856 );
857 
858 //--------------------------------------------------------------------------------------------------
867 //--------------------------------------------------------------------------------------------------
869 (
870  uint32_t timeslot
872 );
873 
874 //--------------------------------------------------------------------------------------------------
883 //--------------------------------------------------------------------------------------------------
885 (
886  uint32_t timeslot
888 );
889 
890 //--------------------------------------------------------------------------------------------------
898 //--------------------------------------------------------------------------------------------------
900 (
901  taf_audio_StreamRef_t streamRef,
903  uint32_t rate
905 );
906 
907 //--------------------------------------------------------------------------------------------------
915 //--------------------------------------------------------------------------------------------------
917 (
918  taf_audio_StreamRef_t streamRef,
920  uint32_t* ratePtr
922 );
923 
924 //--------------------------------------------------------------------------------------------------
932 //--------------------------------------------------------------------------------------------------
934 (
935  taf_audio_StreamRef_t streamRef,
937  uint32_t nbChannel
939 );
940 
941 //--------------------------------------------------------------------------------------------------
949 //--------------------------------------------------------------------------------------------------
951 (
952  taf_audio_StreamRef_t streamRef,
954  uint32_t* nbChannelPtr
956 );
957 
958 //--------------------------------------------------------------------------------------------------
966 //--------------------------------------------------------------------------------------------------
968 (
969  taf_audio_StreamRef_t streamRef,
971  taf_audio_Format_t format
973 );
974 
975 //--------------------------------------------------------------------------------------------------
987 //--------------------------------------------------------------------------------------------------
989 (
990  taf_audio_StreamRef_t streamRef,
992  taf_audio_Format_t* formatPtr
994 );
995 
996 #endif // TAF_AUDIO_INTERFACE_H_INCLUDE_GUARD
le_result_t taf_audio_GetGain(taf_audio_StreamRef_t streamRef, int32_t *gainPtr)
Definition: taf_audio_client.c:1014
void taf_audio_RemoveDtmfDetectorHandler(taf_audio_DtmfDetectorHandlerRef_t handlerRef)
Definition: taf_audio_client.c:948
taf_audio_StreamRef_t taf_audio_OpenModemVoiceRx(uint32_t slotId)
Definition: taf_audio_client.c:689
le_result_t taf_audio_SetSamplePcmChannelNumber(taf_audio_StreamRef_t streamRef, uint32_t nbChannel)
Definition: taf_audio_client.c:1306
le_result_t taf_audio_Connect(taf_audio_ConnectorRef_t connRef, taf_audio_StreamRef_t sRef)
Definition: taf_audio_client.c:611
taf_audio_StreamRef_t taf_audio_OpenPcmTx(uint32_t timeslot)
Definition: taf_audio_client.c:1237
taf_audio_StreamRef_t taf_audio_OpenSpeaker(void)
Definition: taf_audio_client.c:655
void taf_audio_ConnectService(void)
Definition: taf_audio_client.c:291
taf_audio_StreamRef_t taf_audio_OpenPlayer(void)
Definition: taf_audio_client.c:797
taf_audio_MediaHandlerRef_t taf_audio_AddMediaHandler(taf_audio_StreamRef_t streamRef, taf_audio_MediaHandlerFunc_t handlerPtr, void *contextPtr)
Definition: taf_audio_client.c:883
taf_audio_StreamRef_t taf_audio_OpenI2sTx(taf_audio_I2SChannel_t mode)
Definition: taf_audio_client.c:1193
struct taf_audio_DtmfDetectorHandler * taf_audio_DtmfDetectorHandlerRef_t
Definition: taf_audio_common.h:81
taf_audio_StreamRef_t taf_audio_OpenModemVoiceTx(uint32_t slotId)
Definition: taf_audio_client.c:708
LE_FULL_API void taf_audio_SetServerDisconnectHandler(taf_audio_DisconnectHandler_t disconnectHandler, void *contextPtr)
Definition: taf_audio_client.c:380
struct taf_audio_Stream * taf_audio_StreamRef_t
Definition: taf_audio_common.h:38
le_result_t taf_audio_Unmute(taf_audio_StreamRef_t streamRef)
Definition: taf_audio_client.c:778
le_result_t taf_audio_Stop(taf_audio_StreamRef_t streamRef)
Definition: taf_audio_client.c:969
struct taf_audio_MediaHandler * taf_audio_MediaHandlerRef_t
Definition: taf_audio_common.h:73
le_result_t taf_audio_SetGain(taf_audio_StreamRef_t streamRef, int32_t gain)
Definition: taf_audio_client.c:990
taf_audio_StreamRef_t taf_audio_OpenMic(void)
Definition: taf_audio_client.c:672
void(* taf_audio_DtmfDetectorHandlerFunc_t)(taf_audio_StreamRef_t streamRef, char dtmf, void *contextPtr)
Definition: taf_audio_common.h:190
taf_audio_StreamRef_t taf_audio_OpenRecorder(void)
Definition: taf_audio_client.c:840
taf_audio_ConnectorRef_t taf_audio_CreateConnector(void)
Definition: taf_audio_client.c:573
void taf_audio_DeleteConnector(taf_audio_ConnectorRef_t connRef)
Definition: taf_audio_client.c:589
le_result_t taf_audio_PlayDtmf(taf_audio_StreamRef_t streamRef, const char *LE_NONNULL dtmf, uint32_t duration, uint32_t pause)
Definition: taf_audio_client.c:727
le_result_t taf_audio_EnableNoiseSuppressor(taf_audio_StreamRef_t streamRef)
Definition: taf_audio_client.c:1038
void(* taf_audio_DisconnectHandler_t)(void *)
Definition: taf_audio_interface.h:304
le_result_t taf_audio_SetEncodingFormat(taf_audio_StreamRef_t streamRef, taf_audio_Format_t format)
Definition: taf_audio_client.c:1354
le_result_t taf_audio_DisableEchoCanceller(taf_audio_StreamRef_t streamRef)
Definition: taf_audio_client.c:1101
void taf_audio_Disconnect(taf_audio_ConnectorRef_t connRef, taf_audio_StreamRef_t sRef)
Definition: taf_audio_client.c:633
void taf_audio_DisconnectService(void)
Definition: taf_audio_client.c:503
le_result_t taf_audio_GetEncodingFormat(taf_audio_StreamRef_t streamRef, taf_audio_Format_t *formatPtr)
Definition: taf_audio_client.c:1382
taf_audio_StreamRef_t taf_audio_OpenI2sRx(taf_audio_I2SChannel_t mode)
Definition: taf_audio_client.c:1171
LE_FULL_API void taf_audio_SetNonExitServerDisconnectHandler(taf_audio_DisconnectHandler_t disconnectHandler, void *contextPtr)
Definition: taf_audio_client.c:457
void taf_audio_Close(taf_audio_StreamRef_t sRef)
Definition: taf_audio_client.c:555
le_result_t taf_audio_SetSamplePcmSamplingRate(taf_audio_StreamRef_t streamRef, uint32_t rate)
Definition: taf_audio_client.c:1258
le_result_t taf_audio_IsEchoCancellerEnabled(taf_audio_StreamRef_t streamRef, bool *statusPtr)
Definition: taf_audio_client.c:1122
void taf_audio_RemoveMediaHandler(taf_audio_MediaHandlerRef_t handlerRef)
Definition: taf_audio_client.c:906
le_result_t taf_audio_DisableNoiseSuppressor(taf_audio_StreamRef_t streamRef)
Definition: taf_audio_client.c:1080
taf_audio_Format_t
Definition: taf_audio_common.h:89
taf_audio_I2SChannel_t
Definition: taf_audio_common.h:153
le_result_t taf_audio_EnableEchoCanceller(taf_audio_StreamRef_t streamRef)
Definition: taf_audio_client.c:1059
le_result_t taf_audio_TryConnectService(void)
Definition: taf_audio_client.c:323
taf_audio_StreamRef_t taf_audio_OpenPcmRx(uint32_t timeslot)
Definition: taf_audio_client.c:1215
void(* taf_audio_MediaHandlerFunc_t)(taf_audio_StreamRef_t streamRef, taf_audio_MediaEvent_t event, void *contextPtr)
Definition: taf_audio_common.h:175
le_result_t taf_audio_GetSamplePcmSamplingRate(taf_audio_StreamRef_t streamRef, uint32_t *ratePtr)
Definition: taf_audio_client.c:1282
le_result_t taf_audio_RecordFile(taf_audio_StreamRef_t streamRef, int fd)
Definition: taf_audio_client.c:861
#define LE_NONNULL
Definition: le_basics.h:368
le_result_t
Definition: le_basics.h:45
le_result_t taf_audio_PlayFile(taf_audio_StreamRef_t streamRef, int fd)
Definition: taf_audio_client.c:818
#define LE_FULL_API
Definition: le_apiFeatures.h:42
struct taf_audio_Connector * taf_audio_ConnectorRef_t
Definition: taf_audio_common.h:46
le_result_t taf_audio_Mute(taf_audio_StreamRef_t streamRef)
Definition: taf_audio_client.c:757
le_result_t taf_audio_IsNoiseSuppressorEnabled(taf_audio_StreamRef_t streamRef, bool *statusPtr)
Definition: taf_audio_client.c:1146
le_result_t taf_audio_GetSamplePcmChannelNumber(taf_audio_StreamRef_t streamRef, uint32_t *nbChannelPtr)
Definition: taf_audio_client.c:1330
taf_audio_DtmfDetectorHandlerRef_t taf_audio_AddDtmfDetectorHandler(taf_audio_StreamRef_t streamRef, taf_audio_DtmfDetectorHandlerFunc_t handlerPtr, void *contextPtr)
Definition: taf_audio_client.c:925