<!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="summary">
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>ptz<br/>
<small>
[<a class="el" href="group__playerc__proxies.html">Device proxies</a>]</small>
</h1> </div>
</div>
<div class="contents">
<p>The ptz proxy provides an interface to pan-tilt units such as the Sony PTZ camera.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">PTZ device data. <a href="structplayerc__ptz__t.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT <a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__ptz.html#gaf6277137a1c665aabd3f827f067afee1">playerc_ptz_create</a> (<a class="el" href="struct__playerc__client__t.html">playerc_client_t</a> *client, int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a ptz proxy. <a href="#gaf6277137a1c665aabd3f827f067afee1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__ptz.html#ga88b62df887f7adc890f0c594894b1cc1">playerc_ptz_destroy</a> (<a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> *device)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a ptz proxy. <a href="#ga88b62df887f7adc890f0c594894b1cc1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__ptz.html#gaa9922db98d38338756b07508b7f3ff87">playerc_ptz_subscribe</a> (<a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> *device, int access)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to the ptz device. <a href="#gaa9922db98d38338756b07508b7f3ff87"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__ptz.html#ga71507cfec4a1ddc9c8fdfbe4f474fb47">playerc_ptz_unsubscribe</a> (<a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> *device)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Un-subscribe from the ptz device. <a href="#ga71507cfec4a1ddc9c8fdfbe4f474fb47"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__ptz.html#ga5f89fff9e67ca27e8726b27a3c22f1e6">playerc_ptz_set</a> (<a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> *device, double pan, double tilt, double zoom)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the pan, tilt and zoom values. <a href="#ga5f89fff9e67ca27e8726b27a3c22f1e6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__ptz.html#ga5948a4aa3a4fab90c8a20498a89ecf99">playerc_ptz_query_status</a> (<a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> *device)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the pan and tilt status. <a href="#ga5948a4aa3a4fab90c8a20498a89ecf99"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__ptz.html#ga4c9ed1600bffd20df2c7ab3cdc52e292">playerc_ptz_set_ws</a> (<a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> *device, double pan, double tilt, double zoom, double panspeed, double tiltspeed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the pan, tilt and zoom values (and speed). <a href="#ga4c9ed1600bffd20df2c7ab3cdc52e292"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__ptz.html#gafcfb492780ab3a4b0410ccfe9205f49c">playerc_ptz_set_control_mode</a> (<a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> *device, int mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change control mode (select velocity or position control). <a href="#gafcfb492780ab3a4b0410ccfe9205f49c"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The ptz proxy provides an interface to pan-tilt units such as the Sony PTZ camera. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaf6277137a1c665aabd3f827f067afee1"></a><!-- doxytag: member="playerc.h::playerc_ptz_create" ref="gaf6277137a1c665aabd3f827f067afee1" args="(playerc_client_t *client, int index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PLAYERC_EXPORT <a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a>* playerc_ptz_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__playerc__client__t.html">playerc_client_t</a> * </td>
<td class="paramname"> <em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a ptz proxy. </p>
</div>
</div>
<a class="anchor" id="ga88b62df887f7adc890f0c594894b1cc1"></a><!-- doxytag: member="playerc.h::playerc_ptz_destroy" ref="ga88b62df887f7adc890f0c594894b1cc1" args="(playerc_ptz_t *device)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PLAYERC_EXPORT void playerc_ptz_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> * </td>
<td class="paramname"> <em>device</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy a ptz proxy. </p>
</div>
</div>
<a class="anchor" id="ga5948a4aa3a4fab90c8a20498a89ecf99"></a><!-- doxytag: member="playerc.h::playerc_ptz_query_status" ref="ga5948a4aa3a4fab90c8a20498a89ecf99" args="(playerc_ptz_t *device)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PLAYERC_EXPORT int playerc_ptz_query_status </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> * </td>
<td class="paramname"> <em>device</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Query the pan and tilt status. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>device</em> </td><td>Pointer to proxy object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga5f89fff9e67ca27e8726b27a3c22f1e6"></a><!-- doxytag: member="playerc.h::playerc_ptz_set" ref="ga5f89fff9e67ca27e8726b27a3c22f1e6" args="(playerc_ptz_t *device, double pan, double tilt, double zoom)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PLAYERC_EXPORT int playerc_ptz_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> * </td>
<td class="paramname"> <em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>pan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>tilt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>zoom</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 pan, tilt and zoom values. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>device</em> </td><td>Pointer to proxy object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pan</em> </td><td>Pan value, in radians; 0 = centered. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tilt</em> </td><td>Tilt value, in radians; 0 = level. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>zoom</em> </td><td>Zoom value, in radians (corresponds to camera field of view). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gafcfb492780ab3a4b0410ccfe9205f49c"></a><!-- doxytag: member="playerc.h::playerc_ptz_set_control_mode" ref="gafcfb492780ab3a4b0410ccfe9205f49c" args="(playerc_ptz_t *device, int mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PLAYERC_EXPORT int playerc_ptz_set_control_mode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> * </td>
<td class="paramname"> <em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>mode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Change control mode (select velocity or position control). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>device</em> </td><td>Pointer to proxy object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>Desired mode (<a class="el" href="group__interface__ptz.html#ga6603db5021411ba2326b831939b9abb2">PLAYER_PTZ_VELOCITY_CONTROL</a> or <a class="el" href="group__interface__ptz.html#ga87f94375a0ddecba2ef99daa9aedd3df">PLAYER_PTZ_POSITION_CONTROL</a>)</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, -1 on error, -2 on NACK. </dd></dl>
</div>
</div>
<a class="anchor" id="ga4c9ed1600bffd20df2c7ab3cdc52e292"></a><!-- doxytag: member="playerc.h::playerc_ptz_set_ws" ref="ga4c9ed1600bffd20df2c7ab3cdc52e292" args="(playerc_ptz_t *device, double pan, double tilt, double zoom, double panspeed, double tiltspeed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PLAYERC_EXPORT int playerc_ptz_set_ws </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> * </td>
<td class="paramname"> <em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>pan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>tilt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>zoom</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>panspeed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>tiltspeed</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 pan, tilt and zoom values (and speed). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>device</em> </td><td>Pointer to proxy object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pan</em> </td><td>Pan value, in radians; 0 = centered. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tilt</em> </td><td>Tilt value, in radians; 0 = level. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>zoom</em> </td><td>Zoom value, in radians (corresponds to camera field of view). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>panspeed</em> </td><td>Pan speed, in radians/sec. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tiltspeed</em> </td><td>Tilt speed, in radians/sec. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaa9922db98d38338756b07508b7f3ff87"></a><!-- doxytag: member="playerc.h::playerc_ptz_subscribe" ref="gaa9922db98d38338756b07508b7f3ff87" args="(playerc_ptz_t *device, int access)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PLAYERC_EXPORT int playerc_ptz_subscribe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> * </td>
<td class="paramname"> <em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>access</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribe to the ptz device. </p>
</div>
</div>
<a class="anchor" id="ga71507cfec4a1ddc9c8fdfbe4f474fb47"></a><!-- doxytag: member="playerc.h::playerc_ptz_unsubscribe" ref="ga71507cfec4a1ddc9c8fdfbe4f474fb47" args="(playerc_ptz_t *device)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PLAYERC_EXPORT int playerc_ptz_unsubscribe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structplayerc__ptz__t.html">playerc_ptz_t</a> * </td>
<td class="paramname"> <em>device</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Un-subscribe from the ptz device. </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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
727fa15453fcace956b835e2377d4269
>
files
>
798
