midi-communications-macos 0.6.1 → 0.7.0
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.
- checksums.yaml +4 -4
- data/.version +6 -0
- data/.yardoc/checksums +9 -0
- data/.yardoc/complete +0 -0
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
- data/.yardopts +6 -0
- data/LICENSE +159 -668
- data/README.md +6 -13
- data/doc/MIDICommunicationsMacOS/API/CF.html +124 -0
- data/doc/MIDICommunicationsMacOS/API/HostTime.html +124 -0
- data/doc/MIDICommunicationsMacOS/API/MIDIPacket.html +137 -0
- data/doc/MIDICommunicationsMacOS/API/MIDIPacketList.html +137 -0
- data/doc/MIDICommunicationsMacOS/API/MIDISysexSendRequest.html +137 -0
- data/doc/MIDICommunicationsMacOS/API.html +912 -0
- data/doc/MIDICommunicationsMacOS/Destination.html +1983 -0
- data/doc/MIDICommunicationsMacOS/Device.html +1102 -0
- data/doc/MIDICommunicationsMacOS/Endpoint.html +1665 -0
- data/doc/MIDICommunicationsMacOS/Entity.html +971 -0
- data/doc/MIDICommunicationsMacOS/Source.html +1784 -0
- data/doc/MIDICommunicationsMacOS/TypeConversion.html +393 -0
- data/doc/MIDICommunicationsMacOS.html +214 -0
- data/doc/_index.html +250 -0
- data/doc/class_list.html +54 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +503 -0
- data/doc/file.README.html +275 -0
- data/doc/file_list.html +59 -0
- data/doc/frames.html +22 -0
- data/doc/index.html +275 -0
- data/doc/js/app.js +344 -0
- data/doc/js/full_list.js +242 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +542 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/midi-communications-macos/api.rb +7 -1
- data/lib/midi-communications-macos/destination.rb +86 -20
- data/lib/midi-communications-macos/device.rb +52 -18
- data/lib/midi-communications-macos/endpoint.rb +31 -5
- data/lib/midi-communications-macos/entity.rb +20 -6
- data/lib/midi-communications-macos/source.rb +79 -19
- data/lib/midi-communications-macos/type_conversion.rb +11 -4
- data/lib/midi-communications-macos/version.rb +2 -1
- data/lib/midi-communications-macos.rb +37 -0
- data/midi-communications-macos.gemspec +11 -9
- metadata +83 -4
|
@@ -0,0 +1,971 @@
|
|
|
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
|
+
Class: MIDICommunicationsMacOS::Entity
|
|
8
|
+
|
|
9
|
+
— MIDI Communications macOS 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 = "MIDICommunicationsMacOS::Entity";
|
|
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 class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (E)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../MIDICommunicationsMacOS.html" title="MIDICommunicationsMacOS (module)">MIDICommunicationsMacOS</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Entity</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: MIDICommunicationsMacOS::Entity
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">MIDICommunicationsMacOS::Entity</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/midi-communications-macos/entity.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
<p>A logical grouping of MIDI endpoints within a device.</p>
|
|
105
|
+
|
|
106
|
+
<p>A MIDI entity can have any number of MIDI endpoints, each of which is a
|
|
107
|
+
<span class='object_link'><a href="Source.html" title="MIDICommunicationsMacOS::Source (class)">source</a></span> or <span class='object_link'><a href="Destination.html" title="MIDICommunicationsMacOS::Destination (class)">destination</a></span> of a 16-channel MIDI stream.
|
|
108
|
+
By grouping a device's endpoints into entities, the system has enough
|
|
109
|
+
information for applications to make reasonable default assumptions about
|
|
110
|
+
bidirectional communication.</p>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
</div>
|
|
115
|
+
<div class="tags">
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
<p class="tag_title">See Also:</p>
|
|
119
|
+
<ul class="see">
|
|
120
|
+
|
|
121
|
+
<li><a href="https://developer.apple.com/documentation/coremidi/midientityref" target="_parent" title="https://developer.apple.com/documentation/coremidi/midientityref">https://developer.apple.com/documentation/coremidi/midientityref</a></li>
|
|
122
|
+
|
|
123
|
+
</ul>
|
|
124
|
+
|
|
125
|
+
</div>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
130
|
+
<ul class="summary">
|
|
131
|
+
|
|
132
|
+
<li class="public ">
|
|
133
|
+
<span class="summary_signature">
|
|
134
|
+
|
|
135
|
+
<a href="#endpoints-instance_method" title="#endpoints (instance method)">#<strong>endpoints</strong> ⇒ Hash{Symbol => Array<Endpoint>} </a>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
</span>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
<span class="note title readonly">readonly</span>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
<span class="summary_desc"><div class='inline'><p>Endpoints grouped by :source and :destination.</p>
|
|
155
|
+
</div></span>
|
|
156
|
+
|
|
157
|
+
</li>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
<li class="public ">
|
|
161
|
+
<span class="summary_signature">
|
|
162
|
+
|
|
163
|
+
<a href="#manufacturer-instance_method" title="#manufacturer (instance method)">#<strong>manufacturer</strong> ⇒ String </a>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
</span>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
<span class="note title readonly">readonly</span>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<span class="summary_desc"><div class='inline'><p>Device manufacturer name.</p>
|
|
183
|
+
</div></span>
|
|
184
|
+
|
|
185
|
+
</li>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
<li class="public ">
|
|
189
|
+
<span class="summary_signature">
|
|
190
|
+
|
|
191
|
+
<a href="#model-instance_method" title="#model (instance method)">#<strong>model</strong> ⇒ String </a>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
</span>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<span class="note title readonly">readonly</span>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<span class="summary_desc"><div class='inline'><p>Device model name.</p>
|
|
211
|
+
</div></span>
|
|
212
|
+
|
|
213
|
+
</li>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
<li class="public ">
|
|
217
|
+
<span class="summary_signature">
|
|
218
|
+
|
|
219
|
+
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ String </a>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
</span>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<span class="note title readonly">readonly</span>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<span class="summary_desc"><div class='inline'><p>Entity name.</p>
|
|
239
|
+
</div></span>
|
|
240
|
+
|
|
241
|
+
</li>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<li class="public ">
|
|
245
|
+
<span class="summary_signature">
|
|
246
|
+
|
|
247
|
+
<a href="#resource-instance_method" title="#resource (instance method)">#<strong>resource</strong> ⇒ Object </a>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
</span>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
<span class="note title readonly">readonly</span>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
267
|
+
|
|
268
|
+
</li>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
</ul>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<h2>
|
|
278
|
+
Instance Method Summary
|
|
279
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
280
|
+
</h2>
|
|
281
|
+
|
|
282
|
+
<ul class="summary">
|
|
283
|
+
|
|
284
|
+
<li class="public ">
|
|
285
|
+
<span class="summary_signature">
|
|
286
|
+
|
|
287
|
+
<a href="#display_name-instance_method" title="#display_name (instance method)">#<strong>display_name</strong> ⇒ String </a>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
</span>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<span class="summary_desc"><div class='inline'><p>Construct a display name for the entity.</p>
|
|
302
|
+
</div></span>
|
|
303
|
+
|
|
304
|
+
</li>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
<li class="public ">
|
|
308
|
+
<span class="summary_signature">
|
|
309
|
+
|
|
310
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(resource, include_offline: false) ⇒ Entity </a>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
</span>
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
<span class="note title constructor">constructor</span>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
<span class="summary_desc"><div class='inline'><p>A new instance of Entity.</p>
|
|
327
|
+
</div></span>
|
|
328
|
+
|
|
329
|
+
</li>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
<li class="public ">
|
|
333
|
+
<span class="summary_signature">
|
|
334
|
+
|
|
335
|
+
<a href="#online%3F-instance_method" title="#online? (instance method)">#<strong>online?</strong> ⇒ Boolean </a>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
</span>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
<span class="summary_desc"><div class='inline'><p>Is the entity online?.</p>
|
|
350
|
+
</div></span>
|
|
351
|
+
|
|
352
|
+
</li>
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
<li class="public ">
|
|
356
|
+
<span class="summary_signature">
|
|
357
|
+
|
|
358
|
+
<a href="#populate_endpoint_ids-instance_method" title="#populate_endpoint_ids (instance method)">#<strong>populate_endpoint_ids</strong>(starting_id) ⇒ Integer </a>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
</span>
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
<span class="summary_desc"><div class='inline'><p>Assign all of this Entity's endpoints an consecutive local id.</p>
|
|
373
|
+
</div></span>
|
|
374
|
+
|
|
375
|
+
</li>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
</ul>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
<div id="constructor_details" class="method_details_list">
|
|
382
|
+
<h2>Constructor Details</h2>
|
|
383
|
+
|
|
384
|
+
<div class="method_details first">
|
|
385
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
386
|
+
|
|
387
|
+
#<strong>initialize</strong>(resource, include_offline: false) ⇒ <tt><span class='object_link'><a href="" title="MIDICommunicationsMacOS::Entity (class)">Entity</a></span></tt>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
</h3><div class="docstring">
|
|
394
|
+
<div class="discussion">
|
|
395
|
+
<p>Returns a new instance of Entity.</p>
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
</div>
|
|
399
|
+
</div>
|
|
400
|
+
<div class="tags">
|
|
401
|
+
<p class="tag_title">Parameters:</p>
|
|
402
|
+
<ul class="param">
|
|
403
|
+
|
|
404
|
+
<li>
|
|
405
|
+
|
|
406
|
+
<span class='name'>resource</span>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
<span class='type'>(<tt>FFI::Pointer</tt>)</span>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
—
|
|
414
|
+
<div class='inline'><p>A pointer to the underlying entity</p>
|
|
415
|
+
</div>
|
|
416
|
+
|
|
417
|
+
</li>
|
|
418
|
+
|
|
419
|
+
<li>
|
|
420
|
+
|
|
421
|
+
<span class='name'>include_offline</span>
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
—
|
|
431
|
+
<div class='inline'><p>Include offline endpoints in the list</p>
|
|
432
|
+
</div>
|
|
433
|
+
|
|
434
|
+
</li>
|
|
435
|
+
|
|
436
|
+
</ul>
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
</div><table class="source_code">
|
|
440
|
+
<tr>
|
|
441
|
+
<td>
|
|
442
|
+
<pre class="lines">
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
32
|
|
446
|
+
33
|
|
447
|
+
34
|
|
448
|
+
35
|
|
449
|
+
36
|
|
450
|
+
37
|
|
451
|
+
38
|
|
452
|
+
39</pre>
|
|
453
|
+
</td>
|
|
454
|
+
<td>
|
|
455
|
+
<pre class="code"><span class="info file"># File 'lib/midi-communications-macos/entity.rb', line 32</span>
|
|
456
|
+
|
|
457
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='label'>include_offline:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
458
|
+
<span class='ivar'>@endpoints</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
459
|
+
<span class='label'>source:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
460
|
+
<span class='label'>destination:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
461
|
+
<span class='rbrace'>}</span>
|
|
462
|
+
<span class='ivar'>@resource</span> <span class='op'>=</span> <span class='id identifier rubyid_resource'>resource</span>
|
|
463
|
+
<span class='id identifier rubyid_populate'>populate</span><span class='lparen'>(</span><span class='label'>include_offline:</span> <span class='id identifier rubyid_include_offline'>include_offline</span><span class='rparen'>)</span>
|
|
464
|
+
<span class='kw'>end</span></pre>
|
|
465
|
+
</td>
|
|
466
|
+
</tr>
|
|
467
|
+
</table>
|
|
468
|
+
</div>
|
|
469
|
+
|
|
470
|
+
</div>
|
|
471
|
+
|
|
472
|
+
<div id="instance_attr_details" class="attr_details">
|
|
473
|
+
<h2>Instance Attribute Details</h2>
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
<span id=""></span>
|
|
477
|
+
<div class="method_details first">
|
|
478
|
+
<h3 class="signature first" id="endpoints-instance_method">
|
|
479
|
+
|
|
480
|
+
#<strong>endpoints</strong> ⇒ <tt>Hash{Symbol => Array<<span class='object_link'><a href="Endpoint.html" title="MIDICommunicationsMacOS::Endpoint (module)">Endpoint</a></span>>}</tt> <span class="extras">(readonly)</span>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
</h3><div class="docstring">
|
|
487
|
+
<div class="discussion">
|
|
488
|
+
<p>Returns endpoints grouped by :source and :destination.</p>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
</div>
|
|
492
|
+
</div>
|
|
493
|
+
<div class="tags">
|
|
494
|
+
|
|
495
|
+
<p class="tag_title">Returns:</p>
|
|
496
|
+
<ul class="return">
|
|
497
|
+
|
|
498
|
+
<li>
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
<span class='type'>(<tt>Hash{Symbol => Array<<span class='object_link'><a href="Endpoint.html" title="MIDICommunicationsMacOS::Endpoint (module)">Endpoint</a></span>>}</tt>)</span>
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
—
|
|
506
|
+
<div class='inline'><p>endpoints grouped by :source and :destination</p>
|
|
507
|
+
</div>
|
|
508
|
+
|
|
509
|
+
</li>
|
|
510
|
+
|
|
511
|
+
</ul>
|
|
512
|
+
|
|
513
|
+
</div><table class="source_code">
|
|
514
|
+
<tr>
|
|
515
|
+
<td>
|
|
516
|
+
<pre class="lines">
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
24
|
|
520
|
+
25
|
|
521
|
+
26</pre>
|
|
522
|
+
</td>
|
|
523
|
+
<td>
|
|
524
|
+
<pre class="code"><span class="info file"># File 'lib/midi-communications-macos/entity.rb', line 24</span>
|
|
525
|
+
|
|
526
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_endpoints'>endpoints</span>
|
|
527
|
+
<span class='ivar'>@endpoints</span>
|
|
528
|
+
<span class='kw'>end</span></pre>
|
|
529
|
+
</td>
|
|
530
|
+
</tr>
|
|
531
|
+
</table>
|
|
532
|
+
</div>
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
<span id=""></span>
|
|
536
|
+
<div class="method_details ">
|
|
537
|
+
<h3 class="signature " id="manufacturer-instance_method">
|
|
538
|
+
|
|
539
|
+
#<strong>manufacturer</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
</h3><div class="docstring">
|
|
546
|
+
<div class="discussion">
|
|
547
|
+
<p>Returns device manufacturer name.</p>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
</div>
|
|
551
|
+
</div>
|
|
552
|
+
<div class="tags">
|
|
553
|
+
|
|
554
|
+
<p class="tag_title">Returns:</p>
|
|
555
|
+
<ul class="return">
|
|
556
|
+
|
|
557
|
+
<li>
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
—
|
|
565
|
+
<div class='inline'><p>device manufacturer name</p>
|
|
566
|
+
</div>
|
|
567
|
+
|
|
568
|
+
</li>
|
|
569
|
+
|
|
570
|
+
</ul>
|
|
571
|
+
|
|
572
|
+
</div><table class="source_code">
|
|
573
|
+
<tr>
|
|
574
|
+
<td>
|
|
575
|
+
<pre class="lines">
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
24
|
|
579
|
+
25
|
|
580
|
+
26
|
|
581
|
+
27
|
|
582
|
+
28</pre>
|
|
583
|
+
</td>
|
|
584
|
+
<td>
|
|
585
|
+
<pre class="code"><span class="info file"># File 'lib/midi-communications-macos/entity.rb', line 24</span>
|
|
586
|
+
|
|
587
|
+
<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:endpoints</span><span class='comma'>,</span>
|
|
588
|
+
<span class='symbol'>:manufacturer</span><span class='comma'>,</span>
|
|
589
|
+
<span class='symbol'>:model</span><span class='comma'>,</span>
|
|
590
|
+
<span class='symbol'>:name</span><span class='comma'>,</span>
|
|
591
|
+
<span class='symbol'>:resource</span></pre>
|
|
592
|
+
</td>
|
|
593
|
+
</tr>
|
|
594
|
+
</table>
|
|
595
|
+
</div>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
<span id=""></span>
|
|
599
|
+
<div class="method_details ">
|
|
600
|
+
<h3 class="signature " id="model-instance_method">
|
|
601
|
+
|
|
602
|
+
#<strong>model</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
</h3><div class="docstring">
|
|
609
|
+
<div class="discussion">
|
|
610
|
+
<p>Returns device model name.</p>
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
</div>
|
|
614
|
+
</div>
|
|
615
|
+
<div class="tags">
|
|
616
|
+
|
|
617
|
+
<p class="tag_title">Returns:</p>
|
|
618
|
+
<ul class="return">
|
|
619
|
+
|
|
620
|
+
<li>
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
—
|
|
628
|
+
<div class='inline'><p>device model name</p>
|
|
629
|
+
</div>
|
|
630
|
+
|
|
631
|
+
</li>
|
|
632
|
+
|
|
633
|
+
</ul>
|
|
634
|
+
|
|
635
|
+
</div><table class="source_code">
|
|
636
|
+
<tr>
|
|
637
|
+
<td>
|
|
638
|
+
<pre class="lines">
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
24
|
|
642
|
+
25
|
|
643
|
+
26
|
|
644
|
+
27
|
|
645
|
+
28</pre>
|
|
646
|
+
</td>
|
|
647
|
+
<td>
|
|
648
|
+
<pre class="code"><span class="info file"># File 'lib/midi-communications-macos/entity.rb', line 24</span>
|
|
649
|
+
|
|
650
|
+
<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:endpoints</span><span class='comma'>,</span>
|
|
651
|
+
<span class='symbol'>:manufacturer</span><span class='comma'>,</span>
|
|
652
|
+
<span class='symbol'>:model</span><span class='comma'>,</span>
|
|
653
|
+
<span class='symbol'>:name</span><span class='comma'>,</span>
|
|
654
|
+
<span class='symbol'>:resource</span></pre>
|
|
655
|
+
</td>
|
|
656
|
+
</tr>
|
|
657
|
+
</table>
|
|
658
|
+
</div>
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
<span id=""></span>
|
|
662
|
+
<div class="method_details ">
|
|
663
|
+
<h3 class="signature " id="name-instance_method">
|
|
664
|
+
|
|
665
|
+
#<strong>name</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
</h3><div class="docstring">
|
|
672
|
+
<div class="discussion">
|
|
673
|
+
<p>Returns entity name.</p>
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
</div>
|
|
677
|
+
</div>
|
|
678
|
+
<div class="tags">
|
|
679
|
+
|
|
680
|
+
<p class="tag_title">Returns:</p>
|
|
681
|
+
<ul class="return">
|
|
682
|
+
|
|
683
|
+
<li>
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
—
|
|
691
|
+
<div class='inline'><p>entity name</p>
|
|
692
|
+
</div>
|
|
693
|
+
|
|
694
|
+
</li>
|
|
695
|
+
|
|
696
|
+
</ul>
|
|
697
|
+
|
|
698
|
+
</div><table class="source_code">
|
|
699
|
+
<tr>
|
|
700
|
+
<td>
|
|
701
|
+
<pre class="lines">
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
24
|
|
705
|
+
25
|
|
706
|
+
26
|
|
707
|
+
27
|
|
708
|
+
28</pre>
|
|
709
|
+
</td>
|
|
710
|
+
<td>
|
|
711
|
+
<pre class="code"><span class="info file"># File 'lib/midi-communications-macos/entity.rb', line 24</span>
|
|
712
|
+
|
|
713
|
+
<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:endpoints</span><span class='comma'>,</span>
|
|
714
|
+
<span class='symbol'>:manufacturer</span><span class='comma'>,</span>
|
|
715
|
+
<span class='symbol'>:model</span><span class='comma'>,</span>
|
|
716
|
+
<span class='symbol'>:name</span><span class='comma'>,</span>
|
|
717
|
+
<span class='symbol'>:resource</span></pre>
|
|
718
|
+
</td>
|
|
719
|
+
</tr>
|
|
720
|
+
</table>
|
|
721
|
+
</div>
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
<span id=""></span>
|
|
725
|
+
<div class="method_details ">
|
|
726
|
+
<h3 class="signature " id="resource-instance_method">
|
|
727
|
+
|
|
728
|
+
#<strong>resource</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
</h3><div class="docstring">
|
|
735
|
+
<div class="discussion">
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
</div>
|
|
739
|
+
</div>
|
|
740
|
+
<div class="tags">
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
</div><table class="source_code">
|
|
744
|
+
<tr>
|
|
745
|
+
<td>
|
|
746
|
+
<pre class="lines">
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
24
|
|
750
|
+
25
|
|
751
|
+
26
|
|
752
|
+
27
|
|
753
|
+
28</pre>
|
|
754
|
+
</td>
|
|
755
|
+
<td>
|
|
756
|
+
<pre class="code"><span class="info file"># File 'lib/midi-communications-macos/entity.rb', line 24</span>
|
|
757
|
+
|
|
758
|
+
<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:endpoints</span><span class='comma'>,</span>
|
|
759
|
+
<span class='symbol'>:manufacturer</span><span class='comma'>,</span>
|
|
760
|
+
<span class='symbol'>:model</span><span class='comma'>,</span>
|
|
761
|
+
<span class='symbol'>:name</span><span class='comma'>,</span>
|
|
762
|
+
<span class='symbol'>:resource</span></pre>
|
|
763
|
+
</td>
|
|
764
|
+
</tr>
|
|
765
|
+
</table>
|
|
766
|
+
</div>
|
|
767
|
+
|
|
768
|
+
</div>
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
<div id="instance_method_details" class="method_details_list">
|
|
772
|
+
<h2>Instance Method Details</h2>
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
<div class="method_details first">
|
|
776
|
+
<h3 class="signature first" id="display_name-instance_method">
|
|
777
|
+
|
|
778
|
+
#<strong>display_name</strong> ⇒ <tt>String</tt>
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
</h3><div class="docstring">
|
|
785
|
+
<div class="discussion">
|
|
786
|
+
<p>Construct a display name for the entity</p>
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
</div>
|
|
790
|
+
</div>
|
|
791
|
+
<div class="tags">
|
|
792
|
+
|
|
793
|
+
<p class="tag_title">Returns:</p>
|
|
794
|
+
<ul class="return">
|
|
795
|
+
|
|
796
|
+
<li>
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
</li>
|
|
804
|
+
|
|
805
|
+
</ul>
|
|
806
|
+
|
|
807
|
+
</div><table class="source_code">
|
|
808
|
+
<tr>
|
|
809
|
+
<td>
|
|
810
|
+
<pre class="lines">
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
61
|
|
814
|
+
62
|
|
815
|
+
63</pre>
|
|
816
|
+
</td>
|
|
817
|
+
<td>
|
|
818
|
+
<pre class="code"><span class="info file"># File 'lib/midi-communications-macos/entity.rb', line 61</span>
|
|
819
|
+
|
|
820
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_display_name'>display_name</span>
|
|
821
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@manufacturer</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='ivar'>@model</span><span class='embexpr_end'>}</span><span class='tstring_content'> (</span><span class='embexpr_beg'>#{</span><span class='ivar'>@name</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>"</span></span>
|
|
822
|
+
<span class='kw'>end</span></pre>
|
|
823
|
+
</td>
|
|
824
|
+
</tr>
|
|
825
|
+
</table>
|
|
826
|
+
</div>
|
|
827
|
+
|
|
828
|
+
<div class="method_details ">
|
|
829
|
+
<h3 class="signature " id="online?-instance_method">
|
|
830
|
+
|
|
831
|
+
#<strong>online?</strong> ⇒ <tt>Boolean</tt>
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
</h3><div class="docstring">
|
|
838
|
+
<div class="discussion">
|
|
839
|
+
<p>Is the entity online?</p>
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
</div>
|
|
843
|
+
</div>
|
|
844
|
+
<div class="tags">
|
|
845
|
+
|
|
846
|
+
<p class="tag_title">Returns:</p>
|
|
847
|
+
<ul class="return">
|
|
848
|
+
|
|
849
|
+
<li>
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
</li>
|
|
857
|
+
|
|
858
|
+
</ul>
|
|
859
|
+
|
|
860
|
+
</div><table class="source_code">
|
|
861
|
+
<tr>
|
|
862
|
+
<td>
|
|
863
|
+
<pre class="lines">
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
55
|
|
867
|
+
56
|
|
868
|
+
57</pre>
|
|
869
|
+
</td>
|
|
870
|
+
<td>
|
|
871
|
+
<pre class="code"><span class="info file"># File 'lib/midi-communications-macos/entity.rb', line 55</span>
|
|
872
|
+
|
|
873
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_online?'>online?</span>
|
|
874
|
+
<span class='id identifier rubyid_get_int'>get_int</span><span class='lparen'>(</span><span class='symbol'>:offline</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_zero?'>zero?</span>
|
|
875
|
+
<span class='kw'>end</span></pre>
|
|
876
|
+
</td>
|
|
877
|
+
</tr>
|
|
878
|
+
</table>
|
|
879
|
+
</div>
|
|
880
|
+
|
|
881
|
+
<div class="method_details ">
|
|
882
|
+
<h3 class="signature " id="populate_endpoint_ids-instance_method">
|
|
883
|
+
|
|
884
|
+
#<strong>populate_endpoint_ids</strong>(starting_id) ⇒ <tt>Integer</tt>
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
</h3><div class="docstring">
|
|
891
|
+
<div class="discussion">
|
|
892
|
+
<p>Assign all of this Entity's endpoints an consecutive local id</p>
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
</div>
|
|
896
|
+
</div>
|
|
897
|
+
<div class="tags">
|
|
898
|
+
<p class="tag_title">Parameters:</p>
|
|
899
|
+
<ul class="param">
|
|
900
|
+
|
|
901
|
+
<li>
|
|
902
|
+
|
|
903
|
+
<span class='name'>starting_id</span>
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
</li>
|
|
911
|
+
|
|
912
|
+
</ul>
|
|
913
|
+
|
|
914
|
+
<p class="tag_title">Returns:</p>
|
|
915
|
+
<ul class="return">
|
|
916
|
+
|
|
917
|
+
<li>
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
</li>
|
|
925
|
+
|
|
926
|
+
</ul>
|
|
927
|
+
|
|
928
|
+
</div><table class="source_code">
|
|
929
|
+
<tr>
|
|
930
|
+
<td>
|
|
931
|
+
<pre class="lines">
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
44
|
|
935
|
+
45
|
|
936
|
+
46
|
|
937
|
+
47
|
|
938
|
+
48
|
|
939
|
+
49
|
|
940
|
+
50
|
|
941
|
+
51</pre>
|
|
942
|
+
</td>
|
|
943
|
+
<td>
|
|
944
|
+
<pre class="code"><span class="info file"># File 'lib/midi-communications-macos/entity.rb', line 44</span>
|
|
945
|
+
|
|
946
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_populate_endpoint_ids'>populate_endpoint_ids</span><span class='lparen'>(</span><span class='id identifier rubyid_starting_id'>starting_id</span><span class='rparen'>)</span>
|
|
947
|
+
<span class='id identifier rubyid_counter'>counter</span> <span class='op'>=</span> <span class='int'>0</span>
|
|
948
|
+
<span class='ivar'>@endpoints</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_flatten'>flatten</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_endpoint'>endpoint</span><span class='op'>|</span>
|
|
949
|
+
<span class='id identifier rubyid_endpoint'>endpoint</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='id identifier rubyid_counter'>counter</span> <span class='op'>+</span> <span class='id identifier rubyid_starting_id'>starting_id</span>
|
|
950
|
+
<span class='id identifier rubyid_counter'>counter</span> <span class='op'>+=</span> <span class='int'>1</span>
|
|
951
|
+
<span class='kw'>end</span>
|
|
952
|
+
<span class='id identifier rubyid_counter'>counter</span>
|
|
953
|
+
<span class='kw'>end</span></pre>
|
|
954
|
+
</td>
|
|
955
|
+
</tr>
|
|
956
|
+
</table>
|
|
957
|
+
</div>
|
|
958
|
+
|
|
959
|
+
</div>
|
|
960
|
+
|
|
961
|
+
</div>
|
|
962
|
+
|
|
963
|
+
<div id="footer">
|
|
964
|
+
Generated on Tue Nov 25 11:37:07 2025 by
|
|
965
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
966
|
+
0.9.37 (ruby-3.4.7).
|
|
967
|
+
</div>
|
|
968
|
+
|
|
969
|
+
</div>
|
|
970
|
+
</body>
|
|
971
|
+
</html>
|