Commit 85980394 authored by brendan's avatar brendan
Browse files

Started writing some docs, then got bored.

svn path=/trunk/libshout/; revision=5059
parent 93eacf83
......@@ -3,7 +3,7 @@
AUTOMAKE_OPTIONS = foreign
ACLOCAL_AMFLAGS = -I m4
SUBDIRS = include src examples
SUBDIRS = include src examples doc
EXTRA_DIST = INSTALL m4/shout.m4 m4/ac_config_libconfig_in.m4 m4/acx_pthread.m4 \
m4/ogg.m4 m4/vorbis.m4 m4/xiph_compiler.m4 m4/xiph_net.m4 \
......
# Process this file with autoconf to produce a configure script.
# $Id: configure.in,v 1.57 2003/07/02 18:32:50 brendan Exp $
# $Id: configure.in,v 1.58 2003/07/04 02:20:41 brendan Exp $
m4_define(libshout_major, 2)
m4_define(libshout_minor, 0)
......@@ -162,4 +162,4 @@ AC_SUBST(XIPH_CFLAGS)
AC_OUTPUT([Makefile include/Makefile include/shout/Makefile src/Makefile
src/net/Makefile src/timing/Makefile src/thread/Makefile src/avl/Makefile
src/httpp/Makefile examples/Makefile shout-config shout.pc])
src/httpp/Makefile doc/Makefile examples/Makefile shout-config shout.pc])
Makefile.in
AUTOMAKE_OPTIONS = foreign
EXTRA_DIST = spec-html.xsl libshout.xml
<?xml version="1.0" standalone="no"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2.0//EN"
"http://docbook.org/xml/4.2/docbookx.dtd">
<book><title>Programming With Libshout 2</title>
<bookinfo>
<!--
<author>
<firstname>Brendan</firstname><surname>Cully</surname>
<email>brendan@xiph.org</email>
</author>
<copyright>
<year>2003</year>
<holder>Brendan Cully</holder>
</copyright>
-->
<orgname><ulink url="http://xiph.org/">Xiph.org</ulink></orgname>
<releaseinfo>$Id: libshout.xml,v 1.1 2003/07/04 02:20:41 brendan Exp $</releaseinfo>
<date> 3 Jul 2003</date>
</bookinfo>
<chapter><title>Overview</title>
<para>
libshout is a library for streaming audio to icecast or shoutcast-compatible
servers. Currently it supports two audio formats and three protocols.
</para>
<itemizedlist><title>Audio Formats</title>
<listitem>Ogg Vorbis</listitem>
<listitem>MP3</listitem>
</itemizedlist>
<itemizedlist><title>Protocols</title>
<listitem>HTTP</listitem>
<listitem>Audiocast</listitem>
<listitem>ShoutCast</listitem>
</itemizedlist>
</chapter>
<chapter><title>Function Reference</title>
<funcsynopsis id="shout_init">
<funcprototype>
<funcdef>void <function>shout_init</function></funcdef>
<void/>
</funcprototype>
<funcsynopsisinfo>
Initializes the shout library. Currently this initializes the networking
mutexes when the library is built with thread safety. This function must
always be called before any other libshout function.
</funcsynopsisinfo>
</funcsynopsis>
<funcsynopsis id="shout_shutdown">
<funcprototype>
<funcdef>void <function>shout_shutdown</function></funcdef>
<void/>
</funcprototype>
<funcsynopsisinfo>
Releases any resources which may have been allocated by a call to
<link linkend="shout_init">shout_init</link>. An application should call this
function after it has finished using libshout.
</funcsynopsisinfo>
</funcsynopsis>
<funcsynopsis id="shout_version">
<funcprototype>
<funcdef>const char *<function>shout_version</function></funcdef>
<paramdef>int *<parameter>major</parameter></paramdef>
<paramdef>int *<parameter>minor</parameter></paramdef>
<paramdef>int *<parameter>patch</parameter></paramdef>
</funcprototype>
<funcsynopsisinfo>
Returns the version of the libshout library, both as a string via the
return value, and as a set of integers corresponding to the major,
minor and patch levels of the library. The application must allocate
the integer parameters. If any parameter is NULL, libshout will not
attempt to set it.
</funcsynopsisinfo>
</funcsynopsis>
<funcsynopsis id="shout_new">
<funcprototype>
<funcdef><type>shout_t</type> <function>shout_new</function></funcdef>
<void/>
</funcprototype>
<funcsynopsisinfo>
Allocates a new <type>shout_t</type> structure. May return NULL if no memory
is available. The result should be disposed of with
<link linkend="shout_free">shout_free</link> when you are finished with it.
</funcsynopsisinfo>
</funcsynopsis>
<funcsynopsis id="shout_free">
<funcprototype>
<funcdef>void <function>shout_free</function></funcdef>
<paramdef><type>shout_t</type> <parameter>self</parameter></paramdef>
</funcprototype>
<funcsynopsisinfo>
Frees a <type>shout_t</type> allocated by <link linkend="shout_new">shout_new</link>.
</funcsynopsisinfo>
</funcsynopsis>
</chapter>
</book>
\ No newline at end of file
<?xml version='1.0'?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:import href="file:///sw/share/xml/xsl/html/docbook.xsl"/>
</xsl:stylesheet>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment