Commit e971163d authored by Jean-Paul Saman's avatar Jean-Paul Saman

doc/{index,usage}.doxygen: adjust for new API

parent d9da1097
...@@ -15,7 +15,9 @@ describes how to use it and the "C" API.</p> ...@@ -15,7 +15,9 @@ describes how to use it and the "C" API.</p>
<h2>What is libdvbpsi ?</h2> <h2>What is libdvbpsi ?</h2>
<p><em>libdvbpsi</em> is a set of tools which allows to decode and generate all the Program specific Information (<em>PSI</em>) present in a MPEG2 TS or a DVB stream.</p> <p><em>libdvbpsi</em> is a library that provides API's to decode and generate all the Program specific Information (<em>PSI</em>) and descriptors present in a MPEG2 TS or a DVB stream.</p>
<p><b><em>libdvbpsi</em> version 1.0.0 breaks API compatibility with earlier versions</b>. The benefits are a more consistent API and the library no longer makes calls to printf which improves its use in threaded applications.</p>
<p>The two keywords are <em>portability</em> and <em>simplicity</em>.</p> <p>The two keywords are <em>portability</em> and <em>simplicity</em>.</p>
......
/*! \page usage API usage /*! \page usage API usage
<p>When the application needs a new decoder it just has to call the <p>Each application requires a handle to the dvbpsi library. The function
dvbpsi_NewHandle(&message_cb, DVBPSI_MSG_DEBUG) will return a handle. All
error, warning or debug messages will trigger the <em>message_cb</em> function.
Unless DVBPSI_MSG_NONE is passed to dvbpsi_NewHandle(). For each <em>
dvbpsi_AttachXXX()</em> function a unique dvbpsi handle must be used.</p>
<p>A dvbpsi handle must be passed to an <em>dvbpsi_AttachXXX()</em> function
which attaches a decoder to the (dvbpsi_t*)->p_private pointer. The
<em>dvbpsi_AttachXXX()</em> function where XXX is the name of the table <em>dvbpsi_AttachXXX()</em> function where XXX is the name of the table
(ex: dvbpsi_AttachPAT()). The function returns a handle on the new (ex: dvbpsi_AttachPAT()). The function returns the dvbpsi handle with the
decoder.</p> new decoder attached decoder.</p>
<p>Then the application has to send the TS packets needed by the decoder <p>Then the application has to send the TS packets needed by the decoder
by calling the dvbpsi_PushPacket() function. If a new table is complete by calling the dvbpsi_PushPacket() function. If a new table is complete
...@@ -12,10 +19,9 @@ called <em>dvbpsi_AttachXXX()</em>.</p> ...@@ -12,10 +19,9 @@ called <em>dvbpsi_AttachXXX()</em>.</p>
<p>When the application don't need the decoder anymore it just has to <p>When the application don't need the decoder anymore it just has to
call the <em>dvbpsi_DetachXXX()</em> function (ex: call the <em>dvbpsi_DetachXXX()</em> function (ex:
dvbpsi_DetachPAT()).</p> dvbpsi_DetachPAT()). The dvbpsi handle must be released by calling
dvbpsi_DeleteHandle(). At the time of calling the decoder must already
<p>In this version of <em>libdvbpsi</em> the descriptors aren't decoded. have been detached.</p>
These decoders will come in the next release.</p>
<p>For specific tools, the best to do is to have a look at the include <p>For specific tools, the best to do is to have a look at the include
file:</p> file:</p>
......
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