#include "legato.h"
#include "taf_audio_common.h"

Functions
le_msg_ServiceRef_t	taf_audio_GetServiceRef (void)

le_msg_SessionRef_t	taf_audio_GetClientSessionRef (void)

void	taf_audio_AdvertiseService (void)

void	taf_audio_Close (taf_audio_StreamRef_t sRef)

taf_audio_ConnectorRef_t	taf_audio_CreateConnector (void)

void	taf_audio_DeleteConnector (taf_audio_ConnectorRef_t connRef)

le_result_t	taf_audio_Connect (taf_audio_ConnectorRef_t connRef, taf_audio_StreamRef_t sRef)

void	taf_audio_Disconnect (taf_audio_ConnectorRef_t connRef, taf_audio_StreamRef_t sRef)

taf_audio_StreamRef_t	taf_audio_OpenSpeaker (void)

taf_audio_StreamRef_t	taf_audio_OpenMic (void)

taf_audio_StreamRef_t	taf_audio_OpenModemVoiceRx (uint32_t slotId)

taf_audio_StreamRef_t	taf_audio_OpenModemVoiceTx (uint32_t slotId)

le_result_t	taf_audio_PlayDtmf (taf_audio_StreamRef_t streamRef, const char *LE_NONNULL dtmf, uint32_t duration, uint32_t pause)

le_result_t	taf_audio_Mute (taf_audio_StreamRef_t streamRef)

le_result_t	taf_audio_Unmute (taf_audio_StreamRef_t streamRef)

taf_audio_StreamRef_t	taf_audio_OpenPlayer (void)

le_result_t	taf_audio_PlayFile (taf_audio_StreamRef_t streamRef, int fd)

taf_audio_StreamRef_t	taf_audio_OpenRecorder (void)

le_result_t	taf_audio_RecordFile (taf_audio_StreamRef_t streamRef, int fd)

taf_audio_MediaHandlerRef_t	taf_audio_AddMediaHandler (taf_audio_StreamRef_t streamRef, taf_audio_MediaHandlerFunc_t handlerPtr, void *contextPtr)

void	taf_audio_RemoveMediaHandler (taf_audio_MediaHandlerRef_t handlerRef)

taf_audio_DtmfDetectorHandlerRef_t	taf_audio_AddDtmfDetectorHandler (taf_audio_StreamRef_t streamRef, taf_audio_DtmfDetectorHandlerFunc_t handlerPtr, void *contextPtr)

void	taf_audio_RemoveDtmfDetectorHandler (taf_audio_DtmfDetectorHandlerRef_t handlerRef)

le_result_t	taf_audio_Stop (taf_audio_StreamRef_t streamRef)

le_result_t	taf_audio_SetGain (taf_audio_StreamRef_t streamRef, int32_t gain)

le_result_t	taf_audio_GetGain (taf_audio_StreamRef_t streamRef, int32_t *gainPtr)

le_result_t	taf_audio_EnableNoiseSuppressor (taf_audio_StreamRef_t streamRef)

le_result_t	taf_audio_EnableEchoCanceller (taf_audio_StreamRef_t streamRef)

le_result_t	taf_audio_DisableNoiseSuppressor (taf_audio_StreamRef_t streamRef)

le_result_t	taf_audio_DisableEchoCanceller (taf_audio_StreamRef_t streamRef)

le_result_t	taf_audio_IsEchoCancellerEnabled (taf_audio_StreamRef_t streamRef, bool *statusPtr)

le_result_t	taf_audio_IsNoiseSuppressorEnabled (taf_audio_StreamRef_t streamRef, bool *statusPtr)

taf_audio_StreamRef_t	taf_audio_OpenI2sRx (taf_audio_I2SChannel_t mode)

taf_audio_StreamRef_t	taf_audio_OpenI2sTx (taf_audio_I2SChannel_t mode)

taf_audio_StreamRef_t	taf_audio_OpenPcmRx (uint32_t timeslot)

taf_audio_StreamRef_t	taf_audio_OpenPcmTx (uint32_t timeslot)

le_result_t	taf_audio_SetSamplePcmSamplingRate (taf_audio_StreamRef_t streamRef, uint32_t rate)

le_result_t	taf_audio_GetSamplePcmSamplingRate (taf_audio_StreamRef_t streamRef, uint32_t *ratePtr)

le_result_t	taf_audio_SetSamplePcmChannelNumber (taf_audio_StreamRef_t streamRef, uint32_t nbChannel)

le_result_t	taf_audio_GetSamplePcmChannelNumber (taf_audio_StreamRef_t streamRef, uint32_t *nbChannelPtr)

le_result_t	taf_audio_SetEncodingFormat (taf_audio_StreamRef_t streamRef, taf_audio_Format_t format)

le_result_t	taf_audio_GetEncodingFormat (taf_audio_StreamRef_t streamRef, taf_audio_Format_t *formatPtr)

Function Documentation

◆ taf_audio_GetServiceRef()

le_msg_ServiceRef_t taf_audio_GetServiceRef ( void )

Get the server service reference

◆ taf_audio_GetClientSessionRef()

le_msg_SessionRef_t taf_audio_GetClientSessionRef ( void )

Get the client session reference for the current message

◆ taf_audio_AdvertiseService()

void taf_audio_AdvertiseService ( void )

Initialize the server and advertise the service.

◆ taf_audio_Close()

void taf_audio_Close ( taf_audio_StreamRef_t sRef )

Reference type for audio stream. Reference type for audio connector. Audio recording/playback events. Handler for audio stream event. Reference type used by Add/Remove functions for EVENT 'taf_audio_Media' Handler for DTMF decoding. Reference type used by Add/Remove functions for EVENT 'taf_audio_DtmfDetector' Audio format. AMR . I2S channel mode. Closes the stream reference.

Closes the stream reference.

Parameters

[in] sRef Audio stream reference.

◆ taf_audio_CreateConnector()

taf_audio_ConnectorRef_t taf_audio_CreateConnector ( void )

Creates a new connector.

Returns: Reference to the audio stream, NULL on error.

◆ taf_audio_DeleteConnector()

void taf_audio_DeleteConnector ( taf_audio_ConnectorRef_t connRef )

Deletes a connected connector.

Note: This function will not return if passed a bad reference.

Parameters

[in] connRef Connector reference.

◆ taf_audio_Connect()

le_result_t taf_audio_Connect	(	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]	connRef	Connector reference.
[in]	sRef	Audio stream reference.

◆ taf_audio_Disconnect()

void taf_audio_Disconnect	(	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]	connRef	Connector reference.
[in]	sRef	Audio stream reference.

◆ taf_audio_OpenSpeaker()

taf_audio_StreamRef_t taf_audio_OpenSpeaker ( void )

Opens an audio stream reference for speaker use.

Returns: Reference to the audio stream, NULL on error.

◆ taf_audio_OpenMic()

taf_audio_StreamRef_t taf_audio_OpenMic ( void )

Opens an audio stream reference for microphone use.

Returns: Reference to an audio stream, NULL on error.

◆ taf_audio_OpenModemVoiceRx()

taf_audio_StreamRef_t taf_audio_OpenModemVoiceRx ( uint32_t slotId )

Opens an audio stream reference for voice Rx.

Returns: Reference to an audio stream, NULL on error.

Parameters

[in] slotId Slot value

◆ taf_audio_OpenModemVoiceTx()

taf_audio_StreamRef_t taf_audio_OpenModemVoiceTx ( uint32_t slotId )

Opens an audio stream reference for voice Tx.

Returns: Reference to an audio stream, NULL on error.

Parameters

[in] slotId Slot value.

◆ taf_audio_PlayDtmf()

le_result_t taf_audio_PlayDtmf	(	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]	streamRef	Audio stream reference.
[in]	dtmf	DTMF data.
[in]	duration	Duration to play.
[in]	pause	Pause between tones.

◆ taf_audio_Mute()

le_result_t taf_audio_Mute ( taf_audio_StreamRef_t streamRef )

Mutes an audio stream.

Returns

LE_OK Success.
LE_FAULT Failure.

Parameters

[in] streamRef Audio stream reference.

◆ taf_audio_Unmute()

le_result_t taf_audio_Unmute ( taf_audio_StreamRef_t streamRef )

Unmutes an audio stream.

Returns

LE_OK Success.
LE_FAULT Failure.

Parameters

[in] streamRef Audio stream reference.

◆ taf_audio_OpenPlayer()

taf_audio_StreamRef_t taf_audio_OpenPlayer ( void )

Opens a stream for audio playback.

Returns: Reference to an audio stream, NULL on error.

◆ taf_audio_PlayFile()

le_result_t taf_audio_PlayFile	(	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]	streamRef	Audio stream reference.
[in]	fd	File descriptor.

◆ taf_audio_OpenRecorder()

taf_audio_StreamRef_t taf_audio_OpenRecorder ( void )

Opens the audio stream for recording.

Returns: Reference to an audio stream, NULL on error.

◆ taf_audio_RecordFile()

le_result_t taf_audio_RecordFile	(	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]	streamRef	Audio stream reference.
[in]	fd	File descriptor.

◆ taf_audio_AddMediaHandler()

taf_audio_MediaHandlerRef_t taf_audio_AddMediaHandler	(	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]	streamRef	Audio stream reference.
[in]	handlerPtr	Media handler.
[in]	contextPtr

◆ taf_audio_RemoveMediaHandler()

void taf_audio_RemoveMediaHandler ( taf_audio_MediaHandlerRef_t handlerRef )

Remove handler function for EVENT 'taf_audio_Media'

Parameters

[in] handlerRef

◆ taf_audio_AddDtmfDetectorHandler()

taf_audio_DtmfDetectorHandlerRef_t taf_audio_AddDtmfDetectorHandler	(	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]	streamRef	Audio stream reference.
[in]	handlerPtr	DTMF Handler.
[in]	contextPtr

◆ taf_audio_RemoveDtmfDetectorHandler()

void taf_audio_RemoveDtmfDetectorHandler ( taf_audio_DtmfDetectorHandlerRef_t handlerRef )

Remove handler function for EVENT 'taf_audio_DtmfDetector'

Parameters

[in] handlerRef

◆ taf_audio_Stop()

le_result_t taf_audio_Stop ( taf_audio_StreamRef_t streamRef )

Stops the file playback or recording.

Returns

LE_OK Success.
LE_FAULT Failure.

Parameters

[in] streamRef Audio stream reference.

◆ taf_audio_SetGain()

le_result_t taf_audio_SetGain	(	taf_audio_StreamRef_t	streamRef,
		int32_t	gain
	)

Sets the volume.

Returns

LE_FAULT Failure.
LE_OK Success.

Parameters

[in]	streamRef	Audio stream reference.
[in]	gain	Set gain parameter.

◆ taf_audio_GetGain()

le_result_t taf_audio_GetGain	(	taf_audio_StreamRef_t	streamRef,
		int32_t *	gainPtr
	)

Gets the volume.

Returns

LE_FAULT Failure.
LE_OK Success.

Parameters

[in]	streamRef	Audio stream reference.
[out]	gainPtr	Gain parameter.

◆ taf_audio_EnableNoiseSuppressor()

le_result_t taf_audio_EnableNoiseSuppressor ( taf_audio_StreamRef_t streamRef )

Enables noise suppression.

Returns

LE_FAULT Failure.
LE_OK Success.

Parameters

[in] streamRef Audio stream reference.

◆ taf_audio_EnableEchoCanceller()

le_result_t taf_audio_EnableEchoCanceller ( taf_audio_StreamRef_t streamRef )

Enables echo cancellation.

Returns

LE_FAULT Failure.
LE_OK Success.

Parameters

[in] streamRef Audio stream reference.

◆ taf_audio_DisableNoiseSuppressor()

le_result_t taf_audio_DisableNoiseSuppressor ( taf_audio_StreamRef_t streamRef )

Disables noise suppression.

Returns

LE_FAULT Failure.
LE_OK Success.

Parameters

[in] streamRef Audio stream reference.

◆ taf_audio_DisableEchoCanceller()

le_result_t taf_audio_DisableEchoCanceller ( taf_audio_StreamRef_t streamRef )

Sets the volume.

Returns

LE_FAULT Failure.
LE_OK Success.

Parameters

[in] streamRef Audio stream reference.

◆ taf_audio_IsEchoCancellerEnabled()

le_result_t taf_audio_IsEchoCancellerEnabled	(	taf_audio_StreamRef_t	streamRef,
		bool *	statusPtr
	)

Gets echo cancellation status.

Returns

LE_FAULT Failure.
LE_OK Success.

Parameters

[in]	streamRef	Audio stream reference.
[out]	statusPtr	Check for EchoCanceller flag.

◆ taf_audio_IsNoiseSuppressorEnabled()

le_result_t taf_audio_IsNoiseSuppressorEnabled	(	taf_audio_StreamRef_t	streamRef,
		bool *	statusPtr
	)

Gets noise suppression status.

Returns

LE_FAULT Failure.
LE_OK Success.

Parameters

[in]	streamRef	Audio stream reference.
[out]	statusPtr	Check for NoiseSuppressor flag.

◆ taf_audio_OpenI2sRx()

taf_audio_StreamRef_t taf_audio_OpenI2sRx ( 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] mode The channel mode.

◆ taf_audio_OpenI2sTx()

taf_audio_StreamRef_t taf_audio_OpenI2sTx ( 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] mode The channel mode.

◆ taf_audio_OpenPcmRx()

taf_audio_StreamRef_t taf_audio_OpenPcmRx ( 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] timeslot The time slot number.

◆ taf_audio_OpenPcmTx()

taf_audio_StreamRef_t taf_audio_OpenPcmTx ( 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] timeslot The time slot number.

◆ taf_audio_SetSamplePcmSamplingRate()

le_result_t taf_audio_SetSamplePcmSamplingRate	(	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]	streamRef	Audio stream reference.
[in]	rate	Sampling rate.

◆ taf_audio_GetSamplePcmSamplingRate()

le_result_t taf_audio_GetSamplePcmSamplingRate	(	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]	streamRef	Audio stream reference.
[out]	ratePtr	Sampling rate.

◆ taf_audio_SetSamplePcmChannelNumber()

le_result_t taf_audio_SetSamplePcmChannelNumber	(	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]	streamRef	Audio stream reference.
[in]	nbChannel	Channel number.

◆ taf_audio_GetSamplePcmChannelNumber()

le_result_t taf_audio_GetSamplePcmChannelNumber	(	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]	streamRef	Audio stream reference.
[out]	nbChannelPtr	Channel number.

◆ taf_audio_SetEncodingFormat()

le_result_t taf_audio_SetEncodingFormat	(	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]	streamRef	Audio stream reference.
[in]	format	Encoding format.

◆ taf_audio_GetEncodingFormat()

le_result_t taf_audio_GetEncodingFormat	(	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]	streamRef	Audio stream reference.
[out]	formatPtr	Encoding format.

Functions

Function Documentation

◆ taf_audio_GetServiceRef()

◆ taf_audio_GetClientSessionRef()

◆ taf_audio_AdvertiseService()

◆ taf_audio_Close()

◆ taf_audio_CreateConnector()

◆ taf_audio_DeleteConnector()

◆ taf_audio_Connect()

◆ taf_audio_Disconnect()

◆ taf_audio_OpenSpeaker()

◆ taf_audio_OpenMic()

◆ taf_audio_OpenModemVoiceRx()

◆ taf_audio_OpenModemVoiceTx()

◆ taf_audio_PlayDtmf()

◆ taf_audio_Mute()

◆ taf_audio_Unmute()

◆ taf_audio_OpenPlayer()

◆ taf_audio_PlayFile()

◆ taf_audio_OpenRecorder()

◆ taf_audio_RecordFile()

◆ taf_audio_AddMediaHandler()

◆ taf_audio_RemoveMediaHandler()

◆ taf_audio_AddDtmfDetectorHandler()

◆ taf_audio_RemoveDtmfDetectorHandler()

◆ taf_audio_Stop()

◆ taf_audio_SetGain()

◆ taf_audio_GetGain()

◆ taf_audio_EnableNoiseSuppressor()

◆ taf_audio_EnableEchoCanceller()

◆ taf_audio_DisableNoiseSuppressor()

◆ taf_audio_DisableEchoCanceller()

◆ taf_audio_IsEchoCancellerEnabled()

◆ taf_audio_IsNoiseSuppressorEnabled()

◆ taf_audio_OpenI2sRx()

◆ taf_audio_OpenI2sTx()

◆ taf_audio_OpenPcmRx()

◆ taf_audio_OpenPcmTx()

◆ taf_audio_SetSamplePcmSamplingRate()

◆ taf_audio_GetSamplePcmSamplingRate()

◆ taf_audio_SetSamplePcmChannelNumber()

◆ taf_audio_GetSamplePcmChannelNumber()

◆ taf_audio_SetEncodingFormat()

◆ taf_audio_GetEncodingFormat()