Ecore_Audio.h File Reference

Audio utility functions. More...

Data Structures

struct  _Ecore_Audio_Vio
 

Typedefs

typedef enum _Ecore_Audio_Type Ecore_Audio_Type
 
typedef struct _Ecore_Audio_Module Ecore_Audio_Module
 The audio module.
 
typedef struct _Ecore_Audio_Object Ecore_Audio_Object
 The audio object.
 
typedef struct _Ecore_Audio_Format Ecore_Audio_Format
 The format of the audio data.
 
typedef int(* Ecore_Audio_Read_Callback )(void *user_data, void *data, int len)
 
typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio
 Functions to implement IO virtually.
 

Enumerations

enum  _Ecore_Audio_Type {
  ECORE_AUDIO_TYPE_PULSE,
  ECORE_AUDIO_TYPE_ALSA,
  ECORE_AUDIO_TYPE_SNDFILE,
  ECORE_AUDIO_TYPE_TONE,
  ECORE_AUDIO_TYPE_CUSTOM,
  ECORE_AUDIO_MODULE_LAST
}
 

Functions

int ecore_audio_init (void)
 Initialize the Ecore_Audio library.
 
int ecore_audio_shutdown (void)
 Shut down the Ecore_Audio library.
 
Ecore_Audio_Objectecore_audio_output_add (Ecore_Audio_Type type)
 Create a new Ecore_Audio_Output instance.
 
void ecore_audio_output_name_set (Ecore_Audio_Object *output, const char *name)
 Set the name of an output.
 
const char * ecore_audio_output_name_get (Ecore_Audio_Object *output)
 Get the name of an output.
 
void ecore_audio_output_del (Ecore_Audio_Object *output)
 Free an Ecore_Audio_Output instance.
 
void ecore_audio_output_userdata_set (Ecore_Audio_Object *output, void *data)
 Set the user data pointer.
 
void * ecore_audio_output_userdata_get (Ecore_Audio_Object *output)
 Get the user data pointer.
 
void ecore_audio_output_volume_set (Ecore_Audio_Object *output, double volume)
 Set the volume of the output.
 
double ecore_audio_output_volume_get (Ecore_Audio_Object *output)
 Get the volume of the output.
 
void ecore_audio_output_paused_set (Ecore_Audio_Object *output, Eina_Bool paused)
 Set the paused state of an output.
 
Eina_Bool ecore_audio_output_paused_get (Ecore_Audio_Object *output)
 Get the paused state of an output.
 
Eina_Bool ecore_audio_output_input_add (Ecore_Audio_Object *output, Ecore_Audio_Object *input)
 Add an input to an output.
 
Eina_Bool ecore_audio_output_input_del (Ecore_Audio_Object *output, Ecore_Audio_Object *input)
 Disconnect an input from an output.
 
Eina_Listecore_audio_output_inputs_get (Ecore_Audio_Object *output)
 Get the inputs connected to an output.
 
Eina_Bool ecore_audio_output_input_chain_after (Ecore_Audio_Object *output, Ecore_Audio_Object *input, Ecore_Audio_Object *after)
 Set up an input to play after another input.
 
Ecore_Audio_Objectecore_audio_input_add (Ecore_Audio_Type type)
 Create a new Ecore_Audio_Input instance.
 
const char * ecore_audio_input_name_get (Ecore_Audio_Object *input)
 Get the name of an input.
 
void ecore_audio_input_name_set (Ecore_Audio_Object *input, const char *name)
 Set the name of an input.
 
void ecore_audio_input_del (Ecore_Audio_Object *input)
 Free an Ecore_Audio_Input instance.
 
void ecore_audio_input_userdata_set (Ecore_Audio_Object *input, void *data)
 Set the user data pointer.
 
void * ecore_audio_input_userdata_get (Ecore_Audio_Object *input)
 Get the user data pointer.
 
int ecore_audio_input_samplerate_get (Ecore_Audio_Object *input)
 Get the sample rate of the input.
 
void ecore_audio_input_samplerate_set (Ecore_Audio_Object *input, int samplerate)
 Set the sample rate of the input.
 
int ecore_audio_input_channels_get (Ecore_Audio_Object *input)
 Get the channels of the input.
 
void ecore_audio_input_channels_set (Ecore_Audio_Object *input, int channels)
 Set the amount of channels in the input.
 
double ecore_audio_input_seek (Ecore_Audio_Object *input, double offset, int mode)
 Seek within an input stream.
 
int ecore_audio_input_read (Ecore_Audio_Object *input, void *data, int len)
 Read data from an input stream.
 
Eina_Bool ecore_audio_input_paused_get (Ecore_Audio_Object *input)
 Get the paused state of an input.
 
void ecore_audio_input_paused_set (Ecore_Audio_Object *input, Eina_Bool paused)
 Set the paused state of an input.
 
void ecore_audio_input_volume_set (Ecore_Audio_Object *input, double volume)
 Set the volume of the input.
 
double ecore_audio_input_volume_get (Ecore_Audio_Object *input)
 Get the volume of the input.
 
void ecore_audio_input_looped_set (Ecore_Audio_Object *input, Eina_Bool looped)
 Set whether the input loops.
 
Eina_Bool ecore_audio_input_looped_get (Ecore_Audio_Object *input)
 Get whether the input loops.
 
double ecore_audio_input_length_get (Ecore_Audio_Object *input)
 Get the length of the input in seconds.
 
void ecore_audio_input_preloaded_set (Ecore_Audio_Object *input, Eina_Bool preloaded)
 Set whether the input is preloaded.
 
Eina_Bool ecore_audio_input_preloaded_get (Ecore_Audio_Object *input)
 Get whether the input is preloaded.
 
Ecore_Audio_Objectecore_audio_input_output_get (Ecore_Audio_Object *input)
 Get the outputs this input is connected to.
 
double ecore_audio_input_remaining_get (Ecore_Audio_Object *input)
 Get the remaining time of the input.
 
void ecore_audio_input_sndfile_filename_set (Ecore_Audio_Object *input, const char *filename)
 
void ecore_audio_input_sndfile_format_set (Ecore_Audio_Object *input, int format)
 
void ecore_audio_input_sndfile_vio_set (Ecore_Audio_Object *input, Ecore_Audio_Vio *vio)
 
void ecore_audio_output_sndfile_filename_set (Ecore_Audio_Object *output, const char *filename)
 
void ecore_audio_output_sndfile_format_set (Ecore_Audio_Object *output, int format)
 
void ecore_audio_output_sndfile_vio_set (Ecore_Audio_Object *output, Ecore_Audio_Vio *vio)
 
void ecore_audio_input_tone_frequency_set (Ecore_Audio_Object *input, int frequency)
 
void ecore_audio_input_tone_duration_set (Ecore_Audio_Object *input, double duration)
 
void ecore_audio_input_callback_setup (Ecore_Audio_Object *input, Ecore_Audio_Read_Callback read_cb, void *data)
 

Variables

int ECORE_AUDIO_INPUT_STARTED
 Sound was started.
 
int ECORE_AUDIO_INPUT_STOPPED
 Sound was stopped.
 
int ECORE_AUDIO_INPUT_LOOPED
 Sound looped.
 
int ECORE_AUDIO_INPUT_ENDED
 Sound playback ended.
 
int ECORE_AUDIO_INPUT_PAUSED
 Sound paused.
 
int ECORE_AUDIO_OUTPUT_INPUT_ADDED
 Input added to output.
 
int ECORE_AUDIO_OUTPUT_INPUT_REMOVED
 Input removed from output.
 

Detailed Description

Audio utility functions.