<refentry id="streamtuner-st-stream-api">
<refmeta>
<refentrytitle>STStream</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>STREAMTUNER Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>STStream</refname><refpurpose>a structure for defining a stream.</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



struct      <link linkend="STStream">STStream</link>;
<link linkend="STStream">STStream</link>*   <link linkend="st-stream-new">st_stream_new</link>                   (void);
<link linkend="void">void</link>        <link linkend="st-stream-free">st_stream_free</link>                  (<link linkend="STStream">STStream</link> *stream);
</synopsis>
</refsynopsisdiv>









<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="STStream"/>struct STStream</title>
<indexterm><primary>STStream</primary></indexterm><programlisting>struct STStream {

  char		*name;
};
</programlisting>
<para>

</para><variablelist role="struct">
<varlistentry>
<term><link linkend="char">char</link> *<structfield>name</structfield></term>
<listitem><simpara>the stream internal name.

</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-stream-new"/>st_stream_new ()</title>
<indexterm><primary>st_stream_new</primary></indexterm><programlisting><link linkend="STStream">STStream</link>*   st_stream_new                   (void);</programlisting>
<para>
Creates a new <link linkend="STStream"><type>STStream</type></link>. The structure members are initialized to
<literal>NULL</literal>, and the <structfield>name</structfield> member must be
filled manually.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="STStream"><type>STStream</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-stream-free"/>st_stream_free ()</title>
<indexterm><primary>st_stream_free</primary></indexterm><programlisting><link linkend="void">void</link>        st_stream_free                  (<link linkend="STStream">STStream</link> *stream);</programlisting>
<para>
Destroys <parameter>stream</parameter> (<link linkend="g-free"><function>g_free()</function></link> will be called on the
<structfield>name</structfield> member).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="STStream"><type>STStream</type></link> to destroy.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>



<refsect1>
<title>See Also</title>
<para>
<link linkend="STHandlerEvent"><type>STHandlerEvent</type></link>, <link linkend="st-handler-set-stream-version"><function>st_handler_set_stream_version()</function></link>,
<link linkend="st-handler-add-field"><function>st_handler_add_field()</function></link>
</para>
</refsect1>

</refentry>
