Microphone library

Provides access to hardware microphones. More...

Collaboration diagram for Microphone library:

Data Structures
struct	GNUNET_MICROPHONE_Handle
	A microphone is a device that can capture or otherwise produce audio data. More...

Typedefs
typedef void(*	GNUNET_MICROPHONE_RecordedDataCallback) (void *cls, size_t data_size, const void *data)
	Process recorded audio data.
typedef int(*	GNUNET_MICROPHONE_EnableCallback) (void *cls, GNUNET_MICROPHONE_RecordedDataCallback rdc, void *rdc_cls)
	Enable a microphone.
typedef void(*	GNUNET_MICROPHONE_DisableCallback) (void *cls)
	Function that disables a microphone.
typedef void(*	GNUNET_MICROPHONE_DestroyCallback) (void *cls)
	Function to destroy a microphone.

Functions
struct GNUNET_MICROPHONE_Handle *	GNUNET_MICROPHONE_create_from_hardware (const struct GNUNET_CONFIGURATION_Handle *cfg)
	Create a microphone that corresponds to the microphone hardware of our system.
void	GNUNET_MICROPHONE_destroy (struct GNUNET_MICROPHONE_Handle *microphone)
	Destroy a microphone.

Detailed Description

Provides access to hardware microphones.

Typedef Documentation

GNUNET_MICROPHONE_RecordedDataCallback

typedef void(* GNUNET_MICROPHONE_RecordedDataCallback) (void *cls, size_t data_size, const void *data)

Process recorded audio data.

Parameters

cls	clsoure
data_size	number of bytes in data
data	audio data to play

Definition at line 57 of file gnunet_microphone_lib.h.

GNUNET_MICROPHONE_EnableCallback

typedef int(* GNUNET_MICROPHONE_EnableCallback) (void *cls, GNUNET_MICROPHONE_RecordedDataCallback rdc, void *rdc_cls)

Enable a microphone.

Parameters

cls	clsoure
rdc	function to call with recorded data
rdc_cls	closure for dc

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 69 of file gnunet_microphone_lib.h.

GNUNET_MICROPHONE_DisableCallback

typedef void(* GNUNET_MICROPHONE_DisableCallback) (void *cls)

Function that disables a microphone.

Parameters

cls

clsoure

Definition at line 79 of file gnunet_microphone_lib.h.

GNUNET_MICROPHONE_DestroyCallback

typedef void(* GNUNET_MICROPHONE_DestroyCallback) (void *cls)

Function to destroy a microphone.

Parameters

cls

clsoure

Definition at line 86 of file gnunet_microphone_lib.h.

Function Documentation

GNUNET_MICROPHONE_create_from_hardware()

struct GNUNET_MICROPHONE_Handle * GNUNET_MICROPHONE_create_from_hardware

(

const struct GNUNET_CONFIGURATION_Handle *

cfg

)

Create a microphone that corresponds to the microphone hardware of our system.

Parameters

cfg	configuration to use

Returns

NULL on error

Definition at line 172 of file microphone.c.

{
  struct GNUNET_MICROPHONE_Handle *microphone;
  struct Microphone *mic;
 
  mic = GNUNET_new (struct Microphone);
  mic->cfg = cfg;
  microphone = GNUNET_new (struct GNUNET_MICROPHONE_Handle);
  microphone->cls = mic;
  microphone->enable_microphone = &enable;
  microphone->disable_microphone = &disable;
  microphone->destroy_microphone = &destroy;
  return microphone;
}

References cfg, GNUNET_MICROPHONE_Handle::cls, destroy(), GNUNET_MICROPHONE_Handle::destroy_microphone, disable(), GNUNET_MICROPHONE_Handle::disable_microphone, enable(), GNUNET_MICROPHONE_Handle::enable_microphone, GNUNET_new, mic, and microphone.

Referenced by run(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_MICROPHONE_destroy()

void GNUNET_MICROPHONE_destroy

(

struct GNUNET_MICROPHONE_Handle *

microphone

)

Destroy a microphone.

Parameters

microphone

microphone to destroy

Definition at line 195 of file microphone.c.

{
  microphone->destroy_microphone (microphone->cls);
  GNUNET_free (microphone);
}

References GNUNET_MICROPHONE_Handle::cls, GNUNET_MICROPHONE_Handle::destroy_microphone, GNUNET_free, and microphone.

Referenced by do_shutdown(), and do_stop_task().

Here is the caller graph for this function: