Speaker service

Access hardware audio speakers. More...

Collaboration diagram for Speaker service:

Data Structures
struct	GNUNET_SPEAKER_Handle
	A speaker is a device that can play or record audio data. More...

Typedefs
typedef int(*	GNUNET_SPEAKER_EnableCallback) (void *cls)
	Function that enables a speaker. More...
typedef void(*	GNUNET_SPEAKER_DisableCallback) (void *cls)
	Function that disables a speaker. More...
typedef void(*	GNUNET_SPEAKER_DestroyCallback) (void *cls)
	Function to destroy a speaker. More...
typedef void(*	GNUNET_SPEAKER_PlayCallback) (void *cls, size_t data_size, const void *data)
	Function to cause a speaker to play audio data. More...

Functions
struct GNUNET_SPEAKER_Handle *	GNUNET_SPEAKER_create_from_hardware (const struct GNUNET_CONFIGURATION_Handle *cfg)
	Create a speaker that corresponds to the speaker hardware of our system. More...
void	GNUNET_SPEAKER_destroy (struct GNUNET_SPEAKER_Handle *speaker)
	Destroy a speaker. More...

Detailed Description

Access hardware audio speakers.

Typedef Documentation

GNUNET_SPEAKER_EnableCallback

typedef int(* GNUNET_SPEAKER_EnableCallback) (void *cls)

Function that enables a speaker.

Parameters

cls

closure

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 56 of file gnunet_speaker_lib.h.

GNUNET_SPEAKER_DisableCallback

typedef void(* GNUNET_SPEAKER_DisableCallback) (void *cls)

Function that disables a speaker.

Parameters

cls

closure

Definition at line 63 of file gnunet_speaker_lib.h.

GNUNET_SPEAKER_DestroyCallback

typedef void(* GNUNET_SPEAKER_DestroyCallback) (void *cls)

Function to destroy a speaker.

Parameters

cls

closure

Definition at line 70 of file gnunet_speaker_lib.h.

GNUNET_SPEAKER_PlayCallback

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

Function to cause a speaker to play audio data.

Parameters

cls	closure
data_size	number of bytes in data
data	audio data to play, format is opaque to the API but should be OPUS.

Definition at line 80 of file gnunet_speaker_lib.h.

Function Documentation

GNUNET_SPEAKER_create_from_hardware()

struct GNUNET_SPEAKER_Handle * GNUNET_SPEAKER_create_from_hardware

(

const struct GNUNET_CONFIGURATION_Handle *

cfg

)

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

Parameters

cfg	configuration to use

Returns

NULL on error

Definition at line 158 of file speaker.c.

{
  struct GNUNET_SPEAKER_Handle *speaker;
  struct Speaker *spe;
 
  spe = GNUNET_new (struct Speaker);
  spe->cfg = cfg;
  speaker = GNUNET_new (struct GNUNET_SPEAKER_Handle);
  speaker->cls = spe;
  speaker->enable_speaker = &enable;
  speaker->play = &play;
  speaker->disable_speaker = &disable;
  speaker->destroy_speaker = &destroy;
  return speaker;
}

References cfg, Speaker::cfg, GNUNET_SPEAKER_Handle::cls, destroy(), GNUNET_SPEAKER_Handle::destroy_speaker, disable(), GNUNET_SPEAKER_Handle::disable_speaker, enable(), GNUNET_SPEAKER_Handle::enable_speaker, GNUNET_new, play(), GNUNET_SPEAKER_Handle::play, and speaker.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_SPEAKER_destroy()

void GNUNET_SPEAKER_destroy

(

struct GNUNET_SPEAKER_Handle *

speaker

)

Destroy a speaker.

Parameters

speaker

speaker to destroy

Definition at line 182 of file speaker.c.

{
  speaker->destroy_speaker (speaker->cls);
  GNUNET_free (speaker);
}

References GNUNET_SPEAKER_Handle::cls, GNUNET_SPEAKER_Handle::destroy_speaker, GNUNET_free, and speaker.

Referenced by do_shutdown(), and do_stop_task().

Here is the caller graph for this function: