rmfAudioCapture.h File Reference

#include <stddef.h>
#include "rmf_error.h"

Include dependency graph for rmfAudioCapture.h:

Go to the source code of this file.

Data Structures
struct	RMF_AudioCapture_Settings
	Configuration parameters of audio capture interface. More...
struct	RMF_AudioCapture_Status
	Status of audio capture interface. More...

Macros
#define	RMF_ERROR   (1)
#define	RMF_INVALID_PARM   (2)
#define	RMF_AC_TYPE_PRIMARY   "primary"
	Primary audio that is currently selected to play with video.
#define	RMF_AC_TYPE_AUXILIARY   "auxiliary"
	Audio source that is different from primary audio - can be audio track with a different language.

Typedefs
typedef struct RMF_AudioCapture_Struct *	RMF_AudioCaptureHandle
	Opaque handle to an instance of RMF AudioCapture interface.
typedef char *	RMF_AudioCaptureType
	Audio source to be captured. Options are RMF_AC_TYPE_PRIMARY or RMF_AC_TYPE_AUXILIARY.
typedef enum RMF_AudioCapture_Format	racFormat
	Describes more specifics about the audio parameters to be used for audio samples.
typedef enum RMF_AudioCapture_Freq	racFreq
	Audio sampling rate.
typedef rmf_Error(*	RMF_AudioCaptureBufferReadyCb) (void *cbBufferReadyParm, void *AudioCaptureBuffer, unsigned int AudioCaptureBufferSize)
	Callbacks.
typedef rmf_Error(*	RMF_AudioCapture_StatusChangeCb) (void *cbStatusParm)
	Callback for underlying implementation to signal a change in status.
typedef struct RMF_AudioCapture_Settings	RMF_AudioCapture_Settings
	Configuration parameters of audio capture interface.
typedef struct RMF_AudioCapture_Status	RMF_AudioCapture_Status
	Status of audio capture interface.

Enumerations
enum	RMF_AudioCapture_Format {   racFormat_e16BitStereo , racFormat_e24BitStereo , racFormat_e16BitMonoLeft , racFormat_e16BitMonoRight ,   racFormat_e16BitMono , racFormat_e24Bit5_1 , racFormat_eMax }
	Describes more specifics about the audio parameters to be used for audio samples. More...
enum	RMF_AudioCapture_Freq {   racFreq_e16000 , racFreq_e22050 , racFreq_e24000 , racFreq_e32000 ,   racFreq_e44100 , racFreq_e48000 , racFreq_eMax }
	Audio sampling rate. More...

Functions
rmf_Error	RMF_AudioCapture_Open (RMF_AudioCaptureHandle *handle)
	Opens the audio capture interface for primary audio.
rmf_Error	RMF_AudioCapture_Open_Type (RMF_AudioCaptureHandle *handle, RMF_AudioCaptureType rmfAcType)
	Opens the audio capture interface for specified audio source.
rmf_Error	RMF_AudioCapture_GetStatus (RMF_AudioCaptureHandle handle, RMF_AudioCapture_Status *status)
	Gets the current status of audio capture interface.
rmf_Error	RMF_AudioCapture_GetDefaultSettings (RMF_AudioCapture_Settings *settings)
	Returns friendly default values for RMF_AudioCapture_Settings.
rmf_Error	RMF_AudioCapture_GetCurrentSettings (RMF_AudioCaptureHandle handle, RMF_AudioCapture_Settings *settings)
	Returns current values of RMF_AudioCapture_Settings in effect.
rmf_Error	RMF_AudioCapture_Start (RMF_AudioCaptureHandle handle, RMF_AudioCapture_Settings *settings)
	Starts audio capture.
rmf_Error	RMF_AudioCapture_Stop (RMF_AudioCaptureHandle handle)
	Stops audio capture.
rmf_Error	RMF_AudioCapture_Close (RMF_AudioCaptureHandle handle)
	Closes the audio capture interface.