diff options
Diffstat (limited to 'doc/xine-lib-API/html/group__xine__management.html')
| -rw-r--r-- | doc/xine-lib-API/html/group__xine__management.html | 583 |
1 files changed, 583 insertions, 0 deletions
diff --git a/doc/xine-lib-API/html/group__xine__management.html b/doc/xine-lib-API/html/group__xine__management.html new file mode 100644 index 000000000..0741a0136 --- /dev/null +++ b/doc/xine-lib-API/html/group__xine__management.html @@ -0,0 +1,583 @@ +<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>Engine management</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Functions</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine_management::xine_play"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a0">xine_play</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, char *MRL, int pos)</td></tr> +<tr><td> </td><td><font size=-1><em>Start to play a stream.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine_management::xine_pause"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a1">xine_pause</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Pause toggle.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine_management::xine_stop"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a2">xine_stop</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Stop playing.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine_management::xine_eject"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a3">xine_eject</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Eject media.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="xine_management::xine_get_status"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a4">xine_get_status</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Get current xine status.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="xine_management::xine_get_current_position"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a5">xine_get_current_position</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Get current position.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="xine_management::xine_get_audio_channel"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a6">xine_get_audio_channel</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Get current audio channel.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="xine_management::xine_select_audio_channel"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a7">xine_select_audio_channel</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, int channel)</td></tr> +<tr><td> </td><td><font size=-1><em>Set audio channel.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a8" doxytag="xine_management::xine_get_spu_channel"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a8">xine_get_spu_channel</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Get current sub-title channel.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a9" doxytag="xine_management::xine_select_spu_channel"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a9">xine_select_spu_channel</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, int channel)</td></tr> +<tr><td> </td><td><font size=-1><em>Set sub-title channel.</em></font><br><br></td></tr> +</table> +<hr><h2>Function Documentation</h2> +<a name="a3" doxytag="xine.h::xine_eject"></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> +int xine_eject ( + </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> +Eject media. +<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> +1 on success, 0 on failure. +<p> +</dl>Tell current input plugin to eject media. <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="a6" doxytag="xine.h::xine_get_audio_channel"></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> +int xine_get_audio_channel ( + </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> +Get current audio channel. +<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> +Current audio chennel +<p> +</dl>Get current audio channel. <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="a5" doxytag="xine.h::xine_get_current_position"></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> +int xine_get_current_position ( + </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> +Get current position. +<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> +Current position ( 0..65535 ) +<p> +</dl>Get current position in stream. <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="a8" doxytag="xine.h::xine_get_spu_channel"></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> +int xine_get_spu_channel ( + </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> +Get current sub-title channel. +<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> +Current sub-title channel +<p> +</dl>Get current sub-title channel. <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="a4" doxytag="xine.h::xine_get_status"></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> +int xine_get_status ( + </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> +Get current xine status. +<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> +Current status ( see <a href="group__status__group.html">Player status constants</a> ) +<p> +</dl>Return the current state of xine engine. <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_pause"></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> +void xine_pause ( + </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> +Pause toggle. +<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> +Nothing +<p> +</dl>Toggle pause mode. <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="a0" doxytag="xine.h::xine_play"></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> +void xine_play ( + </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>MRL</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>pos</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Start to play a stream. +<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>MRL</em> + </td><td> +Media Resource Location to open </td></tr> +<tr><td valign=top><em>pos</em> + </td><td> +Start from position (0..65535) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Nothing +<p> +</dl>Open a stream and play it <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>MRL</em> + </td><td> + </td></tr> +<tr><td valign=top><em>pos</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a7" doxytag="xine.h::xine_select_audio_channel"></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> +void xine_select_audio_channel ( + </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> +int <em>channel</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set audio channel. +<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> +Nothing +<p> +</dl>Set desired audio channel. <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>channel</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a9" doxytag="xine.h::xine_select_spu_channel"></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> +void xine_select_spu_channel ( + </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> +int <em>channel</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set sub-title channel. +<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> +Nothing +<p> +</dl>Set desired sub-title channel. <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>channel</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a2" doxytag="xine.h::xine_stop"></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> +void xine_stop ( + </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> +Stop playing. +<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> +Nothing +<p> +</dl>Stop the playback. <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> +<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> |