ark1668ed-bsp/buildroot-external/package/libimobiledevice/libimobiledevice-1.2.0/docs/html/screenshotr_8h.html

<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>libimobiledevice: libimobiledevice/screenshotr.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">libimobiledevice
   &#160;<span id="projectnumber">1.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_6f94c0669708509ba6e66291c679659c.html">libimobiledevice</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">screenshotr.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Retrieve a screenshot from device.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a9c5d1af5f0a93ef1426b0fe7789a9603"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c5d1af5f0a93ef1426b0fe7789a9603"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SCREENSHOTR_SERVICE_NAME</b>&#160;&#160;&#160;&quot;com.apple.mobile.screenshotr&quot;</td></tr>
<tr class="separator:a9c5d1af5f0a93ef1426b0fe7789a9603"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:acffbb2bf625eca9bbf27ea9bb90c0f89"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acffbb2bf625eca9bbf27ea9bb90c0f89"></a>
typedef struct <br class="typebreak" />
screenshotr_client_private&#160;</td><td class="memItemRight" valign="bottom"><b>screenshotr_client_private</b></td></tr>
<tr class="separator:acffbb2bf625eca9bbf27ea9bb90c0f89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a984c34c0d361e1dcf6a8ea8f42a3a8a2"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
screenshotr_client_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="screenshotr_8h.html#a984c34c0d361e1dcf6a8ea8f42a3a8a2">screenshotr_client_t</a></td></tr>
<tr class="memdesc:a984c34c0d361e1dcf6a8ea8f42a3a8a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle.  <a href="#a984c34c0d361e1dcf6a8ea8f42a3a8a2">More...</a><br /></td></tr>
<tr class="separator:a984c34c0d361e1dcf6a8ea8f42a3a8a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ac107d1facbbb0015cade697bba93cba4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac107d1facbbb0015cade697bba93cba4"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="screenshotr_8h.html#ac107d1facbbb0015cade697bba93cba4">screenshotr_error_t</a> { <br />
&#160;&#160;<b>SCREENSHOTR_E_SUCCESS</b> = 0, 
<br />
&#160;&#160;<b>SCREENSHOTR_E_INVALID_ARG</b> = -1, 
<br />
&#160;&#160;<b>SCREENSHOTR_E_PLIST_ERROR</b> = -2, 
<br />
&#160;&#160;<b>SCREENSHOTR_E_MUX_ERROR</b> = -3, 
<br />
&#160;&#160;<b>SCREENSHOTR_E_BAD_VERSION</b> = -4, 
<br />
&#160;&#160;<b>SCREENSHOTR_E_UNKNOWN_ERROR</b> = -256
<br />
 }</td></tr>
<tr class="memdesc:ac107d1facbbb0015cade697bba93cba4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error Codes. <br /></td></tr>
<tr class="separator:ac107d1facbbb0015cade697bba93cba4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a61daf51f7cab2672d5a5bab43c510994"><td class="memItemLeft" align="right" valign="top"><a class="el" href="screenshotr_8h.html#ac107d1facbbb0015cade697bba93cba4">screenshotr_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="screenshotr_8h.html#a61daf51f7cab2672d5a5bab43c510994">screenshotr_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="screenshotr_8h.html#a984c34c0d361e1dcf6a8ea8f42a3a8a2">screenshotr_client_t</a> *client)</td></tr>
<tr class="memdesc:a61daf51f7cab2672d5a5bab43c510994"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to the screenshotr service on the specified device.  <a href="#a61daf51f7cab2672d5a5bab43c510994">More...</a><br /></td></tr>
<tr class="separator:a61daf51f7cab2672d5a5bab43c510994"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f06751d0a0f81debf52e2d5f5161d0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="screenshotr_8h.html#ac107d1facbbb0015cade697bba93cba4">screenshotr_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="screenshotr_8h.html#a3f06751d0a0f81debf52e2d5f5161d0b">screenshotr_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="screenshotr_8h.html#a984c34c0d361e1dcf6a8ea8f42a3a8a2">screenshotr_client_t</a> *client, const char *label)</td></tr>
<tr class="memdesc:a3f06751d0a0f81debf52e2d5f5161d0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a new screenshotr service on the specified device and connects to it.  <a href="#a3f06751d0a0f81debf52e2d5f5161d0b">More...</a><br /></td></tr>
<tr class="separator:a3f06751d0a0f81debf52e2d5f5161d0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49cf7ae12699db727d76ccc9b220cb49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="screenshotr_8h.html#ac107d1facbbb0015cade697bba93cba4">screenshotr_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="screenshotr_8h.html#a49cf7ae12699db727d76ccc9b220cb49">screenshotr_client_free</a> (<a class="el" href="screenshotr_8h.html#a984c34c0d361e1dcf6a8ea8f42a3a8a2">screenshotr_client_t</a> client)</td></tr>
<tr class="memdesc:a49cf7ae12699db727d76ccc9b220cb49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a screenshotr client from the device and frees up the screenshotr client data.  <a href="#a49cf7ae12699db727d76ccc9b220cb49">More...</a><br /></td></tr>
<tr class="separator:a49cf7ae12699db727d76ccc9b220cb49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad345d9acd78cb258086c8938d3f77856"><td class="memItemLeft" align="right" valign="top"><a class="el" href="screenshotr_8h.html#ac107d1facbbb0015cade697bba93cba4">screenshotr_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="screenshotr_8h.html#ad345d9acd78cb258086c8938d3f77856">screenshotr_take_screenshot</a> (<a class="el" href="screenshotr_8h.html#a984c34c0d361e1dcf6a8ea8f42a3a8a2">screenshotr_client_t</a> client, char **imgdata, uint64_t *imgsize)</td></tr>
<tr class="memdesc:ad345d9acd78cb258086c8938d3f77856"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a screen shot from the connected device.  <a href="#ad345d9acd78cb258086c8938d3f77856">More...</a><br /></td></tr>
<tr class="separator:ad345d9acd78cb258086c8938d3f77856"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Retrieve a screenshot from device. </p>
<dl class="section note"><dt>Note</dt><dd>Requires a mounted developer image. </dd></dl>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a984c34c0d361e1dcf6a8ea8f42a3a8a2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef screenshotr_client_private* <a class="el" href="screenshotr_8h.html#a984c34c0d361e1dcf6a8ea8f42a3a8a2">screenshotr_client_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The client handle. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a49cf7ae12699db727d76ccc9b220cb49"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="screenshotr_8h.html#ac107d1facbbb0015cade697bba93cba4">screenshotr_error_t</a> screenshotr_client_free </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="screenshotr_8h.html#a984c34c0d361e1dcf6a8ea8f42a3a8a2">screenshotr_client_t</a>&#160;</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 class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">client</td><td>The screenshotr client to disconnect and free.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SCREENSHOTR_E_SUCCESS on success, or SCREENSHOTR_E_INVALID_ARG if client is NULL. </dd></dl>

</div>
</div>
<a class="anchor" id="a61daf51f7cab2672d5a5bab43c510994"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="screenshotr_8h.html#ac107d1facbbb0015cade697bba93cba4">screenshotr_error_t</a> screenshotr_client_new </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
          <td class="paramname"><em>device</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">lockdownd_service_descriptor_t&#160;</td>
          <td class="paramname"><em>service</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="screenshotr_8h.html#a984c34c0d361e1dcf6a8ea8f42a3a8a2">screenshotr_client_t</a> *&#160;</td>
          <td class="paramname"><em>client</em>&#160;</td>
        </tr>
        <tr>
          <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 class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
    <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
    <tr><td class="paramname">client</td><td>Pointer that will be set to a newly allocated screenshotr_client_t upon successful return.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This service is only available if a developer disk image has been mounted.</dd></dl>
<dl class="section return"><dt>Returns</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="a3f06751d0a0f81debf52e2d5f5161d0b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="screenshotr_8h.html#ac107d1facbbb0015cade697bba93cba4">screenshotr_error_t</a> screenshotr_client_start_service </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
          <td class="paramname"><em>device</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="screenshotr_8h.html#a984c34c0d361e1dcf6a8ea8f42a3a8a2">screenshotr_client_t</a> *&#160;</td>
          <td class="paramname"><em>client</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>label</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Starts a new screenshotr service on the specified device and connects to it. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
    <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated screenshotr_client_t upon successful return. Must be freed using <a class="el" href="screenshotr_8h.html#a49cf7ae12699db727d76ccc9b220cb49" title="Disconnects a screenshotr client from the device and frees up the screenshotr client data...">screenshotr_client_free()</a> after use. </td></tr>
    <tr><td class="paramname">label</td><td>The label to use for communication. Usually the program name. Pass NULL to disable sending the label in requests to lockdownd.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SCREENSHOTR_E_SUCCESS on success, or an SCREENSHOTR_E_* error code otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="ad345d9acd78cb258086c8938d3f77856"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="screenshotr_8h.html#ac107d1facbbb0015cade697bba93cba4">screenshotr_error_t</a> screenshotr_take_screenshot </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="screenshotr_8h.html#a984c34c0d361e1dcf6a8ea8f42a3a8a2">screenshotr_client_t</a>&#160;</td>
          <td class="paramname"><em>client</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>imgdata</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint64_t *&#160;</td>
          <td class="paramname"><em>imgsize</em>&#160;</td>
        </tr>
        <tr>
          <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 class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">client</td><td>The connection screenshotr service client. </td></tr>
    <tr><td class="paramname">imgdata</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 class="paramname">imgsize</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="section return"><dt>Returns</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><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>