diff options
Diffstat (limited to 'doc/xine-lib-API/html/group__browse__group.html')
| -rw-r--r-- | doc/xine-lib-API/html/group__browse__group.html | 285 |
1 files changed, 285 insertions, 0 deletions
diff --git a/doc/xine-lib-API/html/group__browse__group.html b/doc/xine-lib-API/html/group__browse__group.html new file mode 100644 index 000000000..e693bb0e9 --- /dev/null +++ b/doc/xine-lib-API/html/group__browse__group.html @@ -0,0 +1,285 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</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> </center> +<hr><h1>Browsing support</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Modules</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__mrl__types.html">Types of available mrls</a></td></tr> +<tr><td colspan=2><br><h2>Data Structures</h2></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structmrl__t.html">mrl_t</a></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structmrl__t.html">mrl_t</a></td></tr> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="browse_group::MRL_ZERO"></a> +#define </td><td valign=bottom><a class="el" href="group__browse__group.html#a2">MRL_ZERO</a>(m)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="browse_group::MRL_DUPLICATE"></a> +#define </td><td valign=bottom><a class="el" href="group__browse__group.html#a3">MRL_DUPLICATE</a>(s, d)</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="browse_group::MRLS_DUPLICATE"></a> +#define </td><td valign=bottom><a class="el" href="group__browse__group.html#a4">MRLS_DUPLICATE</a>(s, d)</td></tr> +<tr><td colspan=2><br><h2>Functions</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="browse_group::xine_get_browsable_input_plugin_ids"></a> +char** </td><td valign=bottom><a class="el" href="group__browse__group.html#a0">xine_get_browsable_input_plugin_ids</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Request list of browsable featured plugins.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="browse_group::xine_get_browse_mrls"></a> +<a class="el" href="structmrl__t.html">mrl_t</a>** </td><td valign=bottom><a class="el" href="group__browse__group.html#a1">xine_get_browse_mrls</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, char *plugin_id, char *start_mrl, int *num_mrls)</td></tr> +<tr><td> </td><td><font size=-1><em>Request available MRLs from plugins.</em></font><br><br></td></tr> +</table> +<hr><h2>Define Documentation</h2> +<a name="a4" doxytag="xine.h::MRLS_DUPLICATE"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define MRLS_DUPLICATE( + </b></td> + <td valign="bottom"><b> +s, d ) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<b>Value:</b><div class="fragment"><pre> { \ + <font class="keywordtype">int</font> i = 0; \ + \ + assert((s) != NULL); \ + assert((d) != NULL); \ + \ + <font class="keywordflow">while</font>((s) != NULL) { \ + d[i] = (<a class="code" href="structmrl__t.html">mrl_t</a> *) malloc(<font class="keyword">sizeof</font>(<a class="code" href="structmrl__t.html">mrl_t</a>)); \ + <a class="code" href="xine_8h.html#a3">MRL_DUPLICATE</a>(s[i], d[i]); \ + i++; \ + } \ +}</pre></div>Duplicate two arrays of mrls (s = source, d = destination). <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a>, <a class="el" href="xine_8h.html#a1">xine_get_browse_mrls</a>() </dl> </td> + </tr> +</table> +<a name="a3" doxytag="xine.h::MRL_DUPLICATE"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define MRL_DUPLICATE( + </b></td> + <td valign="bottom"><b> +s, d ) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Duplicate two mrls entries (s = source, d = destination). <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a>, <a class="el" href="xine_8h.html#a1">xine_get_browse_mrls</a>() </dl> </td> + </tr> +</table> +<a name="a2" doxytag="xine.h::MRL_ZERO"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define MRL_ZERO( + </b></td> + <td valign="bottom"><b> +m ) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<b>Value:</b><div class="fragment"><pre> { \ + <font class="keywordflow">if</font>((m)) { \ + <font class="keywordflow">if</font>((m)->origin) \ + free((m)->origin); \ + <font class="keywordflow">if</font>((m)->mrl) \ + free((m)->mrl); \ + <font class="keywordflow">if</font>((m)->link) \ + free((m)->link); \ + (m)->origin = NULL; \ + (m)->mrl = NULL; \ + (m)->link = NULL; \ + (m)->type = 0; \ + (m)->size = (off_t) 0; \ + } \ +}</pre></div>Freeing/zeroing all of entries of given mrl. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a>, <a class="el" href="xine_8h.html#a1">xine_get_browse_mrls</a>() </dl> </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a name="a0" doxytag="xine.h::xine_get_browsable_input_plugin_ids"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char ** xine_get_browsable_input_plugin_ids ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Request list of browsable featured plugins. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +List of plugins +<p> +</dl>Some input plugins are browseable, get the list of ids of these plugins. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::xine_get_browse_mrls"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="structmrl__t.html">mrl_t</a> ** xine_get_browse_mrls ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +char * <em>plugin_id</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +char * <em>start_mrl</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int * <em>num_mrls</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Request available MRLs from plugins. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +<tr><td valign=top><em>plugin_id</em> + </td><td> +Plugin name ( see <a class="el" href="xine_8h.html#a0">xine_get_browsable_input_plugin_ids</a>() ) </td></tr> +<tr><td valign=top><em>start_mrl</em> + </td><td> +MRL </td></tr> +<tr><td valign=top><em>num_mrl</em> + </td><td> +how many mrls was found </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +start_mrl on success, NULL on failure. +<p> +</dl>Asks input plugin named <plugin_id> to return a list of available MRLs in domain/directory <start_mrl>. +<p> +<start_mrl> may be NULL indicating the toplevel domain/dir returns <start_mrl> if <start_mrl> is a valid MRL, not a directory returns NULL if <start_mrl> is an invalid MRL, not even a directory. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +<tr><td valign=top><em>plugin_id</em> + </td><td> + </td></tr> +<tr><td valign=top><em>start_mrl</em> + </td><td> + </td></tr> +<tr><td valign=top><em>num_mrls</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> |