<!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>ptz<br/>
<small>
[<a class="el" href="group__interfaces.html">Interface specifications</a>]</small>
</h1> </div>
</div>
<div class="contents">
<p>Pan-tilt-zoom unit.
<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="ga62852ccd35724c1cba9042eaa861378d"></a><!-- doxytag: member="interface_ptz::PLAYER_PTZ_REQ_GENERIC" ref="ga62852ccd35724c1cba9042eaa861378d" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#ga62852ccd35724c1cba9042eaa861378d">PLAYER_PTZ_REQ_GENERIC</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply subtype: generic. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0b5f3302ce9f9ccd4a1d5e864b261132"></a><!-- doxytag: member="interface_ptz::PLAYER_PTZ_REQ_CONTROL_MODE" ref="ga0b5f3302ce9f9ccd4a1d5e864b261132" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#ga0b5f3302ce9f9ccd4a1d5e864b261132">PLAYER_PTZ_REQ_CONTROL_MODE</a> 2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply subtype: control mode. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2d4d8ed2ad99fd2828d3dc253fef1664"></a><!-- doxytag: member="interface_ptz::PLAYER_PTZ_REQ_GEOM" ref="ga2d4d8ed2ad99fd2828d3dc253fef1664" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#ga2d4d8ed2ad99fd2828d3dc253fef1664">PLAYER_PTZ_REQ_GEOM</a> 4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply subtype: geometry. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4d504efd3b538c051109a8c6a2b4490b"></a><!-- doxytag: member="interface_ptz::PLAYER_PTZ_REQ_STATUS" ref="ga4d504efd3b538c051109a8c6a2b4490b" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#ga4d504efd3b538c051109a8c6a2b4490b">PLAYER_PTZ_REQ_STATUS</a> 5</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply subtype: status. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3fbc2b1a86136057b45334d7d9269a18"></a><!-- doxytag: member="interface_ptz::PLAYER_PTZ_DATA_STATE" ref="ga3fbc2b1a86136057b45334d7d9269a18" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#ga3fbc2b1a86136057b45334d7d9269a18">PLAYER_PTZ_DATA_STATE</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4e58ce07bcbd96ac69a17c62d0001244"></a><!-- doxytag: member="interface_ptz::PLAYER_PTZ_DATA_GEOM" ref="ga4e58ce07bcbd96ac69a17c62d0001244" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#ga4e58ce07bcbd96ac69a17c62d0001244">PLAYER_PTZ_DATA_GEOM</a> 2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: geometry. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab8ea78d84d7f1904bbadd6803102c2b2"></a><!-- doxytag: member="interface_ptz::PLAYER_PTZ_CMD_STATE" ref="gab8ea78d84d7f1904bbadd6803102c2b2" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#gab8ea78d84d7f1904bbadd6803102c2b2">PLAYER_PTZ_CMD_STATE</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command subtype: state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6603db5021411ba2326b831939b9abb2"></a><!-- doxytag: member="interface_ptz::PLAYER_PTZ_VELOCITY_CONTROL" ref="ga6603db5021411ba2326b831939b9abb2" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#ga6603db5021411ba2326b831939b9abb2">PLAYER_PTZ_VELOCITY_CONTROL</a> 0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Control mode, for use with <a class="el" href="group__interface__ptz.html#ga0b5f3302ce9f9ccd4a1d5e864b261132">PLAYER_PTZ_REQ_CONTROL_MODE</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga87f94375a0ddecba2ef99daa9aedd3df"></a><!-- doxytag: member="interface_ptz::PLAYER_PTZ_POSITION_CONTROL" ref="ga87f94375a0ddecba2ef99daa9aedd3df" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#ga87f94375a0ddecba2ef99daa9aedd3df">PLAYER_PTZ_POSITION_CONTROL</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Control mode, for use with <a class="el" href="group__interface__ptz.html#ga0b5f3302ce9f9ccd4a1d5e864b261132">PLAYER_PTZ_REQ_CONTROL_MODE</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__ptz__data.html">player_ptz_data</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#gae5255c2ee73f0036285ecb6d2095ca15">player_ptz_data_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data: state (<a class="el" href="group__interface__ptz.html#ga3fbc2b1a86136057b45334d7d9269a18">PLAYER_PTZ_DATA_STATE</a>). <a href="#gae5255c2ee73f0036285ecb6d2095ca15"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__ptz__cmd.html">player_ptz_cmd</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#gaf9f20b471df17ddaae6c9f64189b1b87">player_ptz_cmd_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command: state (<a class="el" href="group__interface__ptz.html#gab8ea78d84d7f1904bbadd6803102c2b2">PLAYER_PTZ_CMD_STATE</a>). <a href="#gaf9f20b471df17ddaae6c9f64189b1b87"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__ptz__req__status.html">player_ptz_req_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#ga2e86216fcecf9ee3bd635d711cb6a7d3">player_ptz_req_status_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Query pan/tilt status. <a href="#ga2e86216fcecf9ee3bd635d711cb6a7d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__ptz__geom.html">player_ptz_geom</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#gae53cb8c5a67285141143c569c87c5d46">player_ptz_geom_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Query geometry. <a href="#gae53cb8c5a67285141143c569c87c5d46"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__ptz__req__generic.html">player_ptz_req_generic</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#ga7207de86d1c22bc293c72803b0ffeec4">player_ptz_req_generic_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Generic request. <a href="#ga7207de86d1c22bc293c72803b0ffeec4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__ptz__req__control__mode.html">player_ptz_req_control_mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__ptz.html#ga5be0799e3403bd923e61a27457d0a713">player_ptz_req_control_mode_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Control mode. <a href="#ga5be0799e3403bd923e61a27457d0a713"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Pan-tilt-zoom unit. </p>
<p>The ptz interface is used to control a pan-tilt-zoom unit, such as a camera. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gaf9f20b471df17ddaae6c9f64189b1b87"></a><!-- doxytag: member="player_interfaces.h::player_ptz_cmd_t" ref="gaf9f20b471df17ddaae6c9f64189b1b87" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__ptz__cmd.html">player_ptz_cmd</a> <a class="el" href="structplayer__ptz__cmd.html">player_ptz_cmd_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Command: state (<a class="el" href="group__interface__ptz.html#gab8ea78d84d7f1904bbadd6803102c2b2">PLAYER_PTZ_CMD_STATE</a>). </p>
<p>The ptz interface accepts commands that set change the state of the unit. Note that the commands are absolute, not relative. </p>
</div>
</div>
<a class="anchor" id="gae5255c2ee73f0036285ecb6d2095ca15"></a><!-- doxytag: member="player_interfaces.h::player_ptz_data_t" ref="gae5255c2ee73f0036285ecb6d2095ca15" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__ptz__data.html">player_ptz_data</a> <a class="el" href="structplayer__ptz__data.html">player_ptz_data_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data: state (<a class="el" href="group__interface__ptz.html#ga3fbc2b1a86136057b45334d7d9269a18">PLAYER_PTZ_DATA_STATE</a>). </p>
<p>The ptz interface returns data reflecting the current state of the Pan-Tilt-Zoom unit. </p>
</div>
</div>
<a class="anchor" id="gae53cb8c5a67285141143c569c87c5d46"></a><!-- doxytag: member="player_interfaces.h::player_ptz_geom_t" ref="gae53cb8c5a67285141143c569c87c5d46" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__ptz__geom.html">player_ptz_geom</a> <a class="el" href="structplayer__ptz__geom.html">player_ptz_geom_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request/reply: Query geometry. </p>
<p>To request ptz geometry, send a null <a class="el" href="group__interface__ptz.html#ga2d4d8ed2ad99fd2828d3dc253fef1664">PLAYER_PTZ_REQ_GEOM</a> request. </p>
</div>
</div>
<a class="anchor" id="ga5be0799e3403bd923e61a27457d0a713"></a><!-- doxytag: member="player_interfaces.h::player_ptz_req_control_mode_t" ref="ga5be0799e3403bd923e61a27457d0a713" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__ptz__req__control__mode.html">player_ptz_req_control_mode</a> <a class="el" href="structplayer__ptz__req__control__mode.html">player_ptz_req_control_mode_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request/reply: Control mode. </p>
<p>To switch between position and velocity control (for those drivers that support it), send a <a class="el" href="group__interface__ptz.html#ga0b5f3302ce9f9ccd4a1d5e864b261132">PLAYER_PTZ_REQ_CONTROL_MODE</a> request. Note that this request changes how the driver interprets forthcoming commands from all clients. Null response. </p>
</div>
</div>
<a class="anchor" id="ga7207de86d1c22bc293c72803b0ffeec4"></a><!-- doxytag: member="player_interfaces.h::player_ptz_req_generic_t" ref="ga7207de86d1c22bc293c72803b0ffeec4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__ptz__req__generic.html">player_ptz_req_generic</a> <a class="el" href="structplayer__ptz__req__generic.html">player_ptz_req_generic_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request/reply: Generic request. </p>
<p>To send a unit-specific command to the unit, use the <a class="el" href="group__interface__ptz.html#ga62852ccd35724c1cba9042eaa861378d">PLAYER_PTZ_REQ_GENERIC</a> request. Whether data is returned depends on the command that was sent. The device may fill in "config" with a reply if applicable. </p>
</div>
</div>
<a class="anchor" id="ga2e86216fcecf9ee3bd635d711cb6a7d3"></a><!-- doxytag: member="player_interfaces.h::player_ptz_req_status_t" ref="ga2e86216fcecf9ee3bd635d711cb6a7d3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__ptz__req__status.html">player_ptz_req_status</a> <a class="el" href="structplayer__ptz__req__status.html">player_ptz_req_status_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request/reply: Query pan/tilt status. </p>
<p>To request pan/tilt status of the unit, send a null <a class="el" href="group__interface__ptz.html#ga4d504efd3b538c051109a8c6a2b4490b">PLAYER_PTZ_REQ_STATUS</a> request. </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>
