<!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"/>
<title>libimobiledevice: libimobiledevice/screenshotr.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>libimobiledevice/screenshotr.h File Reference</h1>
<p>Screenshot service implementation.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2screenshotr_8h.html#a2bc1bba321ff39b89b8e46071cb3828b">screenshotr_error_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Represents an error code. <a href="#a2bc1bba321ff39b89b8e46071cb3828b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
<a class="el" href="structscreenshotr__client__private.html">screenshotr_client_private</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2screenshotr_8h.html#a984c34c0d361e1dcf6a8ea8f42a3a8a2">screenshotr_client_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#a984c34c0d361e1dcf6a8ea8f42a3a8a2"></a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2screenshotr_8h.html#a2bc1bba321ff39b89b8e46071cb3828b">screenshotr_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2screenshotr_8h.html#a433fc45659c727210a26ff02d741c575">screenshotr_client_new</a> (<a class="el" href="structidevice__private.html">idevice_t</a> device, uint16_t port, <a class="el" href="structscreenshotr__client__private.html">screenshotr_client_t</a> *client)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connects to the screenshotr service on the specified device. <a href="#a433fc45659c727210a26ff02d741c575"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2screenshotr_8h.html#a2bc1bba321ff39b89b8e46071cb3828b">screenshotr_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2screenshotr_8h.html#a49cf7ae12699db727d76ccc9b220cb49">screenshotr_client_free</a> (<a class="el" href="structscreenshotr__client__private.html">screenshotr_client_t</a> client)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnects a screenshotr client from the device and frees up the screenshotr client data. <a href="#a49cf7ae12699db727d76ccc9b220cb49"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2screenshotr_8h.html#a2bc1bba321ff39b89b8e46071cb3828b">screenshotr_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2screenshotr_8h.html#ad345d9acd78cb258086c8938d3f77856">screenshotr_take_screenshot</a> (<a class="el" href="structscreenshotr__client__private.html">screenshotr_client_t</a> client, char **imgdata, uint64_t *imgsize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a screen shot from the connected device. <a href="#ad345d9acd78cb258086c8938d3f77856"></a><br/></td></tr>
<tr><td colspan="2"><h2>Error Codes</h2></td></tr>
<tr><td colspan="2"><p><a class="anchor" id="amgrp5c244138ac975df1b1cec1afc71a6c9a"></a> </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae642a8f91add83e2c8612340c73ac045"></a><!-- doxytag: member="include/libimobiledevice/screenshotr.h::SCREENSHOTR_E_SUCCESS" ref="ae642a8f91add83e2c8612340c73ac045" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>SCREENSHOTR_E_SUCCESS</b> 0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae435e9bbb0f33c48cdefd62162c36ff0"></a><!-- doxytag: member="include/libimobiledevice/screenshotr.h::SCREENSHOTR_E_INVALID_ARG" ref="ae435e9bbb0f33c48cdefd62162c36ff0" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>SCREENSHOTR_E_INVALID_ARG</b> -1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af981a6976f67ca5855067cdcfa485a43"></a><!-- doxytag: member="include/libimobiledevice/screenshotr.h::SCREENSHOTR_E_PLIST_ERROR" ref="af981a6976f67ca5855067cdcfa485a43" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>SCREENSHOTR_E_PLIST_ERROR</b> -2</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b50a8c9026e903a4aad9ae3b8963999"></a><!-- doxytag: member="include/libimobiledevice/screenshotr.h::SCREENSHOTR_E_MUX_ERROR" ref="a3b50a8c9026e903a4aad9ae3b8963999" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>SCREENSHOTR_E_MUX_ERROR</b> -3</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b8ff02787c5939c981d48a60d7b153e"></a><!-- doxytag: member="include/libimobiledevice/screenshotr.h::SCREENSHOTR_E_BAD_VERSION" ref="a5b8ff02787c5939c981d48a60d7b153e" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>SCREENSHOTR_E_BAD_VERSION</b> -4</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a36bb404d2ab3040e89db7c6692656f49"></a><!-- doxytag: member="include/libimobiledevice/screenshotr.h::SCREENSHOTR_E_UNKNOWN_ERROR" ref="a36bb404d2ab3040e89db7c6692656f49" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>SCREENSHOTR_E_UNKNOWN_ERROR</b> -256</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Screenshot service implementation. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a984c34c0d361e1dcf6a8ea8f42a3a8a2"></a><!-- doxytag: member="screenshotr.h::screenshotr_client_t" ref="a984c34c0d361e1dcf6a8ea8f42a3a8a2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structscreenshotr__client__private.html">screenshotr_client_private</a>* <a class="el" href="structscreenshotr__client__private.html">screenshotr_client_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The client handle. </p>
</div>
</div>
<a class="anchor" id="a2bc1bba321ff39b89b8e46071cb3828b"></a><!-- doxytag: member="screenshotr.h::screenshotr_error_t" ref="a2bc1bba321ff39b89b8e46071cb3828b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2screenshotr_8h.html#a2bc1bba321ff39b89b8e46071cb3828b">screenshotr_error_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Represents an error code. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a49cf7ae12699db727d76ccc9b220cb49"></a><!-- doxytag: member="screenshotr.h::screenshotr_client_free" ref="a49cf7ae12699db727d76ccc9b220cb49" args="(screenshotr_client_t client)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2screenshotr_8h.html#a2bc1bba321ff39b89b8e46071cb3828b">screenshotr_error_t</a> screenshotr_client_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structscreenshotr__client__private.html">screenshotr_client_t</a> </td>
<td class="paramname"> <em>client</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Disconnects a screenshotr client from the device and frees up the screenshotr client data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>client</em> </td><td>The screenshotr client to disconnect and free.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCREENSHOTR_E_SUCCESS on success, or SCREENSHOTR_E_INVALID_ARG if client is NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="a433fc45659c727210a26ff02d741c575"></a><!-- doxytag: member="screenshotr.h::screenshotr_client_new" ref="a433fc45659c727210a26ff02d741c575" args="(idevice_t device, uint16_t port, screenshotr_client_t *client)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2screenshotr_8h.html#a2bc1bba321ff39b89b8e46071cb3828b">screenshotr_error_t</a> screenshotr_client_new </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structidevice__private.html">idevice_t</a> </td>
<td class="paramname"> <em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structscreenshotr__client__private.html">screenshotr_client_t</a> * </td>
<td class="paramname"> <em>client</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connects to the screenshotr service on the specified device. </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>The device to connect to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>Destination port (usually given by lockdownd_start_service). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>client</em> </td><td>Pointer that will be set to a newly allocated screenshotr_client_t upon successful return.</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>This service is only available if a developer disk image has been mounted.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCREENSHOTR_E_SUCCESS on success, SCREENSHOTR_E_INVALID ARG if one or more parameters are invalid, or SCREENSHOTR_E_CONN_FAILED if the connection to the device could not be established. </dd></dl>
</div>
</div>
<a class="anchor" id="ad345d9acd78cb258086c8938d3f77856"></a><!-- doxytag: member="screenshotr.h::screenshotr_take_screenshot" ref="ad345d9acd78cb258086c8938d3f77856" args="(screenshotr_client_t client, char **imgdata, uint64_t *imgsize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2screenshotr_8h.html#a2bc1bba321ff39b89b8e46071cb3828b">screenshotr_error_t</a> screenshotr_take_screenshot </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structscreenshotr__client__private.html">screenshotr_client_t</a> </td>
<td class="paramname"> <em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>imgdata</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t * </td>
<td class="paramname"> <em>imgsize</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a screen shot from the connected device. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>client</em> </td><td>The connection screenshotr service client. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>imgdata</em> </td><td>Pointer that will point to a newly allocated buffer containing TIFF image data upon successful return. It is up to the caller to free the memory. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>imgsize</em> </td><td>Pointer to a uint64_t that will be set to the size of the buffer imgdata points to upon successful return.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCREENSHOTR_E_SUCCESS on success, SCREENSHOTR_E_INVALID_ARG if one or more parameters are invalid, or another error code if an error occured. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Oct 4 16:38:48 2010 for libimobiledevice by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
