bg_oa_plugin_s Struct Reference
[Audio output]

Audio output plugin. More...

#include <plugin.h>


Data Fields

bg_plugin_common_t common
 Infos and functions common to all plugin types.
int(* open )(void *priv, gavl_audio_format_t *format)
 Open plugin.
int(* start )(void *priv)
 Start playback.
void(* write_audio )(void *priv, gavl_audio_frame_t *frame)
 Write audio samples.
int(* get_delay )(void *priv)
 Get the number of buffered audio samples.
void(* stop )(void *priv)
 Stop playback.
void(* close )(void *priv)
 Close plugin.


Detailed Description

Audio output plugin.

This plugin type implements audio playback through a soundcard.


Field Documentation

bg_plugin_common_t bg_oa_plugin_s::common

Infos and functions common to all plugin types.

int(* bg_oa_plugin_s::open)(void *priv, gavl_audio_format_t *format)

Open plugin.

Parameters:
priv The handle returned by the create() method
format The format of the media source
The format will be changed to the nearest format, which is supported by the plugin. To convert the source format to the output format, use a gavl_audio_converter_t

int(* bg_oa_plugin_s::start)(void *priv)

Start playback.

Parameters:
priv The handle returned by the create() method
Notify the plugin, that audio playback is about to begin.

void(* bg_oa_plugin_s::write_audio)(void *priv, gavl_audio_frame_t *frame)

Write audio samples.

Parameters:
priv The handle returned by the create() method
frame The audio frame to write.

int(* bg_oa_plugin_s::get_delay)(void *priv)

Get the number of buffered audio samples.

Parameters:
priv The handle returned by the create() method
Returns:
The number of buffered samples (both soft- and hardware)
This function is used for A/V synchronization with the soundcard. If this function is NULL, software synchronization will be used

void(* bg_oa_plugin_s::stop)(void *priv)

Stop playback.

Parameters:
priv The handle returned by the create() method
Notify the plugin, that playback will stop. Playback can be starzed again with start().

void(* bg_oa_plugin_s::close)(void *priv)

Close plugin.

Parameters:
priv The handle returned by the create() method
Close the plugin. After this call, the plugin can be opened with another format


The documentation for this struct was generated from the following file:
Generated on Tue Jul 28 01:06:53 2009 for gmerlin by  doxygen 1.5.4