<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>gmerlin: bg_oa_plugin_s Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>bg_oa_plugin_s Struct Reference<br>
<small>
[<a class="el" href="group__plugin__oa.html">Audio output</a>]</small>
</h1><!-- doxytag: class="bg_oa_plugin_s" -->Audio output plugin.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="plugin_8h_source.html">plugin.h</a>></code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structbg__plugin__common__s.html">bg_plugin_common_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__oa__plugin__s.html#a2405c9bea071e64e6c3c13f6cca8895">common</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Infos and functions common to all plugin types. <a href="#a2405c9bea071e64e6c3c13f6cca8895"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__oa__plugin__s.html#6f6a250746a54b9c8ba116b87c9c8280">open</a> )(void *priv, <a class="elRef" doxygen="gavl.tags:http://gmerlin.sourceforge.net/doc/gavl//" href="http://gmerlin.sourceforge.net/doc/gavl//structgavl__audio__format__s.html">gavl_audio_format_t</a> *format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open plugin. <a href="#6f6a250746a54b9c8ba116b87c9c8280"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__oa__plugin__s.html#546d86e31a2ec883b18e1333dbe4a593">start</a> )(void *priv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start playback. <a href="#546d86e31a2ec883b18e1333dbe4a593"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__oa__plugin__s.html#79ecc0d60f67445facfe7e5ef56e298b">write_audio</a> )(void *priv, <a class="elRef" doxygen="gavl.tags:http://gmerlin.sourceforge.net/doc/gavl//" href="http://gmerlin.sourceforge.net/doc/gavl//structgavl__audio__frame__s.html">gavl_audio_frame_t</a> *frame)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write audio samples. <a href="#79ecc0d60f67445facfe7e5ef56e298b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__oa__plugin__s.html#1005e93e032d2c142780c8fa2c70af57">get_delay</a> )(void *priv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of buffered audio samples. <a href="#1005e93e032d2c142780c8fa2c70af57"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__oa__plugin__s.html#84a08621710863dfb728d08e285437b4">stop</a> )(void *priv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop playback. <a href="#84a08621710863dfb728d08e285437b4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__oa__plugin__s.html#5b24007bb35a7d07c47dcbd471997611">close</a> )(void *priv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close plugin. <a href="#5b24007bb35a7d07c47dcbd471997611"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Audio output plugin.
<p>
This plugin type implements audio playback through a soundcard. <hr><h2>Field Documentation</h2>
<a class="anchor" name="a2405c9bea071e64e6c3c13f6cca8895"></a><!-- doxytag: member="bg_oa_plugin_s::common" ref="a2405c9bea071e64e6c3c13f6cca8895" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbg__plugin__common__s.html">bg_plugin_common_t</a> <a class="el" href="structbg__oa__plugin__s.html#a2405c9bea071e64e6c3c13f6cca8895">bg_oa_plugin_s::common</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Infos and functions common to all plugin types.
<p>
</div>
</div><p>
<a class="anchor" name="6f6a250746a54b9c8ba116b87c9c8280"></a><!-- doxytag: member="bg_oa_plugin_s::open" ref="6f6a250746a54b9c8ba116b87c9c8280" args=")(void *priv, gavl_audio_format_t *format)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* <a class="el" href="structbg__oa__plugin__s.html#6f6a250746a54b9c8ba116b87c9c8280">bg_oa_plugin_s::open</a>)(void *priv, <a class="elRef" doxygen="gavl.tags:http://gmerlin.sourceforge.net/doc/gavl//" href="http://gmerlin.sourceforge.net/doc/gavl//structgavl__audio__format__s.html">gavl_audio_format_t</a> *format) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Open plugin.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>priv</em> </td><td>The handle returned by the create() method </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>The format of the media source</td></tr>
</table>
</dl>
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 <a class="elRef" doxygen="gavl.tags:http://gmerlin.sourceforge.net/doc/gavl//" href="http://gmerlin.sourceforge.net/doc/gavl//group__audio__converter.html#ga0">gavl_audio_converter_t</a>
</div>
</div><p>
<a class="anchor" name="546d86e31a2ec883b18e1333dbe4a593"></a><!-- doxytag: member="bg_oa_plugin_s::start" ref="546d86e31a2ec883b18e1333dbe4a593" args=")(void *priv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* <a class="el" href="structbg__oa__plugin__s.html#546d86e31a2ec883b18e1333dbe4a593">bg_oa_plugin_s::start</a>)(void *priv) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start playback.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>priv</em> </td><td>The handle returned by the create() method</td></tr>
</table>
</dl>
Notify the plugin, that audio playback is about to begin.
</div>
</div><p>
<a class="anchor" name="79ecc0d60f67445facfe7e5ef56e298b"></a><!-- doxytag: member="bg_oa_plugin_s::write_audio" ref="79ecc0d60f67445facfe7e5ef56e298b" args=")(void *priv, gavl_audio_frame_t *frame)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="structbg__oa__plugin__s.html#79ecc0d60f67445facfe7e5ef56e298b">bg_oa_plugin_s::write_audio</a>)(void *priv, <a class="elRef" doxygen="gavl.tags:http://gmerlin.sourceforge.net/doc/gavl//" href="http://gmerlin.sourceforge.net/doc/gavl//structgavl__audio__frame__s.html">gavl_audio_frame_t</a> *frame) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write audio samples.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>priv</em> </td><td>The handle returned by the create() method </td></tr>
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>The audio frame to write. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="1005e93e032d2c142780c8fa2c70af57"></a><!-- doxytag: member="bg_oa_plugin_s::get_delay" ref="1005e93e032d2c142780c8fa2c70af57" args=")(void *priv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* <a class="el" href="structbg__oa__plugin__s.html#1005e93e032d2c142780c8fa2c70af57">bg_oa_plugin_s::get_delay</a>)(void *priv) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of buffered audio samples.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>priv</em> </td><td>The handle returned by the create() method </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of buffered samples (both soft- and hardware)</dd></dl>
This function is used for A/V synchronization with the soundcard. If this function is NULL, software synchronization will be used
</div>
</div><p>
<a class="anchor" name="84a08621710863dfb728d08e285437b4"></a><!-- doxytag: member="bg_oa_plugin_s::stop" ref="84a08621710863dfb728d08e285437b4" args=")(void *priv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="structbg__oa__plugin__s.html#84a08621710863dfb728d08e285437b4">bg_oa_plugin_s::stop</a>)(void *priv) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop playback.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>priv</em> </td><td>The handle returned by the create() method</td></tr>
</table>
</dl>
Notify the plugin, that playback will stop. Playback can be starzed again with <a class="el" href="structbg__oa__plugin__s.html#546d86e31a2ec883b18e1333dbe4a593" title="Start playback.">start()</a>.
</div>
</div><p>
<a class="anchor" name="5b24007bb35a7d07c47dcbd471997611"></a><!-- doxytag: member="bg_oa_plugin_s::close" ref="5b24007bb35a7d07c47dcbd471997611" args=")(void *priv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="structbg__oa__plugin__s.html#5b24007bb35a7d07c47dcbd471997611">bg_oa_plugin_s::close</a>)(void *priv) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close plugin.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>priv</em> </td><td>The handle returned by the create() method</td></tr>
</table>
</dl>
Close the plugin. After this call, the plugin can be opened with another format
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>/home/mandrake/rpm/BUILD/gmerlin-0.4.1/include/gmerlin/<a class="el" href="plugin_8h_source.html">plugin.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 22 01:28:05 2009 for gmerlin by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
874255f3b26b44feb57fbe38a7384518
>
files
>
264
