Description

This file defines bluetooth manager's audio capture interfaces to receiver data from audio capture modules.

Functions
eBTRMgrRet	BTRMgr_AC_Init (tBTRMgrAcHdl *phBTRMgrAcHdl, tBTRMgrAcType api8BTRMgrAcType)
	This API initializes the bluetooth manager audio capture interface. More...

eBTRMgrRet	BTRMgr_AC_DeInit (tBTRMgrAcHdl hBTRMgrAcHdl)
	This API deinitializes the bluetooth manager audio capture interface. More...

eBTRMgrRet	BTRMgr_AC_GetDefaultSettings (tBTRMgrAcHdl hBTRMgrAcHdl, stBTRMgrOutASettings *apstBtrMgrAcOutASettings)
	This API will fetch default RMF AudioCapture Settings. More...

eBTRMgrRet	BTRMgr_AC_GetCurrentSettings (tBTRMgrAcHdl hBTRMgrAcHdl, stBTRMgrOutASettings *apstBtrMgrAcOutASettings)
	This API fetches the current settings to capture data as part of the specific Audio capture context. More...

eBTRMgrRet	BTRMgr_AC_GetStatus (tBTRMgrAcHdl hBTRMgrAcHdl, stBTRMgrMediaStatus *apstBtrMgrAcStatus)
	This API fetches the status of the operation. More...

eBTRMgrRet	BTRMgr_AC_Start (tBTRMgrAcHdl hBTRMgrAcHdl, stBTRMgrOutASettings apstBtrMgrAcOutASettings, fPtr_BTRMgr_AC_DataReadyCb afpcBBtrMgrAcDataReady, fPtr_BTRMgr_AC_StatusCb afpcBBtrMgrAcStatus, void apvUserData)
	This function will start the Audio capture with the default capture settings. More...

eBTRMgrRet	BTRMgr_AC_Stop (tBTRMgrAcHdl hBTRMgrAcHdl)
	This function will stop the audio capture. More...

eBTRMgrRet	BTRMgr_AC_Pause (tBTRMgrAcHdl hBTRMgrAcHdl)
	This API pauses the state of audio capture. More...

eBTRMgrRet	BTRMgr_AC_Resume (tBTRMgrAcHdl hBTRMgrAcHdl)
	This API resumes the state of audio capture. More...

Function Documentation

◆ BTRMgr_AC_Init()

eBTRMgrRet BTRMgr_AC_Init	(	tBTRMgrAcHdl *	phBTRMgrAcHdl,
		tBTRMgrAcType	api8BTRMgrAcType
	)

This API initializes the bluetooth manager audio capture interface.

Parameters

[in] phBTRMgrAcHdl Handle to the bluetooth manager audio capture interface.

Returns: Returns the status of the operation.

Return values

eBTRMgrSuccess on success, appropriate error code otherwise.

Definition at line 357 of file btrMgr_audioCap.c.

◆ BTRMgr_AC_DeInit()

eBTRMgrRet BTRMgr_AC_DeInit ( tBTRMgrAcHdl hBTRMgrAcHdl )

This API deinitializes the bluetooth manager audio capture interface.

Parameters

[in] hBTRMgrAcHdl Handle to the bluetooth manager audio capture interface.

Returns: Returns the status of the operation.

Return values

eBTRMgrSuccess on success, appropriate error code otherwise.

Definition at line 465 of file btrMgr_audioCap.c.

◆ BTRMgr_AC_GetDefaultSettings()

eBTRMgrRet BTRMgr_AC_GetDefaultSettings	(	tBTRMgrAcHdl	hBTRMgrAcHdl,
		stBTRMgrOutASettings *	apstBtrMgrAcOutASettings
	)

This API will fetch default RMF AudioCapture Settings.

Once AudioCaptureStart gets called with RMF_AudioCapture_Status, this API will continue to return the default capture settings.

Parameters

[in]	hBTRMgrAcHdl	Handle to the bluetooth manager audio capture interface.
[out]	apstBtrMgrAcOutASettings	Structure which holds the output settings.

Returns: Returns the status of the operation.

Return values

eBTRMgrSuccess on success, appropriate error code otherwise.

Definition at line 580 of file btrMgr_audioCap.c.

◆ BTRMgr_AC_GetCurrentSettings()

eBTRMgrRet BTRMgr_AC_GetCurrentSettings	(	tBTRMgrAcHdl	hBTRMgrAcHdl,
		stBTRMgrOutASettings *	apstBtrMgrAcOutASettings
	)

This API fetches the current settings to capture data as part of the specific Audio capture context.

RMF_AudioCapture_Settings has been successfully set for the context.

Parameters

[in]	hBTRMgrAcHdl	Handle to the bluetooth manager audio capture interface.
[out]	apstBtrMgrAcOutASettings	Structure which holds the output settings.

Returns: Returns the status of the operation.

Return values

eBTRMgrSuccess on success, appropriate error code otherwise.

Definition at line 863 of file btrMgr_audioCap.c.

◆ BTRMgr_AC_GetStatus()

eBTRMgrRet BTRMgr_AC_GetStatus	(	tBTRMgrAcHdl	hBTRMgrAcHdl,
		stBTRMgrMediaStatus *	apstBtrMgrAcStatus
	)

This API fetches the status of the operation.

Parameters

[in]	hBTRMgrAcHdl	Handle to the bluetooth manager audio capture interface.
[out]	apstBtrMgrAcStatus	Status of the operation.

Returns: Returns the status of the operation.

Return values

eBTRMgrSuccess on success, appropriate error code otherwise.

Definition at line 1148 of file btrMgr_audioCap.c.

◆ BTRMgr_AC_Start()

eBTRMgrRet BTRMgr_AC_Start	(	tBTRMgrAcHdl	hBTRMgrAcHdl,
		stBTRMgrOutASettings *	apstBtrMgrAcOutASettings,
		fPtr_BTRMgr_AC_DataReadyCb	afpcBBtrMgrAcDataReady,
		fPtr_BTRMgr_AC_StatusCb	afpcBBtrMgrAcStatus,
		void *	apvUserData
	)

This function will start the Audio capture with the default capture settings.

If RMF_AudioCapture_Settings is NULL, This function will start the Audio capture. If a RMF_AudioCapture_Settings is NOT NULL then will reconfigure with the provided capture settings as part of RMF_AudioCapture_Settings and start audio capture.

Parameters

[in]	hBTRMgrAcHdl	Handle to the bluetooth manager audio capture interface.
[out]	apstBtrMgrAcOutASettings	Audio capture settings.
[in]	afpcBBtrMgrAcDataReady	Call back to notify AC data ready.
[in]	apvUserData	User data of audio capture.

Returns: Returns the status of the operation.

Return values

eBTRMgrSuccess on success, appropriate error code otherwise.

Definition at line 1159 of file btrMgr_audioCap.c.

◆ BTRMgr_AC_Stop()

eBTRMgrRet BTRMgr_AC_Stop ( tBTRMgrAcHdl hBTRMgrAcHdl )

This function will stop the audio capture.

Start can be called again after a Stop, as long as Close has not been called.

Parameters

[in] hBTRMgrAcHdl Handle to the audio capture interface.

Returns: Returns the status of the operation.

Return values

eBTRMgrSuccess on success, appropriate error code otherwise.

Definition at line 1508 of file btrMgr_audioCap.c.

◆ BTRMgr_AC_Pause()

eBTRMgrRet BTRMgr_AC_Pause ( tBTRMgrAcHdl hBTRMgrAcHdl )

This API pauses the state of audio capture.

Parameters

[in] hBTRMgrAcHdl Handle to the audio capture interface.

Returns: Returns the status of the operation.

Return values

eBTRMgrSuccess on success, appropriate error code otherwise.

Definition at line 1567 of file btrMgr_audioCap.c.

◆ BTRMgr_AC_Resume()

eBTRMgrRet BTRMgr_AC_Resume ( tBTRMgrAcHdl hBTRMgrAcHdl )

This API resumes the state of audio capture.

Parameters

[in] hBTRMgrAcHdl Handle to the audio capture interface.

Returns: Returns the status of the operation.

Return values

eBTRMgrSuccess on success, appropriate error code otherwise.

Definition at line 1577 of file btrMgr_audioCap.c.

Description

Functions

Function Documentation

◆ BTRMgr_AC_Init()

◆ BTRMgr_AC_DeInit()

◆ BTRMgr_AC_GetDefaultSettings()

◆ BTRMgr_AC_GetCurrentSettings()

◆ BTRMgr_AC_GetStatus()

◆ BTRMgr_AC_Start()

◆ BTRMgr_AC_Stop()

◆ BTRMgr_AC_Pause()

◆ BTRMgr_AC_Resume()