filters.sgml

linphone源码-1.3.5.tar.gz,linphone源码-1.3.5.tar.gz

<refentry id="mediastreamer-Filters">
<refmeta>
<refentrytitle>MSFilters</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>MEDIASTREAMER Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>MSFilters</refname><refpurpose>The basic mediastreamer element.</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>

#include &lt;msfilter.h&gt;


            <link linkend="MSFilter">MSFilter</link>;
<link linkend="int">int</link>         <link linkend="ms-filter-add-link">ms_filter_add_link</link>              (<link linkend="MSFilter">MSFilter</link> *m1,
                                             <link linkend="MSFilter">MSFilter</link> *m2);
</synopsis>
</refsynopsisdiv>









<refsect1>
<title>Description</title>
<para>
MSFilter is the base class for all mediastreamer processing filters: codec compression, soundcard read, souncard write, etc...
MSFilter objects have to be linked between them to form a processing chain, that is then attached to a MSSync object (synchronisation source)
in order to be scheduled for processing.
</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="MSFilter">MSFilter</title>
<indexterm><primary>MSFilter</primary></indexterm><programlisting>typedef struct _MSFilter MSFilter;</programlisting>
<para>
Only programmers implementing derivated objects of MSFilter are interested by the content of the structure.
</para></refsect2>
<refsect2>
<title><anchor id="ms-filter-add-link">ms_filter_add_link ()</title>
<indexterm><primary>ms_filter_add_link</primary></indexterm><programlisting><link linkend="int">int</link>         ms_filter_add_link              (<link linkend="MSFilter">MSFilter</link> *m1,
                                             <link linkend="MSFilter">MSFilter</link> *m2);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>m1</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>m2</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>