midi-communications-windows 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +8 -0
  3. data/.version +6 -0
  4. data/.yardoc/checksums +8 -0
  5. data/.yardoc/complete +0 -0
  6. data/.yardoc/object_types +0 -0
  7. data/.yardoc/objects/root.dat +0 -0
  8. data/.yardoc/proxy_types +0 -0
  9. data/.yardopts +8 -0
  10. data/Gemfile +3 -0
  11. data/LICENSE +165 -0
  12. data/README.md +176 -0
  13. data/Rakefile +13 -0
  14. data/doc/MIDICommunicationsWindows/API/MIDIHdr.html +144 -0
  15. data/doc/MIDICommunicationsWindows/API/MIDIInCaps.html +142 -0
  16. data/doc/MIDICommunicationsWindows/API/MIDIOutCaps.html +140 -0
  17. data/doc/MIDICommunicationsWindows/API/MSG.html +143 -0
  18. data/doc/MIDICommunicationsWindows/API.html +981 -0
  19. data/doc/MIDICommunicationsWindows/Device/ClassMethods.html +365 -0
  20. data/doc/MIDICommunicationsWindows/Device/InstanceMethods.html +1096 -0
  21. data/doc/MIDICommunicationsWindows/Device.html +988 -0
  22. data/doc/MIDICommunicationsWindows/Error.html +438 -0
  23. data/doc/MIDICommunicationsWindows/Input.html +1554 -0
  24. data/doc/MIDICommunicationsWindows/Message.html +700 -0
  25. data/doc/MIDICommunicationsWindows/Output.html +1697 -0
  26. data/doc/MIDICommunicationsWindows/TypeConversion.html +369 -0
  27. data/doc/MIDICommunicationsWindows.html +210 -0
  28. data/doc/_index.html +262 -0
  29. data/doc/class_list.html +54 -0
  30. data/doc/css/common.css +1 -0
  31. data/doc/css/full_list.css +206 -0
  32. data/doc/css/style.css +1089 -0
  33. data/doc/file.README.html +240 -0
  34. data/doc/file.testing-on-windows.html +253 -0
  35. data/doc/file_list.html +64 -0
  36. data/doc/frames.html +22 -0
  37. data/doc/index.html +240 -0
  38. data/doc/js/app.js +801 -0
  39. data/doc/js/full_list.js +334 -0
  40. data/doc/js/jquery.js +4 -0
  41. data/doc/method_list.html +382 -0
  42. data/doc/top-level-namespace.html +112 -0
  43. data/docs/testing-on-windows.md +222 -0
  44. data/examples/input.rb +27 -0
  45. data/examples/list_ports.rb +17 -0
  46. data/examples/output.rb +22 -0
  47. data/examples/sysex_output.rb +15 -0
  48. data/lib/midi-communications-windows/api.rb +340 -0
  49. data/lib/midi-communications-windows/device.rb +310 -0
  50. data/lib/midi-communications-windows/input.rb +486 -0
  51. data/lib/midi-communications-windows/message.rb +133 -0
  52. data/lib/midi-communications-windows/output.rb +206 -0
  53. data/lib/midi-communications-windows/type_conversion.rb +20 -0
  54. data/lib/midi-communications-windows/version.rb +4 -0
  55. data/lib/midi-communications-windows.rb +76 -0
  56. data/midi-communications-windows.gemspec +32 -0
  57. metadata +220 -0
data/doc/MIDICommunicationsWindows/Error.html ADDED
@@ -0,0 +1,438 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Exception: MIDICommunicationsWindows::Error
8
+
9
+ &mdash; MIDI Communications Windows API
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css">
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css">
16
+
17
+ <script type="text/javascript">
18
+ pathId = "MIDICommunicationsWindows::Error";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div id="main_progress" aria-hidden="true"></div>
31
+
32
+ <div class="nav_wrap">
33
+ <iframe id="nav" src="../class_list.html?1"></iframe>
34
+ <div id="resizer"></div>
35
+ </div>
36
+
37
+ <div id="main" tabindex="-1">
38
+ <div id="header">
39
+ <div id="menu">
40
+
41
+ <a href="../_index.html">Index (E)</a> &raquo;
42
+ <span class='title'><span class='object_link'><a href="../MIDICommunicationsWindows.html" title="MIDICommunicationsWindows (module)">MIDICommunicationsWindows</a></span></span>
43
+ &raquo;
44
+ <span class="title">Error</span>
45
+
46
+ </div>
47
+
48
+ <div id="search">
49
+
50
+ <a class="full_list_link" id="class_list_link"
51
+ href="../class_list.html">
52
+
53
+ <svg width="24" height="24">
54
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
55
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
56
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
57
+ </svg>
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <div id="content"><h1>Exception: MIDICommunicationsWindows::Error
65
+
66
+
67
+
68
+ </h1>
69
+ <div class="box_info">
70
+
71
+ <dl>
72
+ <dt>Inherits:</dt>
73
+ <dd>
74
+ <span class="inheritName">StandardError</span>
75
+
76
+ <ul class="fullTree">
77
+ <li>Object</li>
78
+
79
+ <li class="next">StandardError</li>
80
+
81
+ <li class="next">MIDICommunicationsWindows::Error</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <dl>
100
+ <dt>Defined in:</dt>
101
+ <dd>lib/midi-communications-windows/api.rb
102
+ </dd>
103
+ </dl>
104
+
105
+ </div>
106
+
107
+ <h2>Overview</h2><div class="docstring">
108
+ <div class="discussion">
109
+ <p>Raised when a WinMM call reports a failure.</p>
110
+ <p>WinMM reports errors as <code>MMRESULT</code> codes rather than by any out-of-band
111
+ mechanism, so every call is checked and a failure becomes an exception at
112
+ the point of the call, carrying the text WinMM itself gives for the code.</p>
113
+
114
+ </div>
115
+ </div>
116
+ <div class="tags">
117
+
118
+
119
+ </div>
120
+
121
+
122
+
123
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
124
+ <ul class="summary">
125
+
126
+ <li class="public ">
127
+ <span class="summary_signature">
128
+
129
+ <a href="#code-instance_method" title="#code (instance method)">#<strong>code</strong> &#x21d2; Integer<sup>?</sup> </a>
130
+
131
+
132
+
133
+ </span>
134
+
135
+
136
+
137
+
138
+ <span class="note title readonly">readonly</span>
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+ <span class="summary_desc"><div class='inline'><p>The <code>MMRESULT</code> WinMM returned, or nil for a failure WinMM did not report as a code — a call that never completed, for instance.</p></div></span>
149
+
150
+ </li>
151
+
152
+
153
+ <li class="public ">
154
+ <span class="summary_signature">
155
+
156
+ <a href="#operation-instance_method" title="#operation (instance method)">#<strong>operation</strong> &#x21d2; Object </a>
157
+
158
+
159
+
160
+ </span>
161
+
162
+
163
+
164
+
165
+ <span class="note title readonly">readonly</span>
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+ <span class="summary_desc"><div class='inline'></div></span>
176
+
177
+ </li>
178
+
179
+
180
+ </ul>
181
+
182
+
183
+
184
+
185
+
186
+ <h2>
187
+ Instance Method Summary
188
+ <small><a href="#" class="summary_toggle">collapse</a></small>
189
+ </h2>
190
+
191
+ <ul class="summary">
192
+
193
+ <li class="public ">
194
+ <span class="summary_signature">
195
+
196
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(operation, code, text = nil) &#x21d2; Error </a>
197
+
198
+
199
+
200
+ </span>
201
+
202
+
203
+ <span class="note title constructor">constructor</span>
204
+
205
+
206
+
207
+
208
+
209
+ <span class="private note title">private</span>
210
+
211
+
212
+ <span class="summary_desc"><div class='inline'><p>A new instance of Error.</p></div></span>
213
+
214
+ </li>
215
+
216
+
217
+ </ul>
218
+
219
+
220
+
221
+
222
+ <div id="constructor_details" class="method_details_list">
223
+ <h2>Constructor Details</h2>
224
+
225
+ <div class="method_details first">
226
+ <h3 class="signature first" id="initialize-instance_method">
227
+
228
+ #<strong>initialize</strong>(operation, code, text = nil) &#x21d2; <tt><span class='object_link'><a href="" title="MIDICommunicationsWindows::Error (class)">Error</a></span></tt>
229
+
230
+
231
+
232
+
233
+
234
+ </h3><div class="docstring">
235
+ <div class="discussion">
236
+ <p class="note private">
237
+ <strong>This method is part of a private API.</strong>
238
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
239
+ </p>
240
+ <p>Returns a new instance of Error.</p>
241
+
242
+ </div>
243
+ </div>
244
+ <div class="tags">
245
+ <p class="tag_title">Parameters:</p>
246
+ <ul class="param">
247
+
248
+ <li>
249
+
250
+ <span class='name'>operation</span>
251
+
252
+
253
+ <span class='type'>(<tt>Symbol</tt>)</span>
254
+
255
+
256
+
257
+ &mdash;
258
+ <div class='inline'><p>the WinMM function that failed</p></div>
259
+
260
+ </li>
261
+
262
+ <li>
263
+
264
+ <span class='name'>code</span>
265
+
266
+
267
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
268
+
269
+
270
+
271
+ &mdash;
272
+ <div class='inline'><p>the <code>MMRESULT</code> code, if there was one</p></div>
273
+
274
+ </li>
275
+
276
+ <li>
277
+
278
+ <span class='name'>text</span>
279
+
280
+
281
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
282
+
283
+
284
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
285
+
286
+
287
+ &mdash;
288
+ <div class='inline'><p>a description of the failure</p></div>
289
+
290
+ </li>
291
+
292
+ </ul>
293
+
294
+
295
+ </div><table class="source_code">
296
+ <tr>
297
+ <td>
298
+ <pre class="lines">
299
+
300
+
301
+ 22
302
+ 23
303
+ 24
304
+ 25
305
+ 26
306
+ 27</pre>
307
+ </td>
308
+ <td>
309
+ <pre class="code"><span class="info file"># File 'lib/midi-communications-windows/api.rb', line 22</span>
310
+
311
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_operation'>operation</span><span class='comma'>,</span> <span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
312
+ <span class='ivar'>@operation</span> <span class='op'>=</span> <span class='id identifier rubyid_operation'>operation</span>
313
+ <span class='ivar'>@code</span> <span class='op'>=</span> <span class='id identifier rubyid_code'>code</span>
314
+
315
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_build_message'>build_message</span><span class='lparen'>(</span><span class='id identifier rubyid_operation'>operation</span><span class='comma'>,</span> <span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='id identifier rubyid_text'>text</span><span class='rparen'>)</span><span class='rparen'>)</span>
316
+ <span class='kw'>end</span></pre>
317
+ </td>
318
+ </tr>
319
+ </table>
320
+ </div>
321
+
322
+ </div>
323
+
324
+ <div id="instance_attr_details" class="attr_details">
325
+ <h2>Instance Attribute Details</h2>
326
+
327
+
328
+ <span id=""></span>
329
+ <div class="method_details first">
330
+ <h3 class="signature first" id="code-instance_method">
331
+
332
+ #<strong>code</strong> &#x21d2; <tt>Integer</tt><sup>?</sup> <span class="extras">(readonly)</span>
333
+
334
+
335
+
336
+
337
+
338
+ </h3><div class="docstring">
339
+ <div class="discussion">
340
+ <p>Returns the <code>MMRESULT</code> WinMM returned, or nil for a
341
+ failure WinMM did not report as a code — a call that never completed,
342
+ for instance.</p>
343
+
344
+ </div>
345
+ </div>
346
+ <div class="tags">
347
+
348
+ <p class="tag_title">Returns:</p>
349
+ <ul class="return">
350
+
351
+ <li>
352
+
353
+
354
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
355
+
356
+
357
+
358
+ &mdash;
359
+ <div class='inline'><p>the <code>MMRESULT</code> WinMM returned, or nil for a
360
+ failure WinMM did not report as a code — a call that never completed,
361
+ for instance</p></div>
362
+
363
+ </li>
364
+
365
+ </ul>
366
+
367
+ </div><table class="source_code">
368
+ <tr>
369
+ <td>
370
+ <pre class="lines">
371
+
372
+
373
+ 16
374
+ 17
375
+ 18</pre>
376
+ </td>
377
+ <td>
378
+ <pre class="code"><span class="info file"># File 'lib/midi-communications-windows/api.rb', line 16</span>
379
+
380
+ <span class='kw'>def</span> <span class='id identifier rubyid_code'>code</span>
381
+ <span class='ivar'>@code</span>
382
+ <span class='kw'>end</span></pre>
383
+ </td>
384
+ </tr>
385
+ </table>
386
+ </div>
387
+
388
+
389
+ <span id=""></span>
390
+ <div class="method_details ">
391
+ <h3 class="signature " id="operation-instance_method">
392
+
393
+ #<strong>operation</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
394
+
395
+
396
+
397
+
398
+
399
+ </h3><div class="docstring">
400
+ <div class="discussion">
401
+
402
+
403
+ </div>
404
+ </div>
405
+ <div class="tags">
406
+
407
+
408
+ </div><table class="source_code">
409
+ <tr>
410
+ <td>
411
+ <pre class="lines">
412
+
413
+
414
+ 16</pre>
415
+ </td>
416
+ <td>
417
+ <pre class="code"><span class="info file"># File 'lib/midi-communications-windows/api.rb', line 16</span>
418
+
419
+ <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:code</span><span class='comma'>,</span> <span class='symbol'>:operation</span></pre>
420
+ </td>
421
+ </tr>
422
+ </table>
423
+ </div>
424
+
425
+ </div>
426
+
427
+
428
+ </div>
429
+
430
+ <div id="footer">
431
+ Generated on Sun Sep 6 21:20:52 2026 by
432
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
433
+ 0.9.45 (ruby-3.4.7).
434
+ </div>
435
+
436
+ </div>
437
+ </body>
438
+ </html>