libvisual  0.5.0
Namespaces | Classes | Typedefs | Functions
VisInput
Collaboration diagram for VisInput:

Namespaces

namespace  LV
 Libvisual namespace.
 

Classes

struct  VisInputPlugin
 Input plugin class. More...
 

Typedefs

typedef LV::Input VisInput
 
typedef int(* VisInputUploadCallbackFunc )(VisInput *input, VisAudio *audio, void *user_data)
 Function signature and type of input custom PCM data callbacks. More...
 
typedef int(* VisPluginInputUploadFunc )(VisPluginData *plugin, VisAudio *audio)
 Function signature and type of the Input upload() method. More...
 

Functions

VisInputvisual_input_new (const char *name)
 
void visual_input_ref (VisInput *input)
 
void visual_input_unref (VisInput *input)
 
int visual_input_realize (VisInput *input)
 
int visual_input_run (VisInput *input)
 
VisPluginData * visual_input_get_plugin (VisInput *input)
 
VisAudiovisual_input_get_audio (VisInput *audio)
 
void visual_input_set_callback (VisInput *input, VisInputUploadCallbackFunc callback, void *user_data)
 
const char * visual_input_get_next_by_name (const char *name)
 Returns the name of the next available input plugin. More...
 
const char * visual_input_get_prev_by_name (const char *name)
 Returns the name of the previous available input plugin. More...
 

Detailed Description

Typedef Documentation

typedef int(* VisInputUploadCallbackFunc)(VisInput *input, VisAudio *audio, void *user_data)

Function signature and type of input custom PCM data callbacks.

See Also
visual_input_set_callback()
Parameters
inputInput object
audioAudio object to upload data to
user_dataData set in visual_input_set_callback()

Definition at line 149 of file lv_input.h.

typedef int(* VisPluginInputUploadFunc)(VisPluginData *plugin, VisAudio *audio)

Function signature and type of the Input upload() method.

The upload() method is called to produce audio samples for rendering by Actors.

Parameters
pluginPlugin object
audioAudio object to upload data to
Returns
0 on success, -1 on error.

Definition at line 161 of file lv_input.h.

Function Documentation

const char* visual_input_get_next_by_name ( const char *  name)

Returns the name of the next available input plugin.

See Also
visual_input_get_prev_by_name()
Parameters
nameName of current plugin, or NULL to get the first
Returns
Name of next available plugin

Definition at line 103 of file lv_input_c.cpp.

const char* visual_input_get_prev_by_name ( const char *  name)

Returns the name of the previous available input plugin.

See Also
visual_input_get_next_by_name()
Parameters
nameName of current plugin, or NULL to get the last
Returns
Name of previous available plugin

Definition at line 108 of file lv_input_c.cpp.