<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>gmerlin: Player</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">gmerlin
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Player</div> </div>
</div><!--header-->
<div class="contents">
<p>Multimedia player.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__player__cmd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cmd.html">Commands, which can be sent to the player</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__player__cfg"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__cfg.html">Player configuration</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__player__msg"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__msg.html">Messages from the player</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga8092d41144b0ff4d6351edc51c79bae3"><td class="memItemLeft" align="right" valign="top">bg_player_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player.html#ga8092d41144b0ff4d6351edc51c79bae3">bg_player_create</a> (<a class="el" href="group__plugin__registry.html#ga7470a35f2437f3fbc9762587d3fe7142">bg_plugin_registry_t</a> *plugin_reg)</td></tr>
<tr class="memdesc:ga8092d41144b0ff4d6351edc51c79bae3"><td class="mdescLeft"> </td><td class="mdescRight">Create a player. <a href="#ga8092d41144b0ff4d6351edc51c79bae3">More...</a><br /></td></tr>
<tr class="separator:ga8092d41144b0ff4d6351edc51c79bae3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad55be0f0f41d39c9c5da4ca2eb849b0b"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player.html#gad55be0f0f41d39c9c5da4ca2eb849b0b">bg_player_get_parameters</a> (bg_player_t *player)</td></tr>
<tr class="memdesc:gad55be0f0f41d39c9c5da4ca2eb849b0b"><td class="mdescLeft"> </td><td class="mdescRight">Get parameters. <a href="#gad55be0f0f41d39c9c5da4ca2eb849b0b">More...</a><br /></td></tr>
<tr class="separator:gad55be0f0f41d39c9c5da4ca2eb849b0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacae6df797e185564086d74ff0c9af490"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player.html#gacae6df797e185564086d74ff0c9af490">bg_player_set_parameter</a> (void *player, const char *name, const <a class="el" href="unionbg__parameter__value__t.html">bg_parameter_value_t</a> *val)</td></tr>
<tr class="memdesc:gacae6df797e185564086d74ff0c9af490"><td class="mdescLeft"> </td><td class="mdescRight">Get parameters. <a href="#gacae6df797e185564086d74ff0c9af490">More...</a><br /></td></tr>
<tr class="separator:gacae6df797e185564086d74ff0c9af490"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab1c61ed5f8a789e58121a4fca54742e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player.html#gab1c61ed5f8a789e58121a4fca54742e8">bg_player_add_accelerators</a> (bg_player_t *player, const bg_accelerator_t *list)</td></tr>
<tr class="memdesc:gab1c61ed5f8a789e58121a4fca54742e8"><td class="mdescLeft"> </td><td class="mdescRight">Set accelerators. <a href="#gab1c61ed5f8a789e58121a4fca54742e8">More...</a><br /></td></tr>
<tr class="separator:gab1c61ed5f8a789e58121a4fca54742e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeed210074863a78312554942356b007c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player.html#gaeed210074863a78312554942356b007c">bg_player_destroy</a> (bg_player_t *player)</td></tr>
<tr class="memdesc:gaeed210074863a78312554942356b007c"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a player. <a href="#gaeed210074863a78312554942356b007c">More...</a><br /></td></tr>
<tr class="separator:gaeed210074863a78312554942356b007c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad8a905ec8132e933fb9a5321ccf2ecde"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player.html#gad8a905ec8132e933fb9a5321ccf2ecde">bg_player_add_message_queue</a> (bg_player_t *player, <a class="el" href="group__message__queues.html#ga06c6bfc0f61ce4013b6d4117d299fa5a">bg_msg_queue_t</a> *message_queue)</td></tr>
<tr class="memdesc:gad8a905ec8132e933fb9a5321ccf2ecde"><td class="mdescLeft"> </td><td class="mdescRight">Attach a message queue to a player. <a href="#gad8a905ec8132e933fb9a5321ccf2ecde">More...</a><br /></td></tr>
<tr class="separator:gad8a905ec8132e933fb9a5321ccf2ecde"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga690508e4e50bce3585e85c8bfa8a5926"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player.html#ga690508e4e50bce3585e85c8bfa8a5926">bg_player_delete_message_queue</a> (bg_player_t *player, <a class="el" href="group__message__queues.html#ga06c6bfc0f61ce4013b6d4117d299fa5a">bg_msg_queue_t</a> *message_queue)</td></tr>
<tr class="memdesc:ga690508e4e50bce3585e85c8bfa8a5926"><td class="mdescLeft"> </td><td class="mdescRight">Detach a message queue from a player. <a href="#ga690508e4e50bce3585e85c8bfa8a5926">More...</a><br /></td></tr>
<tr class="separator:ga690508e4e50bce3585e85c8bfa8a5926"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadc42e6ad0220045ab62643909b939d08"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player.html#gadc42e6ad0220045ab62643909b939d08">bg_player_run</a> (bg_player_t *player)</td></tr>
<tr class="memdesc:gadc42e6ad0220045ab62643909b939d08"><td class="mdescLeft"> </td><td class="mdescRight">Start the player thread. <a href="#gadc42e6ad0220045ab62643909b939d08">More...</a><br /></td></tr>
<tr class="separator:gadc42e6ad0220045ab62643909b939d08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf952edee16ac6b6ebe617b9a488606c0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player.html#gaf952edee16ac6b6ebe617b9a488606c0">bg_player_quit</a> (bg_player_t *player)</td></tr>
<tr class="memdesc:gaf952edee16ac6b6ebe617b9a488606c0"><td class="mdescLeft"> </td><td class="mdescRight">Quit the player thread. <a href="#gaf952edee16ac6b6ebe617b9a488606c0">More...</a><br /></td></tr>
<tr class="separator:gaf952edee16ac6b6ebe617b9a488606c0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Multimedia player. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga8092d41144b0ff4d6351edc51c79bae3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bg_player_t* bg_player_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__plugin__registry.html#ga7470a35f2437f3fbc9762587d3fe7142">bg_plugin_registry_t</a> * </td>
<td class="paramname"><em>plugin_reg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a player. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">plugin_reg</td><td>A plugin registry </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A newly allocated player</dd></dl>
<p>The plugin registry is used for loading audio- and video filters </p>
</div>
</div>
<a class="anchor" id="gad55be0f0f41d39c9c5da4ca2eb849b0b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a>* bg_player_get_parameters </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>Get parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">player</td><td>A player </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An array of parameters</dd></dl>
<p>This returns only some internal parameters, which should never be changed by the user. For user settable parameters, see <a class="el" href="group__player__cfg.html#ga604970b0603a95d76e574e166c5a84b3">bg_player_get_input_parameters</a>, <a class="el" href="group__player__cfg.html#gacb3e3eb811c8dc990a5a206186937cbf">bg_player_get_audio_parameters</a>, <a class="el" href="group__player__cfg.html#ga893f05c1b762424be44126adfc765680">bg_player_get_audio_filter_parameters</a>, <a class="el" href="group__player__cfg.html#ga3356ac5cb80b369de6d8e18dc1de0551">bg_player_get_video_parameters</a>, <a class="el" href="group__player__cfg.html#gab7484f5971987c35444e2d049e930e31">bg_player_get_video_filter_parameters</a> <a class="el" href="group__player__cfg.html#ga2be20381e7f1f571d3c6449b6180635d">bg_player_get_subtitle_parameters</a> and <a class="el" href="group__player__cfg.html#gac5d8b3edb83f5c80ce5d0e97938a925e">bg_player_get_osd_parameters</a> </p>
</div>
</div>
<a class="anchor" id="gacae6df797e185564086d74ff0c9af490"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_set_parameter </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>player</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="unionbg__parameter__value__t.html">bg_parameter_value_t</a> * </td>
<td class="paramname"><em>val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">player</td><td>A player cast to void </td></tr>
<tr><td class="paramname">name</td><td>The name of the parameter </td></tr>
<tr><td class="paramname">val</td><td>The parameter value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab1c61ed5f8a789e58121a4fca54742e8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_add_accelerators </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">const bg_accelerator_t * </td>
<td class="paramname"><em>list</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set accelerators. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">player</td><td>A newly created player </td></tr>
<tr><td class="paramname">list</td><td>A list of accelerators, terminated with BG_KEY_NONE </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaeed210074863a78312554942356b007c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_destroy </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>Destroy a player. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">player</td><td>A player </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gad8a905ec8132e933fb9a5321ccf2ecde"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_add_message_queue </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="group__message__queues.html#ga06c6bfc0f61ce4013b6d4117d299fa5a">bg_msg_queue_t</a> * </td>
<td class="paramname"><em>message_queue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attach a message queue to a player. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">player</td><td>A player </td></tr>
<tr><td class="paramname">message_queue</td><td>A mesage queue </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga690508e4e50bce3585e85c8bfa8a5926"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_delete_message_queue </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="group__message__queues.html#ga06c6bfc0f61ce4013b6d4117d299fa5a">bg_msg_queue_t</a> * </td>
<td class="paramname"><em>message_queue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Detach a message queue from a player. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">player</td><td>A player </td></tr>
<tr><td class="paramname">message_queue</td><td>A mesage queue </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gadc42e6ad0220045ab62643909b939d08"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_run </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>Start the player thread. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">player</td><td>A player </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaf952edee16ac6b6ebe617b9a488606c0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_player_quit </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>Quit the player thread. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">player</td><td>A player </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 19 2019 17:35:38 for gmerlin by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
