-
Notifications
You must be signed in to change notification settings - Fork 257
/
PushAudioInputStream.xml
241 lines (241 loc) · 13.3 KB
/
PushAudioInputStream.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
<Type Name="PushAudioInputStream" FullName="Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream">
<TypeSignature Language="C#" Value="public sealed class PushAudioInputStream : Microsoft.CognitiveServices.Speech.Audio.AudioInputStream" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit PushAudioInputStream extends Microsoft.CognitiveServices.Speech.Audio.AudioInputStream" />
<TypeSignature Language="DocId" Value="T:Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class PushAudioInputStream
Inherits AudioInputStream" />
<TypeSignature Language="F#" Value="type PushAudioInputStream = class
 inherit AudioInputStream" />
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.16.0.28</AssemblyVersion>
<AssemblyVersion>1.17.0.28</AssemblyVersion>
<AssemblyVersion>1.18.0.28</AssemblyVersion>
<AssemblyVersion>1.19.0.28</AssemblyVersion>
<AssemblyVersion>1.20.0.28</AssemblyVersion>
<AssemblyVersion>1.21.0.28</AssemblyVersion>
<AssemblyVersion>1.22.0.28</AssemblyVersion>
<AssemblyVersion>1.23.0.28</AssemblyVersion>
<AssemblyVersion>1.24.0.28</AssemblyVersion>
<AssemblyVersion>1.24.1.28</AssemblyVersion>
<AssemblyVersion>1.25.1.26</AssemblyVersion>
<AssemblyVersion>1.27.0.28</AssemblyVersion>
<AssemblyVersion>1.28.0.28</AssemblyVersion>
<AssemblyVersion>1.30.0.28</AssemblyVersion>
<AssemblyVersion>1.31.0.28</AssemblyVersion>
<AssemblyVersion>1.32.1.28</AssemblyVersion>
<AssemblyVersion>1.34.0.28</AssemblyVersion>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.CognitiveServices.Speech.Audio.AudioInputStream</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents memory backed push audio input stream used for custom audio input configurations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PushAudioInputStream ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Creates a memory backed PushAudioInputStream using the default format (16 kHz, 16 bit, mono PCM).
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PushAudioInputStream (Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat format);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat format) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream.#ctor(Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (format As AudioStreamFormat)" />
<MemberSignature Language="F#" Value="new Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream : Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat -> Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream" Usage="new Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream format" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="format" Type="Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat" />
</Parameters>
<Docs>
<param name="format">The data format of the audio written to the push audio stream's write() method.</param>
<summary>
Creates a memory backed PushAudioInputStream with the specified audio format.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Close">
<MemberSignature Language="C#" Value="public void Close ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Close() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream.Close" />
<MemberSignature Language="VB.NET" Value="Public Sub Close ()" />
<MemberSignature Language="F#" Value="member this.Close : unit -> unit" Usage="pushAudioInputStream.Close " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Closes the stream.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="override this.Dispose : bool -> unit" Usage="pushAudioInputStream.Dispose disposing" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">Flag to request disposal.</param>
<summary>
This method performs cleanup of resources.
The Boolean parameter <paramref name="disposing" /> indicates whether the method is called from <see cref="M:System.IDisposable.Dispose" /> (if <paramref name="disposing" /> is true) or from the finalizer (if <paramref name="disposing" /> is false).
Derived classes should override this method to dispose resource if needed.
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetProperty">
<MemberSignature Language="C#" Value="public void SetProperty (Microsoft.CognitiveServices.Speech.PropertyId id, string value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetProperty(valuetype Microsoft.CognitiveServices.Speech.PropertyId id, string value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream.SetProperty(Microsoft.CognitiveServices.Speech.PropertyId,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub SetProperty (id As PropertyId, value As String)" />
<MemberSignature Language="F#" Value="member this.SetProperty : Microsoft.CognitiveServices.Speech.PropertyId * string -> unit" Usage="pushAudioInputStream.SetProperty (id, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="Microsoft.CognitiveServices.Speech.PropertyId" />
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="id">A property identifier.</param>
<param name="value">The value of the property.</param>
<summary>
Set value of a property associated to data buffer.
The properties of the audio data must be set before writing the audio data.
Added in 1.5.0
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetProperty">
<MemberSignature Language="C#" Value="public void SetProperty (string name, string value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetProperty(string name, string value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream.SetProperty(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub SetProperty (name As String, value As String)" />
<MemberSignature Language="F#" Value="member this.SetProperty : string * string -> unit" Usage="pushAudioInputStream.SetProperty (name, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The name of the property.</param>
<param name="value">The value of the property.</param>
<summary>
Set value of a property associated to data buffer.
The properties of the audio data mustt be set before writing the audio data.
Added in 1.5.0
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public void Write (byte[] dataBuffer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Write(unsigned int8[] dataBuffer) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream.Write(System.Byte[])" />
<MemberSignature Language="VB.NET" Value="Public Sub Write (dataBuffer As Byte())" />
<MemberSignature Language="F#" Value="member this.Write : byte[] -> unit" Usage="pushAudioInputStream.Write dataBuffer" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataBuffer" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="dataBuffer">The audio buffer this method will copy.</param>
<summary>
Writes the audio data specified by making an internal copy of the data.
Note: The dataBuffer must not contain an audio header.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public void Write (byte[] dataBuffer, int size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Write(unsigned int8[] dataBuffer, int32 size) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream.Write(System.Byte[],System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub Write (dataBuffer As Byte(), size As Integer)" />
<MemberSignature Language="F#" Value="member this.Write : byte[] * int -> unit" Usage="pushAudioInputStream.Write (dataBuffer, size)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataBuffer" Type="System.Byte[]" />
<Parameter Name="size" Type="System.Int32" />
</Parameters>
<Docs>
<param name="dataBuffer">The audio buffer this method will copy.</param>
<param name="size">The size of the data in the audio buffer. Note the size could be smaller than dataBuffer.Length</param>
<summary>
Writes the audio data specified by making an internal copy of the data.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>