<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>AlsaPlayer: _scope_plugin struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.3 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div>
<h1>_scope_plugin Struct Reference</h1><code>#include <<a class="el" href="scope__plugin_8h-source.html">scope_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="scope__plugin_8h.html#a7">scope_version_type</a> </td><td class="memItemRight" valign=bottom><a class="el" href="struct__scope__plugin.html#o0">version</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="struct__scope__plugin.html#o1">name</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="struct__scope__plugin.html#o2">author</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void * </td><td class="memItemRight" valign=bottom><a class="el" href="struct__scope__plugin.html#o3">handle</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="scope__plugin_8h.html#a8">scope_init_type</a> </td><td class="memItemRight" valign=bottom><a class="el" href="struct__scope__plugin.html#o4">init</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="scope__plugin_8h.html#a9">scope_start_type</a> </td><td class="memItemRight" valign=bottom><a class="el" href="struct__scope__plugin.html#o5">start</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="scope__plugin_8h.html#a10">scope_running_type</a> </td><td class="memItemRight" valign=bottom><a class="el" href="struct__scope__plugin.html#o6">running</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="scope__plugin_8h.html#a11">scope_stop_type</a> </td><td class="memItemRight" valign=bottom><a class="el" href="struct__scope__plugin.html#o7">stop</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="scope__plugin_8h.html#a12">scope_shutdown_type</a> </td><td class="memItemRight" valign=bottom><a class="el" href="struct__scope__plugin.html#o8">shutdown</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="scope__plugin_8h.html#a13">scope_set_data_type</a> </td><td class="memItemRight" valign=bottom><a class="el" href="struct__scope__plugin.html#o9">set_data</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="scope__plugin_8h.html#a14">scope_set_fft_type</a> </td><td class="memItemRight" valign=bottom><a class="el" href="struct__scope__plugin.html#o10">set_fft</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
You should declare a scope_plugin variable and populate it with pointers of the specific functions implemented by your scope
<p>
<hr><h2>Field Documentation</h2>
<a name="o2" doxytag="_scope_plugin::author"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char* <a class="el" href="struct__scope__plugin.html#o2">_scope_plugin::author</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Point to a character array with the name of the author(s) of the scope </td>
</tr>
</table>
<a name="o3" doxytag="_scope_plugin::handle"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void* <a class="el" href="struct__scope__plugin.html#o3">_scope_plugin::handle</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Pointer to a dlopen() handle. This is filled in by the HOST. Set to NULL. </td>
</tr>
</table>
<a name="o4" doxytag="_scope_plugin::init"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="scope__plugin_8h.html#a8">scope_init_type</a> <a class="el" href="struct__scope__plugin.html#o4">_scope_plugin::init</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Should point to the implentation of your <a class="el" href="struct__scope__plugin.html#o4">init()</a> function. Required by the HOST. </td>
</tr>
</table>
<a name="o1" doxytag="_scope_plugin::name"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char* <a class="el" href="struct__scope__plugin.html#o1">_scope_plugin::name</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Point to a character array with the name of the scope </td>
</tr>
</table>
<a name="o6" doxytag="_scope_plugin::running"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="scope__plugin_8h.html#a10">scope_running_type</a> <a class="el" href="struct__scope__plugin.html#o6">_scope_plugin::running</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Should point to the implementation of your <a class="el" href="struct__scope__plugin.html#o6">running()</a> function. Required by the HOST. </td>
</tr>
</table>
<a name="o9" doxytag="_scope_plugin::set_data"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="scope__plugin_8h.html#a13">scope_set_data_type</a> <a class="el" href="struct__scope__plugin.html#o9">_scope_plugin::set_data</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Should point to the function that collects PCM data. If you don't want PCM data set to NULL. </td>
</tr>
</table>
<a name="o10" doxytag="_scope_plugin::set_fft"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="scope__plugin_8h.html#a14">scope_set_fft_type</a> <a class="el" href="struct__scope__plugin.html#o10">_scope_plugin::set_fft</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Should point to the function that collects FFT data. If you don't want FFT data set to NULL. NB. set_data and set_fft can't both be NULL, at least one must be set. </td>
</tr>
</table>
<a name="o8" doxytag="_scope_plugin::shutdown"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="scope__plugin_8h.html#a12">scope_shutdown_type</a> <a class="el" href="struct__scope__plugin.html#o8">_scope_plugin::shutdown</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Should point to the implementation of your <a class="el" href="struct__scope__plugin.html#o8">shutdown()</a> function. Required by the HOST. </td>
</tr>
</table>
<a name="o5" doxytag="_scope_plugin::start"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="scope__plugin_8h.html#a9">scope_start_type</a> <a class="el" href="struct__scope__plugin.html#o5">_scope_plugin::start</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Should point to the implementation of your <a class="el" href="struct__scope__plugin.html#o5">start()</a> function. Required by the HOST. </td>
</tr>
</table>
<a name="o7" doxytag="_scope_plugin::stop"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="scope__plugin_8h.html#a11">scope_stop_type</a> <a class="el" href="struct__scope__plugin.html#o7">_scope_plugin::stop</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Should point to the implementation of your <a class="el" href="struct__scope__plugin.html#o7">stop()</a> function. Required by the HOST. </td>
</tr>
</table>
<a name="o0" doxytag="_scope_plugin::version"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="scope__plugin_8h.html#a7">scope_version_type</a> <a class="el" href="struct__scope__plugin.html#o0">_scope_plugin::version</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set to SCOPE_PLUGIN_VERSION </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="scope__plugin_8h-source.html">scope_plugin.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 9 10:09:57 2003 for AlsaPlayer by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.3 </small></address>
</body>
</html>
