-
Notifications
You must be signed in to change notification settings - Fork 271
/
Copy pathAudioInputStream.xml
227 lines (227 loc) · 14.5 KB
/
AudioInputStream.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
<Type Name="AudioInputStream" FullName="Microsoft.CognitiveServices.Speech.Audio.AudioInputStream">
<TypeSignature Language="C#" Value="public class AudioInputStream : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AudioInputStream extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.CognitiveServices.Speech.Audio.AudioInputStream" />
<TypeSignature Language="VB.NET" Value="Public Class AudioInputStream
Implements IDisposable" />
<TypeSignature Language="F#" Value="type AudioInputStream = class
 interface IDisposable" />
<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>
<AssemblyVersion>1.41.1.28</AssemblyVersion>
<AssemblyVersion>1.42.0.28</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Represents audio input stream used for custom audio input configurations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CreatePullStream">
<MemberSignature Language="C#" Value="public static Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream CreatePullStream (Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback callback);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream CreatePullStream(class Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback callback) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Audio.AudioInputStream.CreatePullStream(Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreatePullStream (callback As PullAudioInputStreamCallback) As PullAudioInputStream" />
<MemberSignature Language="F#" Value="static member CreatePullStream : Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback -> Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream" Usage="Microsoft.CognitiveServices.Speech.Audio.AudioInputStream.CreatePullStream callback" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.42.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback" />
</Parameters>
<Docs>
<param name="callback">The custom audio input object, derived from PullAudioInputStreamCallback</param>
<summary>
Creates a PullAudioInputStream that delegates to the specified callback interface for read() and close() methods, using the default format (16 kHz, 16 bit, mono PCM).
</summary>
<returns>The pull audio input stream being created.</returns>
<remarks>
See also: [About the Speech SDK audio input stream API](/azure/cognitive-services/speech-service/how-to-use-audio-input-streams)
</remarks>
</Docs>
</Member>
<Member MemberName="CreatePullStream">
<MemberSignature Language="C#" Value="public static Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream CreatePullStream (Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback callback, Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat format);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream CreatePullStream(class Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback callback, class Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat format) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Audio.AudioInputStream.CreatePullStream(Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback,Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreatePullStream (callback As PullAudioInputStreamCallback, format As AudioStreamFormat) As PullAudioInputStream" />
<MemberSignature Language="F#" Value="static member CreatePullStream : Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback * Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat -> Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream" Usage="Microsoft.CognitiveServices.Speech.Audio.AudioInputStream.CreatePullStream (callback, format)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.42.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback" />
<Parameter Name="format" Type="Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat" />
</Parameters>
<Docs>
<param name="callback">The custom audio input object, derived from PullAudioInputStreamCallback.</param>
<param name="format">The data format of the audio returned from the callback's read() method.</param>
<summary>
Creates a PullAudioInputStream that delegates to the specified callback interface for read() and close() methods.
</summary>
<returns>The pull audio input stream being created.</returns>
<remarks>
See also: [Asynchronous Conversation Transcription](/azure/cognitive-services/speech-service/how-to-async-conversation-transcription?pivots=programming-language-csharp)
</remarks>
</Docs>
</Member>
<Member MemberName="CreatePushStream">
<MemberSignature Language="C#" Value="public static Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream CreatePushStream ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream CreatePushStream() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Audio.AudioInputStream.CreatePushStream" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreatePushStream () As PushAudioInputStream" />
<MemberSignature Language="F#" Value="static member CreatePushStream : unit -> Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream" Usage="Microsoft.CognitiveServices.Speech.Audio.AudioInputStream.CreatePushStream " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.42.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates a memory backed PushAudioInputStream using the default format (16 kHz, 16 bit, mono PCM).
</summary>
<returns>The push audio input stream being created.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreatePushStream">
<MemberSignature Language="C#" Value="public static Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream CreatePushStream (Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat format);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream CreatePushStream(class Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat format) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Audio.AudioInputStream.CreatePushStream(Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreatePushStream (format As AudioStreamFormat) As PushAudioInputStream" />
<MemberSignature Language="F#" Value="static member CreatePushStream : Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat -> Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream" Usage="Microsoft.CognitiveServices.Speech.Audio.AudioInputStream.CreatePushStream format" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.42.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.Audio.PushAudioInputStream</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat" />
</Parameters>
<Docs>
<param name="format">The data format of the audio to be written to the push audio stream's write() method.</param>
<summary>
Creates a memory backed PushAudioInputStream with the specified audio format.
</summary>
<returns>The push audio input stream being created.</returns>
<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:Microsoft.CognitiveServices.Speech.Audio.AudioInputStream.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="audioInputStream.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.42.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Dispose of associated resources.
</summary>
<remarks>To be added.</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:Microsoft.CognitiveServices.Speech.Audio.AudioInputStream.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit" Usage="audioInputStream.Dispose disposing" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.42.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="isDisposing">
<MemberSignature Language="C#" Value="protected bool isDisposing;" />
<MemberSignature Language="ILAsm" Value=".field family bool isDisposing" />
<MemberSignature Language="DocId" Value="F:Microsoft.CognitiveServices.Speech.Audio.AudioInputStream.isDisposing" />
<MemberSignature Language="VB.NET" Value="Protected isDisposing As Boolean " />
<MemberSignature Language="F#" Value="val mutable isDisposing : bool" Usage="Microsoft.CognitiveServices.Speech.Audio.AudioInputStream.isDisposing" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.42.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates whether the object is currently being disposed.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>