Description

Functions
rmf_Error	RMF_AudioCapture_Open (RMF_AudioCaptureHandle *handle)
	This API creates audio capture session, create all required resources to provide audio capture handle. More...

rmf_Error	RMF_AudioCapture_Open_Type (RMF_AudioCaptureHandle *handle, RMF_AudioCaptureType rmfAcType)
	This API creates audio capture session, create all required resources to provide audio capture handle. More...

rmf_Error	RMF_AudioCapture_GetStatus (RMF_AudioCaptureHandle handle, RMF_AudioCapture_Status *status)
	This API is used to enquire the current status of Audio Capture associated with the current Audio Capture context. More...

rmf_Error	RMF_AudioCapture_GetDefaultSettings (RMF_AudioCapture_Settings *settings)
	This API Will return default RMF audio capture settings. More...

rmf_Error	RMF_AudioCapture_GetCurrentSettings (RMF_AudioCaptureHandle handle, RMF_AudioCapture_Settings *settings)
	This API will return the audio capture settings which has been successfully set for that context. More...

rmf_Error	RMF_AudioCapture_Start (RMF_AudioCaptureHandle handle, RMF_AudioCapture_Settings *settings)
	This API will start the Audio capture. More...

rmf_Error	RMF_AudioCapture_Stop (RMF_AudioCaptureHandle handle)
	This API will stop the audio capture. More...

rmf_Error	RMF_AudioCapture_Close (RMF_AudioCaptureHandle handle)
	This API will free all resources associated with this audio capture handle. It will close audio capture session. More...

Function Documentation

◆ RMF_AudioCapture_Open()

rmf_Error RMF_AudioCapture_Open ( RMF_AudioCaptureHandle * handle )

This API creates audio capture session, create all required resources to provide audio capture handle.

Parameters

[in] handle RMF audio capture instance handle.

Returns: Returns a opaque AudioCaptureHandle, which has to be passed as an argument for all subsequent AudioCapture calls; Returns RMF error code.

Definition at line 23 of file rmfAudioCapture.c.

◆ RMF_AudioCapture_Open_Type()

rmf_Error RMF_AudioCapture_Open_Type	(	RMF_AudioCaptureHandle *	handle,
		RMF_AudioCaptureType	rmfAcType
	)

This API creates audio capture session, create all required resources to provide audio capture handle.

Parameters

[in]	handle	RMF audio capture instance handle.
[in]	rmfAcType	RMF audio capture instance handle.

Returns: Returns a opaque AudioCaptureHandle, which has to be passed as an argument for all subsequent AudioCapture calls; Returns RMF error code.

Definition at line 31 of file rmfAudioCapture.c.

◆ RMF_AudioCapture_GetStatus()

rmf_Error RMF_AudioCapture_GetStatus	(	RMF_AudioCaptureHandle	handle,
		RMF_AudioCapture_Status *	status
	)

This API is used to enquire the current status of Audio Capture associated with the current Audio Capture context.

Parameters

[in]	handle	Audio capture handle.
[in]	status	Structure which has audio capture status informations.

Returns: Returns RMF error code.

Definition at line 40 of file rmfAudioCapture.c.

◆ RMF_AudioCapture_GetDefaultSettings()

rmf_Error RMF_AudioCapture_GetDefaultSettings ( RMF_AudioCapture_Settings * settings )

This API Will return default RMF audio capture settings.

Once audio capture gets started this API will continue to return the default capture settings.

Parameters

[in] settings Structure which holds the audio properties.

Returns: Returns RMF error code.

Definition at line 51 of file rmfAudioCapture.c.

◆ RMF_AudioCapture_GetCurrentSettings()

rmf_Error RMF_AudioCapture_GetCurrentSettings	(	RMF_AudioCaptureHandle	handle,
		RMF_AudioCapture_Settings *	settings
	)

This API will return the audio capture settings which has been successfully set for that context.

Return the settings currently being used to capture data as part of the specific Audio capture context.

Parameters

[in]	handle	Audio capture handle.
[in]	settings	Structure which holds the audio properties.

Returns: Returns RMF error code.

Definition at line 60 of file rmfAudioCapture.c.

◆ RMF_AudioCapture_Start()

rmf_Error RMF_AudioCapture_Start	(	RMF_AudioCaptureHandle	handle,
		RMF_AudioCapture_Settings *	settings
	)

This API will start the Audio capture.

If audio capture settings are retained then this API will reconfigure with the provided capture settings to start audio capture. If audio capture settings are not retained then audio capture will start with the default capture settings.

Parameters

[in]	handle	audio capture handle.
[in]	settings	Structure which holds the audio settings.

Returns: Returns RMF error code.

Definition at line 71 of file rmfAudioCapture.c.

◆ RMF_AudioCapture_Stop()

rmf_Error RMF_AudioCapture_Stop ( RMF_AudioCaptureHandle handle )

This API will stop the audio capture.

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

Parameters

[in] handle audio capture handle.

Returns: Returns RMF error code.

Definition at line 82 of file rmfAudioCapture.c.

◆ RMF_AudioCapture_Close()

rmf_Error RMF_AudioCapture_Close ( RMF_AudioCaptureHandle handle )

This API will free all resources associated with this audio capture handle. It will close audio capture session.

Parameters

[in] handle audio capture handle.

Returns: Returns RMF error code.

Definition at line 91 of file rmfAudioCapture.c.

Description

Functions

Function Documentation

◆ RMF_AudioCapture_Open()

◆ RMF_AudioCapture_Open_Type()

◆ RMF_AudioCapture_GetStatus()

◆ RMF_AudioCapture_GetDefaultSettings()

◆ RMF_AudioCapture_GetCurrentSettings()

◆ RMF_AudioCapture_Start()

◆ RMF_AudioCapture_Stop()

◆ RMF_AudioCapture_Close()