/usr/share/doc/libjuce/apiref/classAppleRemoteDevice.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 | <!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: AppleRemoteDevice Class 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classAppleRemoteDevice-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AppleRemoteDevice Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Receives events from an Apple IR remote control device (Only available in OSX!).
<a href="classAppleRemoteDevice.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a63ccce128a48e63972e2d71a8de5f8d0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0">ButtonType</a> { <br />
  <a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0a4763e099e23574fe8e7b649e3c964cc9">menuButton</a> = 0,
<a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0ada64dfa4c77be0c1e9450efd26db7f2d">playButton</a>,
<a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0a0a1a0de82c6d765607247bf97fb9f106">plusButton</a>,
<a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0a9acc904c6686677ad3d8dc783d547f71">minusButton</a>,
<br />
  <a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0a41364e422072e6231a74a487f63f08fd">rightButton</a>,
<a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0a811f6391048193b13e401ca40d610713">leftButton</a>,
<a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0aebf3d7bc747ddd6b471d7a71a330432b">rightButton_Long</a>,
<a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0a9a8742b6148aca5e32dec97292781ae0">leftButton_Long</a>,
<br />
  <a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0a0fc32b5afdcfca212c4003ea68bdbfaa">menuButton_Long</a>,
<a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0a57f28e98dc961f444c7db15bbd2ee8eb">playButtonSleepMode</a>,
<a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0ae278b856f84c176f8a1628c118e902fc">switched</a>
<br />
}<tr class="memdesc:a63ccce128a48e63972e2d71a8de5f8d0"><td class="mdescLeft"> </td><td class="mdescRight">The set of buttons that may be pressed. <a href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a63ccce128a48e63972e2d71a8de5f8d0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac44938079806a0136950f95850e587f0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppleRemoteDevice.html#ac44938079806a0136950f95850e587f0">AppleRemoteDevice</a> ()</td></tr>
<tr class="separator:ac44938079806a0136950f95850e587f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7ce0c2716f3a62e1eab5cbd23445ce0"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppleRemoteDevice.html#aa7ce0c2716f3a62e1eab5cbd23445ce0">~AppleRemoteDevice</a> ()</td></tr>
<tr class="separator:aa7ce0c2716f3a62e1eab5cbd23445ce0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6392fda8b943236427da2af0dc80b445"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppleRemoteDevice.html#a6392fda8b943236427da2af0dc80b445">buttonPressed</a> (<a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0">ButtonType</a> buttonId, bool isDown)=0</td></tr>
<tr class="memdesc:a6392fda8b943236427da2af0dc80b445"><td class="mdescLeft"> </td><td class="mdescRight">Override this method to receive the callback about a button press. <a href="#a6392fda8b943236427da2af0dc80b445">More...</a><br /></td></tr>
<tr class="separator:a6392fda8b943236427da2af0dc80b445"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a826fd7464bf27550c7f62cf17bc06189"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppleRemoteDevice.html#a826fd7464bf27550c7f62cf17bc06189">start</a> (bool inExclusiveMode)</td></tr>
<tr class="memdesc:a826fd7464bf27550c7f62cf17bc06189"><td class="mdescLeft"> </td><td class="mdescRight">Starts the device running and responding to events. <a href="#a826fd7464bf27550c7f62cf17bc06189">More...</a><br /></td></tr>
<tr class="separator:a826fd7464bf27550c7f62cf17bc06189"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af828962a01ccbbedf9cc8b086b3edb34"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppleRemoteDevice.html#af828962a01ccbbedf9cc8b086b3edb34">stop</a> ()</td></tr>
<tr class="memdesc:af828962a01ccbbedf9cc8b086b3edb34"><td class="mdescLeft"> </td><td class="mdescRight">Stops the device running. <a href="#af828962a01ccbbedf9cc8b086b3edb34">More...</a><br /></td></tr>
<tr class="separator:af828962a01ccbbedf9cc8b086b3edb34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff9ede05c512376156e94c72ed941634"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppleRemoteDevice.html#aff9ede05c512376156e94c72ed941634">isActive</a> () const</td></tr>
<tr class="memdesc:aff9ede05c512376156e94c72ed941634"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the device has been started successfully. <a href="#aff9ede05c512376156e94c72ed941634">More...</a><br /></td></tr>
<tr class="separator:aff9ede05c512376156e94c72ed941634"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05d5de1d6a2190f8debd05e5ab2d1c21"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppleRemoteDevice.html#a05d5de1d6a2190f8debd05e5ab2d1c21">getRemoteId</a> () const</td></tr>
<tr class="memdesc:a05d5de1d6a2190f8debd05e5ab2d1c21"><td class="mdescLeft"> </td><td class="mdescRight">Returns the ID number of the remote, if it has sent one. <a href="#a05d5de1d6a2190f8debd05e5ab2d1c21">More...</a><br /></td></tr>
<tr class="separator:a05d5de1d6a2190f8debd05e5ab2d1c21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a016dfb4c500b9813c935f7387872d112"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppleRemoteDevice.html#a016dfb4c500b9813c935f7387872d112">handleCallbackInternal</a> ()</td></tr>
<tr class="separator:a016dfb4c500b9813c935f7387872d112"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Receives events from an Apple IR remote control device (Only available in OSX!). </p>
<p>To use it, just create a subclass of this class, implementing the <a class="el" href="classAppleRemoteDevice.html#a6392fda8b943236427da2af0dc80b445" title="Override this method to receive the callback about a button press. ">buttonPressed()</a> callback, then call <a class="el" href="classAppleRemoteDevice.html#a826fd7464bf27550c7f62cf17bc06189" title="Starts the device running and responding to events. ">start()</a> and <a class="el" href="classAppleRemoteDevice.html#af828962a01ccbbedf9cc8b086b3edb34" title="Stops the device running. ">stop()</a> to start or stop receiving events. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a63ccce128a48e63972e2d71a8de5f8d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63ccce128a48e63972e2d71a8de5f8d0">§ </a></span>ButtonType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0">AppleRemoteDevice::ButtonType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The set of buttons that may be pressed. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAppleRemoteDevice.html#a6392fda8b943236427da2af0dc80b445" title="Override this method to receive the callback about a button press. ">buttonPressed</a> </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a63ccce128a48e63972e2d71a8de5f8d0a4763e099e23574fe8e7b649e3c964cc9"></a>menuButton </td><td class="fielddoc"><p>The menu button (if it's held for a short time). </p>
</td></tr>
<tr><td class="fieldname"><a id="a63ccce128a48e63972e2d71a8de5f8d0ada64dfa4c77be0c1e9450efd26db7f2d"></a>playButton </td><td class="fielddoc"><p>The play button. </p>
</td></tr>
<tr><td class="fieldname"><a id="a63ccce128a48e63972e2d71a8de5f8d0a0a1a0de82c6d765607247bf97fb9f106"></a>plusButton </td><td class="fielddoc"><p>The plus or volume-up button. </p>
</td></tr>
<tr><td class="fieldname"><a id="a63ccce128a48e63972e2d71a8de5f8d0a9acc904c6686677ad3d8dc783d547f71"></a>minusButton </td><td class="fielddoc"><p>The minus or volume-down button. </p>
</td></tr>
<tr><td class="fieldname"><a id="a63ccce128a48e63972e2d71a8de5f8d0a41364e422072e6231a74a487f63f08fd"></a>rightButton </td><td class="fielddoc"><p>The right button (if it's held for a short time). </p>
</td></tr>
<tr><td class="fieldname"><a id="a63ccce128a48e63972e2d71a8de5f8d0a811f6391048193b13e401ca40d610713"></a>leftButton </td><td class="fielddoc"><p>The left button (if it's held for a short time). </p>
</td></tr>
<tr><td class="fieldname"><a id="a63ccce128a48e63972e2d71a8de5f8d0aebf3d7bc747ddd6b471d7a71a330432b"></a>rightButton_Long </td><td class="fielddoc"><p>The right button (if it's held for a long time). </p>
</td></tr>
<tr><td class="fieldname"><a id="a63ccce128a48e63972e2d71a8de5f8d0a9a8742b6148aca5e32dec97292781ae0"></a>leftButton_Long </td><td class="fielddoc"><p>The menu button (if it's held for a long time). </p>
</td></tr>
<tr><td class="fieldname"><a id="a63ccce128a48e63972e2d71a8de5f8d0a0fc32b5afdcfca212c4003ea68bdbfaa"></a>menuButton_Long </td><td class="fielddoc"><p>The menu button (if it's held for a long time). </p>
</td></tr>
<tr><td class="fieldname"><a id="a63ccce128a48e63972e2d71a8de5f8d0a57f28e98dc961f444c7db15bbd2ee8eb"></a>playButtonSleepMode </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a63ccce128a48e63972e2d71a8de5f8d0ae278b856f84c176f8a1628c118e902fc"></a>switched </td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ac44938079806a0136950f95850e587f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac44938079806a0136950f95850e587f0">§ </a></span>AppleRemoteDevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AppleRemoteDevice::AppleRemoteDevice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa7ce0c2716f3a62e1eab5cbd23445ce0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7ce0c2716f3a62e1eab5cbd23445ce0">§ </a></span>~AppleRemoteDevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual AppleRemoteDevice::~AppleRemoteDevice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6392fda8b943236427da2af0dc80b445"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6392fda8b943236427da2af0dc80b445">§ </a></span>buttonPressed()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void AppleRemoteDevice::buttonPressed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAppleRemoteDevice.html#a63ccce128a48e63972e2d71a8de5f8d0">ButtonType</a> </td>
<td class="paramname"><em>buttonId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isDown</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Override this method to receive the callback about a button press. </p>
<p>The callback will happen on the application's message thread.</p>
<p>Some buttons trigger matching up and down events, in which the isDown parameter will be true and then false. Others only send a single event when the button is pressed. </p>
</div>
</div>
<a id="a826fd7464bf27550c7f62cf17bc06189"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a826fd7464bf27550c7f62cf17bc06189">§ </a></span>start()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AppleRemoteDevice::start </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>inExclusiveMode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts the device running and responding to events. </p>
<p>Returns true if it managed to open the device.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inExclusiveMode</td><td>if true, the remote will be grabbed exclusively for this app, and will not be available to any other part of the system. If false, it will be shared with other apps. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAppleRemoteDevice.html#af828962a01ccbbedf9cc8b086b3edb34" title="Stops the device running. ">stop</a> </dd></dl>
</div>
</div>
<a id="af828962a01ccbbedf9cc8b086b3edb34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af828962a01ccbbedf9cc8b086b3edb34">§ </a></span>stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AppleRemoteDevice::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stops the device running. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAppleRemoteDevice.html#a826fd7464bf27550c7f62cf17bc06189" title="Starts the device running and responding to events. ">start</a> </dd></dl>
</div>
</div>
<a id="aff9ede05c512376156e94c72ed941634"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff9ede05c512376156e94c72ed941634">§ </a></span>isActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AppleRemoteDevice::isActive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the device has been started successfully. </p>
</div>
</div>
<a id="a05d5de1d6a2190f8debd05e5ab2d1c21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05d5de1d6a2190f8debd05e5ab2d1c21">§ </a></span>getRemoteId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int AppleRemoteDevice::getRemoteId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the ID number of the remote, if it has sent one. </p>
<p>References <a class="el" href="juce__PlatformDefs_8h.html#a851b02724a8158a7f746c66b5758b3dd">JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR</a>.</p>
</div>
</div>
<a id="a016dfb4c500b9813c935f7387872d112"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a016dfb4c500b9813c935f7387872d112">§ </a></span>handleCallbackInternal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AppleRemoteDevice::handleCallbackInternal </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__AppleRemote_8h.html">juce_AppleRemote.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|