<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ --> <HEAD> <meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8"> <meta name="keywords" content="stage, robot, simulation, player, player/stage"> <link href="doxygen.css" rel="stylesheet" type="text/css"> <style type="text/css"> .floatright { float: right; margin: 0 0 1em 1em; } body { font-family: sans-serif; #font-family: Geneva, Verdana, Helvetica, Arial, sans-serif; background-color: #FFF; color:#000; } a:link { color: #A00; } a:visited { color: #800; } a { text-decoration: none; } a:hover { text-decoration: underline; } .timestamp { text-align:right; background-color: #DDD; font-size:75%;} h1 { font-size:160%; } h2 { font-size:110%; #color: #FFF; #background-color: #666; #padding:3px; } h3 { text-align:left; } img { border: 0; } ul.menu { position:relative; left:-2.5em; margin-bottom:0px; margin-top:0px; } ul.menu1 { position:relative; left:-2.1em; margin-bottom:0px; margin-top:0px; } li.menu { list-style-type: none; position:relative; #left:-0.5em; } #sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;} #content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; } div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em; } div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;} div.topbar { position: absolute; top:0px; left:9em; margin:1em; } </style> <TITLE>Player Manual</TITLE> </HEAD> <body> <div id="sidebar"> <h2 style="text-align:center;"> <a href="index.html"> <img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a> </h2> <div class="box"> <div class=title>Player</div> <ul class=menu> <li class=menu><a href="index.html">Frontpage</a> <li class=menu><a href="modules.html">Contents</a> </ul> </div> <div class="box"> <div class=title>User</div> <ul class=menu> <li class=menu><a href="install.html">Installation</a> <li class=menu><a href="start.html">Quick start</a> <li class=menu><a href="supported_hardware.html">Supported devices</a> <li class=menu><a href="group__tutorials.html">Tutorials</a> <li class=menu><a href="group__utils.html">Utilities</a> <li class=menu><a href="group__clientlibs.html">Client libraries</a> <li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a> <li class=menu><a href="help.html">Help</a> </ul> </div> <div class=box> <div class="title">Developer</div> <ul class=menu> <li class=menu><a href="architecture.html">Architecture</a> <li class=menu><a href="group__libplayercore.html">libplayercore</a> <ul class=menu1> <li class=menu><a href="group__interfaces.html">interfaces</a></li> </ul> <li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a> <ul class=menu1> <li class=menu><a href="group__drivers.html">drivers</a></li> </ul> <li class=menu><a href="group__libplayercommon.html">libplayercommon</a> <li class=menu><a href="group__libplayerutils.html">libplayerutils</a> <li class=menu><a href="group__libplayersd.html">libplayersd</a> <li class=menu><a href="group__libplayertcp.html">libplayertcp</a> <li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a> <li class=menu><a href="todo.html">TODO</a> </ul> </div> <div class=box> <!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> --> <div class="title">Online</div> <a href="http://playerstage.sourceforge.net">Homepage</a><br> <a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br> <a href="http://sourceforge.net/projects/playerstage">Project</a><br> <a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br> <a href="http://sourceforge.net/mail/?group_id=42445">Help</a> </div> </div> <div id="content" > <!-- Generated by Doxygen 1.7.1 --> <div class="header"> <div class="headertitle"> <h1>log<br/> <small> [<a class="el" href="group__interfaces.html">Interface specifications</a>]</small> </h1> </div> </div> <div class="contents"> <p>Log read / write control. <a href="#_details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><p><a class="anchor" id="amgrpd41d8cd98f00b204e9800998ecf8427e"></a> </p> <br/><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad6f9f2bf994079b0e6f0f5c4cd8a9146"></a><!-- doxytag: member="interface_log::PLAYER_LOG_REQ_SET_WRITE_STATE" ref="gad6f9f2bf994079b0e6f0f5c4cd8a9146" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__log.html#gad6f9f2bf994079b0e6f0f5c4cd8a9146">PLAYER_LOG_REQ_SET_WRITE_STATE</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply subtype: set write state. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5ecdb1cc2a6de5400648b1f87b7473c0"></a><!-- doxytag: member="interface_log::PLAYER_LOG_REQ_SET_READ_STATE" ref="ga5ecdb1cc2a6de5400648b1f87b7473c0" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__log.html#ga5ecdb1cc2a6de5400648b1f87b7473c0">PLAYER_LOG_REQ_SET_READ_STATE</a> 2</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply subtype: set read state. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga312fb403b68edc17277fc98b3a89db83"></a><!-- doxytag: member="interface_log::PLAYER_LOG_REQ_GET_STATE" ref="ga312fb403b68edc17277fc98b3a89db83" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__log.html#ga312fb403b68edc17277fc98b3a89db83">PLAYER_LOG_REQ_GET_STATE</a> 3</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply subtype: get state. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga541b2e13403f572d9e4e1eac48f90e18"></a><!-- doxytag: member="interface_log::PLAYER_LOG_REQ_SET_READ_REWIND" ref="ga541b2e13403f572d9e4e1eac48f90e18" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__log.html#ga541b2e13403f572d9e4e1eac48f90e18">PLAYER_LOG_REQ_SET_READ_REWIND</a> 4</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply subtype: rewind. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga998c47a3011910e3d70d3a7e90d53c0d"></a><!-- doxytag: member="interface_log::PLAYER_LOG_REQ_SET_FILENAME" ref="ga998c47a3011910e3d70d3a7e90d53c0d" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__log.html#ga998c47a3011910e3d70d3a7e90d53c0d">PLAYER_LOG_REQ_SET_FILENAME</a> 5</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply subtype: set filename to write. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9daa1ae82be0da517cc4222b0b096fbb"></a><!-- doxytag: member="interface_log::PLAYER_LOG_TYPE_READ" ref="ga9daa1ae82be0da517cc4222b0b096fbb" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__log.html#ga9daa1ae82be0da517cc4222b0b096fbb">PLAYER_LOG_TYPE_READ</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Types of log device: read. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0b807fad2c3c5aced1cd1c6d6ee1bc67"></a><!-- doxytag: member="interface_log::PLAYER_LOG_TYPE_WRITE" ref="ga0b807fad2c3c5aced1cd1c6d6ee1bc67" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__log.html#ga0b807fad2c3c5aced1cd1c6d6ee1bc67">PLAYER_LOG_TYPE_WRITE</a> 2</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Types of log device: write. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__log__set__write__state.html">player_log_set_write_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__log.html#gad13e137d55f4bacbe45d51743f96e627">player_log_set_write_state_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Set write state. <a href="#gad13e137d55f4bacbe45d51743f96e627"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__log__set__read__state.html">player_log_set_read_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__log.html#gade8ab940e92faf2a28c63a781378bb87">player_log_set_read_state_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Set playback state. <a href="#gade8ab940e92faf2a28c63a781378bb87"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__log__get__state.html">player_log_get_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__log.html#ga99b29414b9c239211d7e0e96d562085d">player_log_get_state_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Rewind playback. <a href="#ga99b29414b9c239211d7e0e96d562085d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__log__set__filename.html">player_log_set_filename</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__log.html#gaf5be93c6842e380f44bdf4c4ee6ea25e">player_log_set_filename_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Set filename. <a href="#gaf5be93c6842e380f44bdf4c4ee6ea25e"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Log read / write control. </p> <p>The <code>log</code> interface provides start/stop control of data logging/playback. A log device either writes data from one or more devices to a file, or it reads logged data from a file and plays it back as if it were being produced live by one or more devices. </p> <hr/><h2>Typedef Documentation</h2> <a class="anchor" id="ga99b29414b9c239211d7e0e96d562085d"></a><!-- doxytag: member="player_interfaces.h::player_log_get_state_t" ref="ga99b29414b9c239211d7e0e96d562085d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__log__get__state.html">player_log_get_state</a> <a class="el" href="structplayer__log__get__state.html">player_log_get_state_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Request/reply: Rewind playback. </p> <p>To rewind log playback to beginning of logfile, send a <a class="el" href="group__interface__log.html#ga541b2e13403f572d9e4e1eac48f90e18">PLAYER_LOG_REQ_SET_READ_REWIND</a> request. Does not affect playback state (i.e., whether it is started or stopped. Null response. Request/reply: Get state.</p> <p>To find out whether logging/playback is enabled or disabled, send a null <a class="el" href="group__interface__log.html#ga312fb403b68edc17277fc98b3a89db83">PLAYER_LOG_REQ_GET_STATE</a> request. </p> </div> </div> <a class="anchor" id="gaf5be93c6842e380f44bdf4c4ee6ea25e"></a><!-- doxytag: member="player_interfaces.h::player_log_set_filename_t" ref="gaf5be93c6842e380f44bdf4c4ee6ea25e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__log__set__filename.html">player_log_set_filename</a> <a class="el" href="structplayer__log__set__filename.html">player_log_set_filename_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Request/reply: Set filename. </p> <p>To set the name of the file to write to when logging, send a <a class="el" href="group__interface__log.html#ga998c47a3011910e3d70d3a7e90d53c0d">PLAYER_LOG_REQ_SET_FILENAME</a> request. Null response. </p> </div> </div> <a class="anchor" id="gade8ab940e92faf2a28c63a781378bb87"></a><!-- doxytag: member="player_interfaces.h::player_log_set_read_state_t" ref="gade8ab940e92faf2a28c63a781378bb87" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__log__set__read__state.html">player_log_set_read_state</a> <a class="el" href="structplayer__log__set__read__state.html">player_log_set_read_state_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Request/reply: Set playback state. </p> <p>To start or stop data playback, send a <a class="el" href="group__interface__log.html#ga5ecdb1cc2a6de5400648b1f87b7473c0">PLAYER_LOG_REQ_SET_READ_STATE</a> request. Null response. </p> </div> </div> <a class="anchor" id="gad13e137d55f4bacbe45d51743f96e627"></a><!-- doxytag: member="player_interfaces.h::player_log_set_write_state_t" ref="gad13e137d55f4bacbe45d51743f96e627" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__log__set__write__state.html">player_log_set_write_state</a> <a class="el" href="structplayer__log__set__write__state.html">player_log_set_write_state_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Request/reply: Set write state. </p> <p>To start or stop data logging, send a <a class="el" href="group__interface__log.html#gad6f9f2bf994079b0e6f0f5c4cd8a9146">PLAYER_LOG_REQ_SET_WRITE_STATE</a> request. Null response. </p> </div> </div> </div> <!-- render the modification time of the source file --> <div class="timestamp"> <hr> <table style="width:100%;"> <tr> <td style="text-align:left;"> Last updated 12 September 2005 21:38:45 <!-- <td style="text-align:right;"> <a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px" src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> <a href="http://jigsaw.w3.org/css-validator/"> <img style="vertical-align:middle;border:0;width:88px;height:31px" src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"> </a> --> </tr> </table> </div> </tr> </table> </BODY> </HTML>