<!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="navpath">
<ul>
<li><b>PlayerCc</b> </li>
<li><a class="el" href="classPlayerCc_1_1CameraProxy.html">PlayerCc::CameraProxy</a> </li>
</ul>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<h1>PlayerCc::CameraProxy Class Reference<br/>
<small>
[<a class="el" href="group__player__clientlib__cplusplus__proxies.html">Proxies</a>]</small>
</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="PlayerCc::CameraProxy" --><!-- doxytag: inherits="PlayerCc::ClientProxy" -->
<p>The <code><a class="el" href="classPlayerCc_1_1CameraProxy.html" title="The CameraProxy class can be used to get images from a camera device.">CameraProxy</a></code> class can be used to get images from a <a class="el" href="group__interface__camera.html">camera</a> device.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="playerc_09_09_8h_source.html">playerc++.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for PlayerCc::CameraProxy:</div>
<div class="dyncontent">
<div class="center">
<img src="classPlayerCc_1_1CameraProxy.png" usemap="#PlayerCc::CameraProxy_map" alt=""/>
<map id="PlayerCc::CameraProxy_map" name="PlayerCc::CameraProxy_map">
<area href="classPlayerCc_1_1ClientProxy.html" alt="PlayerCc::ClientProxy" shape="rect" coords="0,0,148,24"/>
</map>
</div>
<p><a href="classPlayerCc_1_1CameraProxy-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b5589150ce7853c7bb6b022a2ebc9fd"></a><!-- doxytag: member="PlayerCc::CameraProxy::CameraProxy" ref="a0b5589150ce7853c7bb6b022a2ebc9fd" args="(PlayerClient *aPc, uint32_t aIndex=0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1CameraProxy.html#a0b5589150ce7853c7bb6b022a2ebc9fd">CameraProxy</a> (<a class="el" href="classPlayerCc_1_1PlayerClient.html">PlayerClient</a> *aPc, uint32_t aIndex=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1CameraProxy.html#aa173f86f6e78997733a854bc745ef055">SaveFrame</a> (const std::string aPrefix, uint32_t aWidth=4)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save the frame. <a href="#aa173f86f6e78997733a854bc745ef055"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f46d59d1b306e165e5be35b839665df"></a><!-- doxytag: member="PlayerCc::CameraProxy::Decompress" ref="a3f46d59d1b306e165e5be35b839665df" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1CameraProxy.html#a3f46d59d1b306e165e5be35b839665df">Decompress</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">decompress the image <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad4964de6de5fd6e7bde5878b697aa9d"></a><!-- doxytag: member="PlayerCc::CameraProxy::GetDepth" ref="aad4964de6de5fd6e7bde5878b697aa9d" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1CameraProxy.html#aad4964de6de5fd6e7bde5878b697aa9d">GetDepth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Image color depth. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4c641a35283af9af4b43df0720b74e0c"></a><!-- doxytag: member="PlayerCc::CameraProxy::GetWidth" ref="a4c641a35283af9af4b43df0720b74e0c" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1CameraProxy.html#a4c641a35283af9af4b43df0720b74e0c">GetWidth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Image dimensions (pixels). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f00d1a555a83f7c4e0050c553d4a79d"></a><!-- doxytag: member="PlayerCc::CameraProxy::GetHeight" ref="a6f00d1a555a83f7c4e0050c553d4a79d" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1CameraProxy.html#a6f00d1a555a83f7c4e0050c553d4a79d">GetHeight</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Image dimensions (pixels). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f24afcc216ddb1e66f054a837ace08a"></a><!-- doxytag: member="PlayerCc::CameraProxy::GetFormat" ref="a5f24afcc216ddb1e66f054a837ace08a" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1CameraProxy.html#a5f24afcc216ddb1e66f054a837ace08a">GetFormat</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Image format Possible values include</p>
<ul>
<li><a class="el" href="group__interface__camera.html#ga491778a428dc5856366fb65898555f56">PLAYER_CAMERA_FORMAT_MONO8</a></li>
<li><a class="el" href="group__interface__camera.html#ga248adebdc39257bddfe6a1c2970644ba">PLAYER_CAMERA_FORMAT_MONO16</a></li>
<li><a class="el" href="group__interface__camera.html#ga3082cf4240cebd4aafa90a53aae03150">PLAYER_CAMERA_FORMAT_RGB565</a></li>
<li><a class="el" href="group__interface__camera.html#ga5cf66200e13666288f2b0fc02d92ded5">PLAYER_CAMERA_FORMAT_RGB888</a>. </li>
</ul>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac957c8bb3812174c4e9bd64a7e52a2a9"></a><!-- doxytag: member="PlayerCc::CameraProxy::GetImageSize" ref="ac957c8bb3812174c4e9bd64a7e52a2a9" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1CameraProxy.html#ac957c8bb3812174c4e9bd64a7e52a2a9">GetImageSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Size of the image (bytes). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1CameraProxy.html#a2df1e2a0710a499b0e9f80f55d781e69">GetImage</a> (uint8_t *aImage) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Image data This function copies the image data into the data buffer aImage. <a href="#a2df1e2a0710a499b0e9f80f55d781e69"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a667c49a6e22e2e62d3d98ed99de126ee"></a><!-- doxytag: member="PlayerCc::CameraProxy::GetCompression" ref="a667c49a6e22e2e62d3d98ed99de126ee" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1CameraProxy.html#a667c49a6e22e2e62d3d98ed99de126ee">GetCompression</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">What is the compression type? Currently supported compression types are:</p>
<ul>
<li><a class="el" href="group__interface__camera.html#gab491ae8b2a6f01eb6dc2175078c72997">PLAYER_CAMERA_COMPRESS_RAW</a></li>
<li><a class="el" href="group__interface__camera.html#ga53f904d017e4ee82f38136942465b39b">PLAYER_CAMERA_COMPRESS_JPEG</a>. </li>
</ul>
<br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c30a52c8d8e4c262a6820905eebcfdb"></a><!-- doxytag: member="PlayerCc::CameraProxy::Subscribe" ref="a7c30a52c8d8e4c262a6820905eebcfdb" args="(uint32_t aIndex)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>Subscribe</b> (uint32_t aIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cb38ef2a160e4451943200a33faf437"></a><!-- doxytag: member="PlayerCc::CameraProxy::Unsubscribe" ref="a7cb38ef2a160e4451943200a33faf437" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>Unsubscribe</b> ()</td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27114ca49335ecb1acc92ed71a302f61"></a><!-- doxytag: member="PlayerCc::CameraProxy::mDevice" ref="a27114ca49335ecb1acc92ed71a302f61" args="" -->
<a class="el" href="structplayerc__camera__t.html">playerc_camera_t</a> * </td><td class="memItemRight" valign="bottom"><b>mDevice</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8811835a600a2299afe1c44d6d0bbe0b"></a><!-- doxytag: member="PlayerCc::CameraProxy::mPrefix" ref="a8811835a600a2299afe1c44d6d0bbe0b" args="" -->
std::string </td><td class="memItemRight" valign="bottom"><b>mPrefix</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9225428695a1c07138f80320978fef85"></a><!-- doxytag: member="PlayerCc::CameraProxy::mFrameNo" ref="a9225428695a1c07138f80320978fef85" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>mFrameNo</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <code><a class="el" href="classPlayerCc_1_1CameraProxy.html" title="The CameraProxy class can be used to get images from a camera device.">CameraProxy</a></code> class can be used to get images from a <a class="el" href="group__interface__camera.html">camera</a> device. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2df1e2a0710a499b0e9f80f55d781e69"></a><!-- doxytag: member="PlayerCc::CameraProxy::GetImage" ref="a2df1e2a0710a499b0e9f80f55d781e69" args="(uint8_t *aImage) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PlayerCc::CameraProxy::GetImage </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"> <em>aImage</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Image data This function copies the image data into the data buffer aImage. </p>
<p>The buffer should be allocated according to the width, height, and depth of the image. The size can be found by calling <a class="el" href="classPlayerCc_1_1CameraProxy.html#ac957c8bb3812174c4e9bd64a7e52a2a9">GetImageSize()</a>. </p>
</div>
</div>
<a class="anchor" id="aa173f86f6e78997733a854bc745ef055"></a><!-- doxytag: member="PlayerCc::CameraProxy::SaveFrame" ref="aa173f86f6e78997733a854bc745ef055" args="(const std::string aPrefix, uint32_t aWidth=4)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PlayerCc::CameraProxy::SaveFrame </td>
<td>(</td>
<td class="paramtype">const std::string </td>
<td class="paramname"> <em>aPrefix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>aWidth</em> = <code>4</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Save the frame. </p>
<ul>
<li>aPrefix is the string prefix to name the image. </li>
<li>aWidth is the number of 0s to pad the image numbering with. </li>
</ul>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="playerc_09_09_8h_source.html">playerc++.h</a></li>
</ul>
</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>
