-
Notifications
You must be signed in to change notification settings - Fork 42
/
MidiObject.xml
359 lines (357 loc) · 17.9 KB
/
MidiObject.xml
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
358
359
<Type Name="MidiObject" FullName="CoreMidi.MidiObject">
<TypeSignature Language="C#" Value="public class MidiObject : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi MidiObject extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:CoreMidi.MidiObject" />
<TypeSignature Language="F#" Value="type MidiObject = class
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Base class for the <see cref="T:CoreMidi.MidiClient" />, <see cref="T:CoreMidi.MidiPort" />, <see cref="T:CoreMidi.MidiEntity" />, <see cref="T:CoreMidi.MidiDevice" /> and <see cref="T:CoreMidi.MidiEndpoint" /> classes.</summary>
<remarks>
Provides the shared properties for the various Midi classes.
</remarks>
<related type="sample" href="https://github.com/xamarin/ios-samples/tree/master/CoreMidiSample/">CoreMidiSample</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MidiObject (int handle);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 handle) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiObject.#ctor(System.Int32)" />
<MemberSignature Language="F#" Value="new CoreMidi.MidiObject : int -> CoreMidi.MidiObject" Usage="new CoreMidi.MidiObject handle" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="handle" Type="System.Int32" />
</Parameters>
<Docs>
<param name="handle">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiObject.Dispose" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="midiObject.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Releases the resources used by the MidiObject object.</summary>
<remarks>
<para>The Dispose method releases the resources used by the MidiObject class.</para>
<para>Calling the Dispose method when the application is finished using the MidiObject ensures that all external resources used by this managed object are released as soon as possible. Once developers have invoked the Dispose method, the object is no longer useful and developers should no longer make any calls to it. For more information on releasing resources see ``Cleaning up Unmananaged Resources'' at https://msdn.microsoft.com/en-us/library/498928w2.aspx</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiObject.Dispose(System.Boolean)" />
<MemberSignature Language="F#" Value="abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit" Usage="midiObject.Dispose disposing" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">
<para>If set to <see langword="true" />, the method is invoked directly and will dispose manage and unmanaged resources; If set to <see langword="false" /> the method is being called by the garbage collector finalizer and should only release unmanaged resources.</para>
</param>
<summary>Releases the resources used by the MidiObject object.</summary>
<remarks>
<para>This Dispose method releases the resources used by the MidiObject class.</para>
<para>This method is called by both the Dispose() method and the object finalizer (Finalize). When invoked by the Dispose method, the parameter disposing <paramref name="disposing" /> is set to <see langword="true" /> and any managed object references that this object holds are also disposed or released; when invoked by the object finalizer, on the finalizer thread the value is set to <see langword="false" />. </para>
<para>Calling the Dispose method when the application is finished using the MidiObject ensures that all external resources used by this managed object are released as soon as possible. Once developers have invoked the Dispose method, the object is no longer useful and developers should no longer make any calls to it.</para>
<para> For more information on how to override this method and on the Dispose/IDisposable pattern, read the ``Implementing a Dispose Method'' document at https://msdn.microsoft.com/en-us/library/fs2xkftw.aspx</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="~MidiObject ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiObject.Finalize" />
<MemberSignature Language="F#" Value="override this.Finalize : unit -> unit" Usage="midiObject.Finalize " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Finalizer for the MidiObject object</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="FindByUniqueId">
<MemberSignature Language="C#" Value="public static CoreMidi.MidiError FindByUniqueId (int uniqueId, out CoreMidi.MidiObject result);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype CoreMidi.MidiError FindByUniqueId(int32 uniqueId, [out] class CoreMidi.MidiObject& result) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiObject.FindByUniqueId(System.Int32,CoreMidi.MidiObject@)" />
<MemberSignature Language="F#" Value="static member FindByUniqueId : int * -> CoreMidi.MidiError" Usage="CoreMidi.MidiObject.FindByUniqueId (uniqueId, result)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>CoreMidi.MidiError</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uniqueId" Type="System.Int32" />
<Parameter Name="result" Type="CoreMidi.MidiObject" RefType="out" />
</Parameters>
<Docs>
<param name="uniqueId">To be added.</param>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetData">
<MemberSignature Language="C#" Value="public Foundation.NSData GetData (IntPtr property);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Foundation.NSData GetData(native int property) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiObject.GetData(System.IntPtr)" />
<MemberSignature Language="F#" Value="member this.GetData : nativeint -> Foundation.NSData" Usage="midiObject.GetData property" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Foundation.NSData</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="property" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="property">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetDictionaryProperties">
<MemberSignature Language="C#" Value="public Foundation.NSDictionary GetDictionaryProperties (bool deep);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Foundation.NSDictionary GetDictionaryProperties(bool deep) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiObject.GetDictionaryProperties(System.Boolean)" />
<MemberSignature Language="F#" Value="member this.GetDictionaryProperties : bool -> Foundation.NSDictionary" Usage="midiObject.GetDictionaryProperties deep" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Foundation.NSDictionary</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="deep" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="deep">Whether this should query properties of nested objects need to be included.</param>
<summary>Returns the object properties as a dictionary.</summary>
<returns>
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetString">
<MemberSignature Language="C#" Value="public string GetString (IntPtr property);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetString(native int property) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiObject.GetString(System.IntPtr)" />
<MemberSignature Language="F#" Value="member this.GetString : nativeint -> string" Usage="midiObject.GetString property" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="property" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="property">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Handle">
<MemberSignature Language="C#" Value="public int Handle { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Handle" />
<MemberSignature Language="DocId" Value="P:CoreMidi.MidiObject.Handle" />
<MemberSignature Language="F#" Value="member this.Handle : int" Usage="CoreMidi.MidiObject.Handle" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Handle (pointer) to the unmanaged object representation.</summary>
<value>A pointer</value>
<remarks>This IntPtr is a handle to the underlying unmanaged representation for this object.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveProperty">
<MemberSignature Language="C#" Value="public CoreMidi.MidiError RemoveProperty (string property);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype CoreMidi.MidiError RemoveProperty(string property) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiObject.RemoveProperty(System.String)" />
<MemberSignature Language="F#" Value="member this.RemoveProperty : string -> CoreMidi.MidiError" Usage="midiObject.RemoveProperty property" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>CoreMidi.MidiError</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="property" Type="System.String" />
</Parameters>
<Docs>
<param name="property">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetData">
<MemberSignature Language="C#" Value="public void SetData (IntPtr property, Foundation.NSData data);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetData(native int property, class Foundation.NSData data) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiObject.SetData(System.IntPtr,Foundation.NSData)" />
<MemberSignature Language="F#" Value="member this.SetData : nativeint * Foundation.NSData -> unit" Usage="midiObject.SetData (property, data)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="property" Type="System.IntPtr" />
<Parameter Name="data" Type="Foundation.NSData" />
</Parameters>
<Docs>
<param name="property">To be added.</param>
<param name="data">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetString">
<MemberSignature Language="C#" Value="public void SetString (IntPtr property, string value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetString(native int property, string value) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiObject.SetString(System.IntPtr,System.String)" />
<MemberSignature Language="F#" Value="member this.SetString : nativeint * string -> unit" Usage="midiObject.SetString (property, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="property" Type="System.IntPtr" />
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="property">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>