Snapdragon® Telematics Application Framework (TelAF) Interface Specification
Macros | Typedefs | Enumerations | Functions
taf_audio_common.h File Reference
#include "legato.h"

Go to the source code of this file.

Macros

#define IFGEN_TAF_AUDIO_PROTOCOL_ID   "f57414d573e5db3c9de28d2cfb55097d"
 
#define IFGEN_TAF_AUDIO_MSG_SIZE   124
 
#define TAF_AUDIO_DTMF_MAXLEN   100
 
#define TAF_AUDIO_NO_FD   -1
 

Typedefs

typedef struct taf_audio_Stream * taf_audio_StreamRef_t
 
typedef struct taf_audio_Connector * taf_audio_ConnectorRef_t
 
typedef struct taf_audio_MediaHandler * taf_audio_MediaHandlerRef_t
 
typedef struct taf_audio_DtmfDetectorHandler * taf_audio_DtmfDetectorHandlerRef_t
 
typedef void(* taf_audio_MediaHandlerFunc_t) (taf_audio_StreamRef_t streamRef, taf_audio_MediaEvent_t event, void *contextPtr)
 
typedef void(* taf_audio_DtmfDetectorHandlerFunc_t) (taf_audio_StreamRef_t streamRef, char dtmf, void *contextPtr)
 

Enumerations

enum  taf_audio_MediaEvent_t { TAF_AUDIO_MEDIA_ENDED = 0, TAF_AUDIO_MEDIA_NO_MORE_SAMPLES = 1, TAF_AUDIO_MEDIA_ERROR = 2, TAF_AUDIO_MEDIA_MAX = 3 }
 
enum  taf_audio_Format_t { TAF_AUDIO_WAVE = 0, TAF_AUDIO_AMR = 1, TAF_AUDIO_FORMAT_MAX = 2 }
 
enum  taf_audio_AmrMode_t {
  TAF_AUDIO_AMR_NONE = 0, TAF_AUDIO_AMR_NB_4_75_KBPS = 1, TAF_AUDIO_AMR_NB_5_15_KBPS = 2, TAF_AUDIO_AMR_NB_5_9_KBPS = 3,
  TAF_AUDIO_AMR_NB_6_7_KBPS = 4, TAF_AUDIO_AMR_NB_7_4_KBPS = 5, TAF_AUDIO_AMR_NB_7_95_KBPS = 6, TAF_AUDIO_AMR_NB_10_2_KBPS = 7,
  TAF_AUDIO_AMR_NB_12_2_KBPS = 8, TAF_AUDIO_AMR_WB_6_6_KBPS = 9, TAF_AUDIO_AMR_WB_8_85_KBPS = 10, TAF_AUDIO_AMR_WB_12_65_KBPS = 11,
  TAF_AUDIO_AMR_WB_14_25_KBPS = 12, TAF_AUDIO_AMR_WB_15_85_KBPS = 13, TAF_AUDIO_AMR_WB_18_25_KBPS = 14, TAF_AUDIO_AMR_WB_19_85_KBPS = 15,
  TAF_AUDIO_AMR_WB_23_05_KBPS = 16, TAF_AUDIO_AMR_WB_23_85_KBPS = 17
}
 
enum  taf_audio_I2SChannel_t {
  TAF_AUDIO_I2S_LEFT = 0, TAF_AUDIO_I2S_RIGHT = 1, TAF_AUDIO_I2S_MONO = 2, TAF_AUDIO_I2S_STEREO = 3,
  TAF_AUDIO_I2S_REVERSE = 4
}
 

Functions

LE_SHARED bool ifgen_taf_audio_HasLocalBinding (void)
 
LE_SHARED void ifgen_taf_audio_InitCommonData (void)
 
LE_SHARED void ifgen_taf_audio_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_audio_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
 
LE_SHARED void ifgen_taf_audio_Close (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t sRef)
 
LE_SHARED taf_audio_ConnectorRef_t ifgen_taf_audio_CreateConnector (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED void ifgen_taf_audio_DeleteConnector (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_ConnectorRef_t connRef)
 
LE_SHARED le_result_t ifgen_taf_audio_Connect (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_ConnectorRef_t connRef, taf_audio_StreamRef_t sRef)
 
LE_SHARED void ifgen_taf_audio_Disconnect (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_ConnectorRef_t connRef, taf_audio_StreamRef_t sRef)
 
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenSpeaker (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenMic (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenModemVoiceRx (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t slotId)
 
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenModemVoiceTx (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t slotId)
 
LE_SHARED le_result_t ifgen_taf_audio_PlayDtmf (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, const char *LE_NONNULL dtmf, uint32_t duration, uint32_t pause)
 
LE_SHARED le_result_t ifgen_taf_audio_Mute (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef)
 
LE_SHARED le_result_t ifgen_taf_audio_Unmute (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef)
 
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenPlayer (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_audio_PlayFile (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, int fd)
 
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenRecorder (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_audio_RecordFile (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, int fd)
 
LE_SHARED taf_audio_MediaHandlerRef_t ifgen_taf_audio_AddMediaHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, taf_audio_MediaHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_audio_RemoveMediaHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_MediaHandlerRef_t handlerRef)
 
LE_SHARED taf_audio_DtmfDetectorHandlerRef_t ifgen_taf_audio_AddDtmfDetectorHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, taf_audio_DtmfDetectorHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_audio_RemoveDtmfDetectorHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_DtmfDetectorHandlerRef_t handlerRef)
 
LE_SHARED le_result_t ifgen_taf_audio_Stop (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef)
 
LE_SHARED le_result_t ifgen_taf_audio_SetGain (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, int32_t gain)
 
LE_SHARED le_result_t ifgen_taf_audio_GetGain (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, int32_t *gainPtr)
 
LE_SHARED le_result_t ifgen_taf_audio_EnableNoiseSuppressor (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef)
 
LE_SHARED le_result_t ifgen_taf_audio_EnableEchoCanceller (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef)
 
LE_SHARED le_result_t ifgen_taf_audio_DisableNoiseSuppressor (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef)
 
LE_SHARED le_result_t ifgen_taf_audio_DisableEchoCanceller (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef)
 
LE_SHARED le_result_t ifgen_taf_audio_IsEchoCancellerEnabled (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, bool *statusPtr)
 
LE_SHARED le_result_t ifgen_taf_audio_IsNoiseSuppressorEnabled (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, bool *statusPtr)
 
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenI2sRx (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_I2SChannel_t mode)
 
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenI2sTx (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_I2SChannel_t mode)
 
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenPcmRx (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t timeslot)
 
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenPcmTx (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t timeslot)
 
LE_SHARED le_result_t ifgen_taf_audio_SetSamplePcmSamplingRate (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, uint32_t rate)
 
LE_SHARED le_result_t ifgen_taf_audio_GetSamplePcmSamplingRate (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, uint32_t *ratePtr)
 
LE_SHARED le_result_t ifgen_taf_audio_SetSamplePcmChannelNumber (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, uint32_t nbChannel)
 
LE_SHARED le_result_t ifgen_taf_audio_GetSamplePcmChannelNumber (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, uint32_t *nbChannelPtr)
 
LE_SHARED le_result_t ifgen_taf_audio_SetEncodingFormat (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, taf_audio_Format_t format)
 
LE_SHARED le_result_t ifgen_taf_audio_GetEncodingFormat (le_msg_SessionRef_t _ifgen_sessionRef, taf_audio_StreamRef_t streamRef, taf_audio_Format_t *formatPtr)
 

Macro Definition Documentation

◆ IFGEN_TAF_AUDIO_PROTOCOL_ID

#define IFGEN_TAF_AUDIO_PROTOCOL_ID   "f57414d573e5db3c9de28d2cfb55097d"

◆ IFGEN_TAF_AUDIO_MSG_SIZE

#define IFGEN_TAF_AUDIO_MSG_SIZE   124

◆ TAF_AUDIO_DTMF_MAXLEN

#define TAF_AUDIO_DTMF_MAXLEN   100

◆ TAF_AUDIO_NO_FD

#define TAF_AUDIO_NO_FD   -1

Typedef Documentation

◆ taf_audio_StreamRef_t

typedef struct taf_audio_Stream* taf_audio_StreamRef_t

Reference type for audio stream.

◆ taf_audio_ConnectorRef_t

typedef struct taf_audio_Connector* taf_audio_ConnectorRef_t

Reference type for audio connector.

◆ taf_audio_MediaHandlerRef_t

typedef struct taf_audio_MediaHandler* taf_audio_MediaHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_audio_Media'

◆ taf_audio_DtmfDetectorHandlerRef_t

typedef struct taf_audio_DtmfDetectorHandler* taf_audio_DtmfDetectorHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_audio_DtmfDetector'

◆ taf_audio_MediaHandlerFunc_t

typedef void(* taf_audio_MediaHandlerFunc_t) (taf_audio_StreamRef_t streamRef, taf_audio_MediaEvent_t event, void *contextPtr)

Handler for audio stream event.

◆ taf_audio_DtmfDetectorHandlerFunc_t

typedef void(* taf_audio_DtmfDetectorHandlerFunc_t) (taf_audio_StreamRef_t streamRef, char dtmf, void *contextPtr)

Handler for DTMF decoding.

Enumeration Type Documentation

◆ taf_audio_MediaEvent_t

enum taf_audio_MediaEvent_t

Audio recording/playback events.

Enumerator
TAF_AUDIO_MEDIA_ENDED 

End of playback.

TAF_AUDIO_MEDIA_NO_MORE_SAMPLES 

End of sample.

TAF_AUDIO_MEDIA_ERROR 

Error notification.

TAF_AUDIO_MEDIA_MAX 

Indicates the maximum value.

◆ taf_audio_Format_t

enum taf_audio_Format_t

Audio format.

Enumerator
TAF_AUDIO_WAVE 

Waveform.

TAF_AUDIO_AMR 

Adaptive multi rate.

TAF_AUDIO_FORMAT_MAX 

Indicates the maximum value.

◆ taf_audio_AmrMode_t

enum taf_audio_AmrMode_t

AMR .

Enumerator
TAF_AUDIO_AMR_NONE 

No modes.

TAF_AUDIO_AMR_NB_4_75_KBPS 

4.75 kbps

TAF_AUDIO_AMR_NB_5_15_KBPS 

5.15 kbps

TAF_AUDIO_AMR_NB_5_9_KBPS 

5.9 kbps

TAF_AUDIO_AMR_NB_6_7_KBPS 

6.7 kbps

TAF_AUDIO_AMR_NB_7_4_KBPS 

7.4 kbps

TAF_AUDIO_AMR_NB_7_95_KBPS 

7.95 kbps

TAF_AUDIO_AMR_NB_10_2_KBPS 

10.2 kbps

TAF_AUDIO_AMR_NB_12_2_KBPS 

12.2 kbps

TAF_AUDIO_AMR_WB_6_6_KBPS 

6.6 kbps

TAF_AUDIO_AMR_WB_8_85_KBPS 

8.85 kbps

TAF_AUDIO_AMR_WB_12_65_KBPS 

12.65 kbps

TAF_AUDIO_AMR_WB_14_25_KBPS 

14.25 kbps

TAF_AUDIO_AMR_WB_15_85_KBPS 

15.85 kbps

TAF_AUDIO_AMR_WB_18_25_KBPS 

18.25 kbps

TAF_AUDIO_AMR_WB_19_85_KBPS 

19.85 kbps

TAF_AUDIO_AMR_WB_23_05_KBPS 

23.05 kbps

TAF_AUDIO_AMR_WB_23_85_KBPS 

23.85 kbps

◆ taf_audio_I2SChannel_t

enum taf_audio_I2SChannel_t

I2S channel mode.

Enumerator
TAF_AUDIO_I2S_LEFT 

Left channel.

TAF_AUDIO_I2S_RIGHT 

Right channel.

TAF_AUDIO_I2S_MONO 

Mono mode.

TAF_AUDIO_I2S_STEREO 

Stereo mode.

TAF_AUDIO_I2S_REVERSE 

Reverse mode (left and right reversed).

Function Documentation

◆ ifgen_taf_audio_HasLocalBinding()

LE_SHARED bool ifgen_taf_audio_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_taf_audio_InitCommonData()

LE_SHARED void ifgen_taf_audio_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_taf_audio_CleanupCommonData()

LE_SHARED void ifgen_taf_audio_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_taf_audio_OpenSession()

LE_SHARED le_result_t ifgen_taf_audio_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session

◆ ifgen_taf_audio_Close()

LE_SHARED void ifgen_taf_audio_Close ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  sRef 
)

Closes the stream reference.

Parameters
[in]sRefAudio stream reference.

◆ ifgen_taf_audio_CreateConnector()

LE_SHARED taf_audio_ConnectorRef_t ifgen_taf_audio_CreateConnector ( le_msg_SessionRef_t  _ifgen_sessionRef)

Creates a new connector.

Returns
Reference to the audio stream, NULL on error.

◆ ifgen_taf_audio_DeleteConnector()

LE_SHARED void ifgen_taf_audio_DeleteConnector ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_ConnectorRef_t  connRef 
)

Deletes a connected connector.

Note
This function will not return if passed a bad reference.
Parameters
[in]connRefConnector reference.

◆ ifgen_taf_audio_Connect()

LE_SHARED le_result_t ifgen_taf_audio_Connect ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_ConnectorRef_t  connRef,
taf_audio_StreamRef_t  sRef 
)

Connects a connector for an audio stream reference.

Returns
  • LE_OK Success.
  • LE_FAULT Failure.
Note
This function will not return if passed a bad reference.
Parameters
[in]connRefConnector reference.
[in]sRefAudio stream reference.

◆ ifgen_taf_audio_Disconnect()

LE_SHARED void ifgen_taf_audio_Disconnect ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_ConnectorRef_t  connRef,
taf_audio_StreamRef_t  sRef 
)

Disconnects a connector for an audio stream reference.

Note
This function will not return if passed a bad reference.
Parameters
[in]connRefConnector reference.
[in]sRefAudio stream reference.

◆ ifgen_taf_audio_OpenSpeaker()

LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenSpeaker ( le_msg_SessionRef_t  _ifgen_sessionRef)

Opens an audio stream reference for speaker use.

Returns
Reference to the audio stream, NULL on error.

◆ ifgen_taf_audio_OpenMic()

LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenMic ( le_msg_SessionRef_t  _ifgen_sessionRef)

Opens an audio stream reference for microphone use.

Returns
Reference to an audio stream, NULL on error.

◆ ifgen_taf_audio_OpenModemVoiceRx()

LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenModemVoiceRx ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint32_t  slotId 
)

Opens an audio stream reference for voice Rx.

Returns
Reference to an audio stream, NULL on error.
Parameters
[in]slotIdSlot value

◆ ifgen_taf_audio_OpenModemVoiceTx()

LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenModemVoiceTx ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint32_t  slotId 
)

Opens an audio stream reference for voice Tx.

Returns
Reference to an audio stream, NULL on error.
Parameters
[in]slotIdSlot value.

◆ ifgen_taf_audio_PlayDtmf()

LE_SHARED le_result_t ifgen_taf_audio_PlayDtmf ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
const char *LE_NONNULL  dtmf,
uint32_t  duration,
uint32_t  pause 
)

DTMF playback for inband.

Note
Applicable only for voice streams.
Parameters
[in]streamRefAudio stream reference.
[in]dtmfDTMF data.
[in]durationDuration to play.
[in]pausePause between tones.

◆ ifgen_taf_audio_Mute()

LE_SHARED le_result_t ifgen_taf_audio_Mute ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef 
)

Mutes an audio stream.

Returns
  • LE_OK Success.
  • LE_FAULT Failure.
Parameters
[in]streamRefAudio stream reference.

◆ ifgen_taf_audio_Unmute()

LE_SHARED le_result_t ifgen_taf_audio_Unmute ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef 
)

Unmutes an audio stream.

Returns
  • LE_OK Success.
  • LE_FAULT Failure.
Parameters
[in]streamRefAudio stream reference.

◆ ifgen_taf_audio_OpenPlayer()

LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenPlayer ( le_msg_SessionRef_t  _ifgen_sessionRef)

Opens a stream for audio playback.

Returns
Reference to an audio stream, NULL on error.

◆ ifgen_taf_audio_PlayFile()

LE_SHARED le_result_t ifgen_taf_audio_PlayFile ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
int  fd 
)

Plays a file on a playback stream.

Returns
  • LE_FAULT Failure.
  • LE_BAD_PARAMETER Invalid stream reference.
  • LE_BUSY Already active.
  • LE_OK Success.
Parameters
[in]streamRefAudio stream reference.
[in]fdFile descriptor.

◆ ifgen_taf_audio_OpenRecorder()

LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenRecorder ( le_msg_SessionRef_t  _ifgen_sessionRef)

Opens the audio stream for recording.

Returns
Reference to an audio stream, NULL on error.

◆ ifgen_taf_audio_RecordFile()

LE_SHARED le_result_t ifgen_taf_audio_RecordFile ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
int  fd 
)

Records a file on the recorder stream.

Returns
  • LE_FAULT Failure.
  • LE_BAD_PARAMETER Invalid stream reference.
  • LE_BUSY Already active.
  • LE_OK Success.
Parameters
[in]streamRefAudio stream reference.
[in]fdFile descriptor.

◆ ifgen_taf_audio_AddMediaHandler()

LE_SHARED taf_audio_MediaHandlerRef_t ifgen_taf_audio_AddMediaHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
taf_audio_MediaHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_audio_Media'

This event provides information on player/recorder stream events.

Parameters
[in]streamRefAudio stream reference.
[in]handlerPtrMedia handler.
[in]contextPtr

◆ ifgen_taf_audio_RemoveMediaHandler()

LE_SHARED void ifgen_taf_audio_RemoveMediaHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_MediaHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_audio_Media'

Parameters
[in]handlerRef

◆ ifgen_taf_audio_AddDtmfDetectorHandler()

LE_SHARED taf_audio_DtmfDetectorHandlerRef_t ifgen_taf_audio_AddDtmfDetectorHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
taf_audio_DtmfDetectorHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_audio_DtmfDetector'

This event provides information on DTMF decoding for the specified streamRef.

Parameters
[in]streamRefAudio stream reference.
[in]handlerPtrDTMF Handler.
[in]contextPtr

◆ ifgen_taf_audio_RemoveDtmfDetectorHandler()

LE_SHARED void ifgen_taf_audio_RemoveDtmfDetectorHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_DtmfDetectorHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_audio_DtmfDetector'

Parameters
[in]handlerRef

◆ ifgen_taf_audio_Stop()

LE_SHARED le_result_t ifgen_taf_audio_Stop ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef 
)

Stops the file playback or recording.

Returns
  • LE_OK Success.
  • LE_FAULT Failure.
Parameters
[in]streamRefAudio stream reference.

◆ ifgen_taf_audio_SetGain()

LE_SHARED le_result_t ifgen_taf_audio_SetGain ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
int32_t  gain 
)

Sets the volume.

Returns
  • LE_FAULT Failure.
  • LE_OK Success.
Parameters
[in]streamRefAudio stream reference.
[in]gainSet gain parameter.

◆ ifgen_taf_audio_GetGain()

LE_SHARED le_result_t ifgen_taf_audio_GetGain ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
int32_t *  gainPtr 
)

Gets the volume.

Returns
  • LE_FAULT Failure.
  • LE_OK Success.
Parameters
[in]streamRefAudio stream reference.
[out]gainPtrGain parameter.

◆ ifgen_taf_audio_EnableNoiseSuppressor()

LE_SHARED le_result_t ifgen_taf_audio_EnableNoiseSuppressor ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef 
)

Enables noise suppression.

Returns
  • LE_FAULT Failure.
  • LE_OK Success.
Parameters
[in]streamRefAudio stream reference.

◆ ifgen_taf_audio_EnableEchoCanceller()

LE_SHARED le_result_t ifgen_taf_audio_EnableEchoCanceller ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef 
)

Enables echo cancellation.

Returns
  • LE_FAULT Failure.
  • LE_OK Success.
Parameters
[in]streamRefAudio stream reference.

◆ ifgen_taf_audio_DisableNoiseSuppressor()

LE_SHARED le_result_t ifgen_taf_audio_DisableNoiseSuppressor ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef 
)

Disables noise suppression.

Returns
  • LE_FAULT Failure.
  • LE_OK Success.
Parameters
[in]streamRefAudio stream reference.

◆ ifgen_taf_audio_DisableEchoCanceller()

LE_SHARED le_result_t ifgen_taf_audio_DisableEchoCanceller ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef 
)

Sets the volume.

Returns
  • LE_FAULT Failure.
  • LE_OK Success.
Parameters
[in]streamRefAudio stream reference.

◆ ifgen_taf_audio_IsEchoCancellerEnabled()

LE_SHARED le_result_t ifgen_taf_audio_IsEchoCancellerEnabled ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
bool *  statusPtr 
)

Gets echo cancellation status.

Returns
  • LE_FAULT Failure.
  • LE_OK Success.
Parameters
[in]streamRefAudio stream reference.
[out]statusPtrCheck for EchoCanceller flag.

◆ ifgen_taf_audio_IsNoiseSuppressorEnabled()

LE_SHARED le_result_t ifgen_taf_audio_IsNoiseSuppressorEnabled ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
bool *  statusPtr 
)

Gets noise suppression status.

Returns
  • LE_FAULT Failure.
  • LE_OK Success.
Parameters
[in]streamRefAudio stream reference.
[out]statusPtrCheck for NoiseSuppressor flag.

◆ ifgen_taf_audio_OpenI2sRx()

LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenI2sRx ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_I2SChannel_t  mode 
)

Opens an audio stream reference for I2S Rx interface use.

Note
Set the sampling rate using taf_audio_SetSamplePcmSamplingRate after creating the stream reference and before connecting, otherwise the defalut sampling rate will be 16000.
Returns
Reference to the audio stream, NULL on error.
Parameters
[in]modeThe channel mode.

◆ ifgen_taf_audio_OpenI2sTx()

LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenI2sTx ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_I2SChannel_t  mode 
)

Opens an audio stream reference for I2S Tx interface use.

Note
Set the sampling rate using taf_audio_SetSamplePcmSamplingRate after creating the stream reference and before connecting, otherwise the defalut sampling rate will be 16000.
Returns
Reference to the audio stream, NULL on error.
Parameters
[in]modeThe channel mode.

◆ ifgen_taf_audio_OpenPcmRx()

LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenPcmRx ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint32_t  timeslot 
)

Opens an audio stream reference for PCM Rx interface use.

Note
Set the sampling rate using taf_audio_SetSamplePcmSamplingRate after creating the stream reference and before connecting, otherwise the defalut sampling rate will be 16000.
Returns
Reference to the audio stream, NULL on error.
Parameters
[in]timeslotThe time slot number.

◆ ifgen_taf_audio_OpenPcmTx()

LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenPcmTx ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint32_t  timeslot 
)

Opens an audio stream reference for PCM Tx interface use.

Note
Set the sampling rate using taf_audio_SetSamplePcmSamplingRate after creating the stream reference and before connecting, otherwise the defalut sampling rate will be 16000.
Returns
Reference to the audio stream, NULL on error.
Parameters
[in]timeslotThe time slot number.

◆ ifgen_taf_audio_SetSamplePcmSamplingRate()

LE_SHARED le_result_t ifgen_taf_audio_SetSamplePcmSamplingRate ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
uint32_t  rate 
)

Sets the sampling rate of a stream reference.

Returns
  • LE_OK Succeeded.
  • LE_FAULT Failed.
Parameters
[in]streamRefAudio stream reference.
[in]rateSampling rate.

◆ ifgen_taf_audio_GetSamplePcmSamplingRate()

LE_SHARED le_result_t ifgen_taf_audio_GetSamplePcmSamplingRate ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
uint32_t *  ratePtr 
)

Gets the sampling rate of the stream reference.

Returns
  • LE_FAULT Failed.
  • LE_OK Function succeeded.
Parameters
[in]streamRefAudio stream reference.
[out]ratePtrSampling rate.

◆ ifgen_taf_audio_SetSamplePcmChannelNumber()

LE_SHARED le_result_t ifgen_taf_audio_SetSamplePcmChannelNumber ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
uint32_t  nbChannel 
)

Sets the channel number for the stream reference.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]streamRefAudio stream reference.
[in]nbChannelChannel number.

◆ ifgen_taf_audio_GetSamplePcmChannelNumber()

LE_SHARED le_result_t ifgen_taf_audio_GetSamplePcmChannelNumber ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
uint32_t *  nbChannelPtr 
)

Gets the channel number of the recorder stream reference.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]streamRefAudio stream reference.
[out]nbChannelPtrChannel number.

◆ ifgen_taf_audio_SetEncodingFormat()

LE_SHARED le_result_t ifgen_taf_audio_SetEncodingFormat ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
taf_audio_Format_t  format 
)

Sets the encoding format of a recorder stream reference.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]streamRefAudio stream reference.
[in]formatEncoding format.

◆ ifgen_taf_audio_GetEncodingFormat()

LE_SHARED le_result_t ifgen_taf_audio_GetEncodingFormat ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_audio_StreamRef_t  streamRef,
taf_audio_Format_t *  formatPtr 
)

Gets the encoding format of a recorder stream reference.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Note
A client calling this function with either an invalid streamRef or null out pointer parameter will be killed and the function will not return.
Parameters
[in]streamRefAudio stream reference.
[out]formatPtrEncoding format.