<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>gmerlin: Commands, which can be sent to the player</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Commands, which can be sent to the player<br>
<small>
[<a class="el" href="group__player.html">Player</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#g2ab0db7b5742ae8436be219cd1de58c8">BG_PLAY_FLAG_IGNORE_IF_PLAYING</a> (1<<0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ignore play command, if the player is already playing. <a href="#g2ab0db7b5742ae8436be219cd1de58c8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#gda77e6020dd6c5b5dc403260454da51c">BG_PLAY_FLAG_IGNORE_IF_STOPPED</a> (1<<1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ignore play command, if the player is stopped. <a href="#gda77e6020dd6c5b5dc403260454da51c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#gfd982bcdb8277de435d4176b911f2f9e">BG_PLAY_FLAG_INIT_THEN_PAUSE</a> (1<<2)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize but go to pause status after. <a href="#gfd982bcdb8277de435d4176b911f2f9e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#gf9f1cd638d6bdd42e39e491a625b1a7b">BG_PLAY_FLAG_RESUME</a> (1<<3)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the player is paused, resume currently played track. <a href="#gf9f1cd638d6bdd42e39e491a625b1a7b"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#g01c8229b24c82d19c6946d990bcf799d">bg_player_play</a> (bg_player_t *player, <a class="el" href="structbg__plugin__handle__s.html">bg_plugin_handle_t</a> *handle, int track, int flags, const char *track_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Play a track. <a href="#g01c8229b24c82d19c6946d990bcf799d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#gbc4eeaca0500175e39d778a4358658e7">bg_player_seek</a> (bg_player_t *player, <a class="elRef" doxygen="gavl.tags:http://gmerlin.sourceforge.net/doc/gavl//" href="http://gmerlin.sourceforge.net/doc/gavl//group__time.html#ga0">gavl_time_t</a> time)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Seek to a specific time. <a href="#gbc4eeaca0500175e39d778a4358658e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#gfac26e333983d33283a37da9255ea9d8">bg_player_seek_rel</a> (bg_player_t *player, <a class="elRef" doxygen="gavl.tags:http://gmerlin.sourceforge.net/doc/gavl//" href="http://gmerlin.sourceforge.net/doc/gavl//group__time.html#ga0">gavl_time_t</a> time)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Seek relative by a specific time. <a href="#gfac26e333983d33283a37da9255ea9d8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#gdabd583761362cc22395cd956d3adf5e">bg_player_set_volume</a> (bg_player_t *player, float volume)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the volume. <a href="#gdabd583761362cc22395cd956d3adf5e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#gcf3a88796341bd8592edd49a419d345f">bg_player_set_volume_rel</a> (bg_player_t *player, float volume)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the volume relative. <a href="#gcf3a88796341bd8592edd49a419d345f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#gabb9dfee7c0e393dc05b417631f9bcfe">bg_player_stop</a> (bg_player_t *player)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop playback. <a href="#gabb9dfee7c0e393dc05b417631f9bcfe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#g345c7a8f0625e959f91ff971b98cdbf1">bg_player_pause</a> (bg_player_t *player)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Toggle pause. <a href="#g345c7a8f0625e959f91ff971b98cdbf1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#g66fd9c6f3644cbfd05af8128314419a4">bg_player_error</a> (bg_player_t *player)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Trigger an error. <a href="#g66fd9c6f3644cbfd05af8128314419a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#g5123d278c02e90697ea092026d6f503e">bg_player_set_oa_plugin</a> (bg_player_t *player, <a class="el" href="structbg__plugin__handle__s.html">bg_plugin_handle_t</a> *handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set audio output plugin. <a href="#g5123d278c02e90697ea092026d6f503e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#g496de3652921a4da0c3868fb6d7bf1b6">bg_player_set_ov_plugin</a> (bg_player_t *player, <a class="el" href="structbg__plugin__handle__s.html">bg_plugin_handle_t</a> *handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set video output plugin. <a href="#g496de3652921a4da0c3868fb6d7bf1b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#g6a800a53f103c2c61426b83b49f0efaa">bg_player_set_audio_stream</a> (bg_player_t *player, int stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set audio stream. <a href="#g6a800a53f103c2c61426b83b49f0efaa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#g11c490272e5503539cc27ed311d71d5a">bg_player_set_video_stream</a> (bg_player_t *player, int stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set video stream. <a href="#g11c490272e5503539cc27ed311d71d5a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#gde8a9335d30f840407282839e3cc4046">bg_player_set_subtitle_stream</a> (bg_player_t *player, int stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set subtitle stream. <a href="#gde8a9335d30f840407282839e3cc4046"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#g65ae91fd57919d644d7602c20e1399ba">bg_player_change</a> (bg_player_t *player, int flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shut down playback. <a href="#g65ae91fd57919d644d7602c20e1399ba"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#g47962dff97afe99d6f777b89436aa27f">bg_player_toggle_mute</a> (bg_player_t *player)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Toggle mute. <a href="#g47962dff97afe99d6f777b89436aa27f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#g40ee9b5de89efe7c5853b6dc693e13b8">bg_player_set_chapter</a> (bg_player_t *player, int chapter)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Goto a specified chapter. <a href="#g40ee9b5de89efe7c5853b6dc693e13b8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#gc58f79daaf3641de39d2897f636b1058">bg_player_next_chapter</a> (bg_player_t *player)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Goto the next chapter. <a href="#gc58f79daaf3641de39d2897f636b1058"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#g67d9b6ceb71d2a9c16343d65a708811f">bg_player_prev_chapter</a> (bg_player_t *player)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Goto the previous chapter. <a href="#g67d9b6ceb71d2a9c16343d65a708811f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#g2946392ac41cf01ae8f0ca90e4078bf2">bg_player_interrupt</a> (bg_player_t *player)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Interrupt playback. <a href="#g2946392ac41cf01ae8f0ca90e4078bf2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html#ge23d0a6569ec7793c86a29d4f3920095">bg_player_interrupt_resume</a> (bg_player_t *player)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resume an interrupted playback. <a href="#ge23d0a6569ec7793c86a29d4f3920095"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Most of these are called in an aynchronous manner. <hr><h2>Define Documentation</h2>
<a class="anchor" name="g2ab0db7b5742ae8436be219cd1de58c8"></a><!-- doxytag: member="player.h::BG_PLAY_FLAG_IGNORE_IF_PLAYING" ref="g2ab0db7b5742ae8436be219cd1de58c8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BG_PLAY_FLAG_IGNORE_IF_PLAYING (1<<0) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ignore play command, if the player is already playing.
<p>
</div>
</div><p>
<a class="anchor" name="gda77e6020dd6c5b5dc403260454da51c"></a><!-- doxytag: member="player.h::BG_PLAY_FLAG_IGNORE_IF_STOPPED" ref="gda77e6020dd6c5b5dc403260454da51c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BG_PLAY_FLAG_IGNORE_IF_STOPPED (1<<1) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ignore play command, if the player is stopped.
<p>
</div>
</div><p>
<a class="anchor" name="gfd982bcdb8277de435d4176b911f2f9e"></a><!-- doxytag: member="player.h::BG_PLAY_FLAG_INIT_THEN_PAUSE" ref="gfd982bcdb8277de435d4176b911f2f9e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BG_PLAY_FLAG_INIT_THEN_PAUSE (1<<2) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize but go to pause status after.
<p>
</div>
</div><p>
<a class="anchor" name="gf9f1cd638d6bdd42e39e491a625b1a7b"></a><!-- doxytag: member="player.h::BG_PLAY_FLAG_RESUME" ref="gf9f1cd638d6bdd42e39e491a625b1a7b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BG_PLAY_FLAG_RESUME (1<<3) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the player is paused, resume currently played track.
<p>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g01c8229b24c82d19c6946d990bcf799d"></a><!-- doxytag: member="player.h::bg_player_play" ref="g01c8229b24c82d19c6946d990bcf799d" args="(bg_player_t *player, bg_plugin_handle_t *handle, int track, int flags, const char *track_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_play </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structbg__plugin__handle__s.html">bg_plugin_handle_t</a> * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>track</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>track_name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Play a track.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>Handle of an open input plugin </td></tr>
<tr><td valign="top"></td><td valign="top"><em>track</em> </td><td>Track index to select (starting with 0) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>A combination of BG_PLAY_FLAG_* flags </td></tr>
<tr><td valign="top"></td><td valign="top"><em>track_name</em> </td><td>Name of the track to broadcast </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gbc4eeaca0500175e39d778a4358658e7"></a><!-- doxytag: member="player.h::bg_player_seek" ref="gbc4eeaca0500175e39d778a4358658e7" args="(bg_player_t *player, gavl_time_t time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_seek </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" doxygen="gavl.tags:http://gmerlin.sourceforge.net/doc/gavl//" href="http://gmerlin.sourceforge.net/doc/gavl//group__time.html#ga0">gavl_time_t</a> </td>
<td class="paramname"> <em>time</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Seek to a specific time.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
<tr><td valign="top"></td><td valign="top"><em>time</em> </td><td>Time to seek to </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gfac26e333983d33283a37da9255ea9d8"></a><!-- doxytag: member="player.h::bg_player_seek_rel" ref="gfac26e333983d33283a37da9255ea9d8" args="(bg_player_t *player, gavl_time_t time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_seek_rel </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" doxygen="gavl.tags:http://gmerlin.sourceforge.net/doc/gavl//" href="http://gmerlin.sourceforge.net/doc/gavl//group__time.html#ga0">gavl_time_t</a> </td>
<td class="paramname"> <em>time</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Seek relative by a specific time.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
<tr><td valign="top"></td><td valign="top"><em>time</em> </td><td>Time offset (can be negative to seek backwards) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gdabd583761362cc22395cd956d3adf5e"></a><!-- doxytag: member="player.h::bg_player_set_volume" ref="gdabd583761362cc22395cd956d3adf5e" args="(bg_player_t *player, float volume)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_set_volume </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>volume</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the volume.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
<tr><td valign="top"></td><td valign="top"><em>volume</em> </td><td>Volume (in dB, max is 0.0) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gcf3a88796341bd8592edd49a419d345f"></a><!-- doxytag: member="player.h::bg_player_set_volume_rel" ref="gcf3a88796341bd8592edd49a419d345f" args="(bg_player_t *player, float volume)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_set_volume_rel </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>volume</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the volume relative.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
<tr><td valign="top"></td><td valign="top"><em>volume</em> </td><td>Volume offset (in dB) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gabb9dfee7c0e393dc05b417631f9bcfe"></a><!-- doxytag: member="player.h::bg_player_stop" ref="gabb9dfee7c0e393dc05b417631f9bcfe" args="(bg_player_t *player)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_stop </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop playback.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g345c7a8f0625e959f91ff971b98cdbf1"></a><!-- doxytag: member="player.h::bg_player_pause" ref="g345c7a8f0625e959f91ff971b98cdbf1" args="(bg_player_t *player)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_pause </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Toggle pause.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g66fd9c6f3644cbfd05af8128314419a4"></a><!-- doxytag: member="player.h::bg_player_error" ref="g66fd9c6f3644cbfd05af8128314419a4" args="(bg_player_t *player)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_error </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Trigger an error.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g5123d278c02e90697ea092026d6f503e"></a><!-- doxytag: member="player.h::bg_player_set_oa_plugin" ref="g5123d278c02e90697ea092026d6f503e" args="(bg_player_t *player, bg_plugin_handle_t *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_set_oa_plugin </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structbg__plugin__handle__s.html">bg_plugin_handle_t</a> * </td>
<td class="paramname"> <em>handle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set audio output plugin.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>A plugin handle </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g496de3652921a4da0c3868fb6d7bf1b6"></a><!-- doxytag: member="player.h::bg_player_set_ov_plugin" ref="g496de3652921a4da0c3868fb6d7bf1b6" args="(bg_player_t *player, bg_plugin_handle_t *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_set_ov_plugin </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structbg__plugin__handle__s.html">bg_plugin_handle_t</a> * </td>
<td class="paramname"> <em>handle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set video output plugin.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>A plugin handle </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g6a800a53f103c2c61426b83b49f0efaa"></a><!-- doxytag: member="player.h::bg_player_set_audio_stream" ref="g6a800a53f103c2c61426b83b49f0efaa" args="(bg_player_t *player, int stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_set_audio_stream </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>stream</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set audio stream.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stream</em> </td><td>Stream index (starts with 0, -1 means no audio playback) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g11c490272e5503539cc27ed311d71d5a"></a><!-- doxytag: member="player.h::bg_player_set_video_stream" ref="g11c490272e5503539cc27ed311d71d5a" args="(bg_player_t *player, int stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_set_video_stream </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>stream</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set video stream.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stream</em> </td><td>Stream index (starts with 0, -1 means no video playback) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gde8a9335d30f840407282839e3cc4046"></a><!-- doxytag: member="player.h::bg_player_set_subtitle_stream" ref="gde8a9335d30f840407282839e3cc4046" args="(bg_player_t *player, int stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_set_subtitle_stream </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>stream</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set subtitle stream.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stream</em> </td><td>Stream index (starts with 0, -1 means no subtitle playback) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g65ae91fd57919d644d7602c20e1399ba"></a><!-- doxytag: member="player.h::bg_player_change" ref="g65ae91fd57919d644d7602c20e1399ba" args="(bg_player_t *player, int flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_change </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>flags</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Shut down playback.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>A combination of BG_PLAY_FLAG_* flags </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g47962dff97afe99d6f777b89436aa27f"></a><!-- doxytag: member="player.h::bg_player_toggle_mute" ref="g47962dff97afe99d6f777b89436aa27f" args="(bg_player_t *player)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_toggle_mute </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Toggle mute.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g40ee9b5de89efe7c5853b6dc693e13b8"></a><!-- doxytag: member="player.h::bg_player_set_chapter" ref="g40ee9b5de89efe7c5853b6dc693e13b8" args="(bg_player_t *player, int chapter)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_set_chapter </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>chapter</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Goto a specified chapter.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
<tr><td valign="top"></td><td valign="top"><em>chapter</em> </td><td>Chapter index (starting with 0) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gc58f79daaf3641de39d2897f636b1058"></a><!-- doxytag: member="player.h::bg_player_next_chapter" ref="gc58f79daaf3641de39d2897f636b1058" args="(bg_player_t *player)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_next_chapter </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Goto the next chapter.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g67d9b6ceb71d2a9c16343d65a708811f"></a><!-- doxytag: member="player.h::bg_player_prev_chapter" ref="g67d9b6ceb71d2a9c16343d65a708811f" args="(bg_player_t *player)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_prev_chapter </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Goto the previous chapter.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g2946392ac41cf01ae8f0ca90e4078bf2"></a><!-- doxytag: member="player.h::bg_player_interrupt" ref="g2946392ac41cf01ae8f0ca90e4078bf2" args="(bg_player_t *player)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_interrupt </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Interrupt playback.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player</td></tr>
</table>
</dl>
This function works synchonously, this means it is garantueed, that all playback threads are stopped until <a class="el" href="group__player__cmd.html#ge23d0a6569ec7793c86a29d4f3920095">bg_player_interrupt_resume</a> is called.
</div>
</div><p>
<a class="anchor" name="ge23d0a6569ec7793c86a29d4f3920095"></a><!-- doxytag: member="player.h::bg_player_interrupt_resume" ref="ge23d0a6569ec7793c86a29d4f3920095" args="(bg_player_t *player)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_interrupt_resume </td>
<td>(</td>
<td class="paramtype">bg_player_t * </td>
<td class="paramname"> <em>player</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Resume an interrupted playback.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>A player </td></tr>
</table>
</dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 22 01:28:05 2009 for gmerlin by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
874255f3b26b44feb57fbe38a7384518
>
files
>
212
