doc/xine-lib-API/html/group__browse__group.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
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> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </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 &nbsp;</td><td valign=bottom><a class="el" href="structmrl__t.html">mrl_t</a></td></tr>
<tr><td nowrap align=right valign=top>struct &nbsp;</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&nbsp;</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&nbsp;</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&nbsp;</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**&nbsp;</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>&nbsp;</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>**&nbsp;</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>&nbsp;</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&nbsp;)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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&nbsp;)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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&nbsp;)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<b>Value:</b><div class="fragment"><pre>  {                                                         \
  <font class="keywordflow">if</font>((m)) {                                                                   \
    <font class="keywordflow">if</font>((m)-&gt;origin)                                                           \
      free((m)-&gt;origin);                                                      \
    <font class="keywordflow">if</font>((m)-&gt;mrl)                                                              \
      free((m)-&gt;mrl);                                                         \
    <font class="keywordflow">if</font>((m)-&gt;link)                                                             \
      free((m)-&gt;link);                                                        \
    (m)-&gt;origin = NULL;                                                       \
    (m)-&gt;mrl    = NULL;                                                       \
    (m)-&gt;link   = NULL;                                                       \
    (m)-&gt;type   = 0;                                                          \
    (m)-&gt;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>&nbsp;)
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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>
&nbsp;</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>
&nbsp;</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>&nbsp;)
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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>
&nbsp;</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>
&nbsp;</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>
&nbsp;</td><td>
MRL </td></tr>
<tr><td valign=top><em>num_mrl</em>
&nbsp;</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 &lt;plugin_id&gt; to return a list of available MRLs in domain/directory &lt;start_mrl&gt;.
<p>
&lt;start_mrl&gt; may be NULL indicating the toplevel domain/dir returns &lt;start_mrl&gt; if &lt;start_mrl&gt; is a valid MRL, not a directory returns NULL if &lt;start_mrl&gt; 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>
&nbsp;</td><td>
 </td></tr>
<tr><td valign=top><em>plugin_id</em>
&nbsp;</td><td>
 </td></tr>
<tr><td valign=top><em>start_mrl</em>
&nbsp;</td><td>
 </td></tr>
<tr><td valign=top><em>num_mrls</em>
&nbsp;</td><td>
 </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<hr><address><small>Generated at Fri Oct 5 14:17:33 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>,
 &copy;&nbsp;1997-2001</small></address>
</body>
</html>