-
Notifications
You must be signed in to change notification settings - Fork 43
/
MidiPacket.xml
281 lines (279 loc) · 14 KB
/
MidiPacket.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
<Type Name="MidiPacket" FullName="CoreMidi.MidiPacket">
<TypeSignature Language="C#" Value="public class MidiPacket : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MidiPacket extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:CoreMidi.MidiPacket" />
<TypeSignature Language="F#" Value="type MidiPacket = 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>Encapsulates a series of MIDI events.</summary>
<remarks>
<para>
When you consume a MidiPacket (because some data was received)
you would use the Bytes property to get access to the
underlying Midi data. The actual number of valid bytes is
stored in the Length property and you should not read beyond
that point.
</para>
<para>
When you produce MidiPackets, you can either create MidiPacket
instances by providing both an IntPtr and a Length parameter
to your own buffers, or you can provide a byte array as well
as a range within the array that determines where the Midi
data is stored.
</para>
</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 MidiPacket (long timestamp, byte[] bytes);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int64 timestamp, unsigned int8[] bytes) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiPacket.#ctor(System.Int64,System.Byte[])" />
<MemberSignature Language="F#" Value="new CoreMidi.MidiPacket : int64 * byte[] -> CoreMidi.MidiPacket" Usage="new CoreMidi.MidiPacket (timestamp, bytes)" />
<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="timestamp" Type="System.Int64" />
<Parameter Name="bytes" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="timestamp">Timestamp for the packet.</param>
<param name="bytes">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MidiPacket (long timestamp, ushort length, IntPtr bytes);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int64 timestamp, unsigned int16 length, native int bytes) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiPacket.#ctor(System.Int64,System.UInt16,System.IntPtr)" />
<MemberSignature Language="F#" Value="new CoreMidi.MidiPacket : int64 * uint16 * nativeint -> CoreMidi.MidiPacket" Usage="new CoreMidi.MidiPacket (timestamp, length, bytes)" />
<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="timestamp" Type="System.Int64" />
<Parameter Name="length" Type="System.UInt16" />
<Parameter Name="bytes" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="timestamp">To be added.</param>
<param name="length">To be added.</param>
<param name="bytes">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MidiPacket (long timestamp, byte[] bytes, int start, int len);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int64 timestamp, unsigned int8[] bytes, int32 start, int32 len) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiPacket.#ctor(System.Int64,System.Byte[],System.Int32,System.Int32)" />
<MemberSignature Language="F#" Value="new CoreMidi.MidiPacket : int64 * byte[] * int * int -> CoreMidi.MidiPacket" Usage="new CoreMidi.MidiPacket (timestamp, bytes, start, len)" />
<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="timestamp" Type="System.Int64" />
<Parameter Name="bytes" Type="System.Byte[]" />
<Parameter Name="start" Type="System.Int32" />
<Parameter Name="len" Type="System.Int32" />
</Parameters>
<Docs>
<param name="timestamp">To be added.</param>
<param name="bytes">To be added.</param>
<param name="start">To be added.</param>
<param name="len">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Bytes">
<MemberSignature Language="C#" Value="public IntPtr Bytes { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance native int Bytes" />
<MemberSignature Language="DocId" Value="P:CoreMidi.MidiPacket.Bytes" />
<MemberSignature Language="F#" Value="member this.Bytes : nativeint" Usage="CoreMidi.MidiPacket.Bytes" />
<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.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<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.MidiPacket.Dispose" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="midiPacket.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 MidiPacket object.</summary>
<remarks>
<para>The Dispose method releases the resources used by the MidiPacket class.</para>
<para>Calling the Dispose method when the application is finished using the MidiPacket 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.MidiPacket.Dispose(System.Boolean)" />
<MemberSignature Language="F#" Value="abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit" Usage="midiPacket.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 MidiPacket object.</summary>
<remarks>
<para>This Dispose method releases the resources used by the MidiPacket 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 MidiPacket 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="~MidiPacket ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" />
<MemberSignature Language="DocId" Value="M:CoreMidi.MidiPacket.Finalize" />
<MemberSignature Language="F#" Value="override this.Finalize : unit -> unit" Usage="midiPacket.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 MidiPacket object</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Length">
<MemberSignature Language="C#" Value="public ushort Length;" />
<MemberSignature Language="ILAsm" Value=".field public unsigned int16 Length" />
<MemberSignature Language="DocId" Value="F:CoreMidi.MidiPacket.Length" />
<MemberSignature Language="F#" Value="val mutable Length : uint16" Usage="CoreMidi.MidiPacket.Length" />
<MemberType>Field</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.UInt16</ReturnType>
</ReturnValue>
<Docs>
<summary>The number of bytes in the Bytes array</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="TimeStamp">
<MemberSignature Language="C#" Value="public long TimeStamp;" />
<MemberSignature Language="ILAsm" Value=".field public int64 TimeStamp" />
<MemberSignature Language="DocId" Value="F:CoreMidi.MidiPacket.TimeStamp" />
<MemberSignature Language="F#" Value="val mutable TimeStamp : int64" Usage="CoreMidi.MidiPacket.TimeStamp" />
<MemberType>Field</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.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Time for the event, use zero to mean now.</summary>
<remarks>This is the time used by the host, this is measured using the Unix mach_absolute_time() result value.</remarks>
</Docs>
</Member>
</Members>
</Type>