/
PullAudioInputStream.xml
117 lines (117 loc) · 7.93 KB
/
PullAudioInputStream.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
<Type Name="PullAudioInputStream" FullName="Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream">
<TypeSignature Language="C#" Value="public sealed class PullAudioInputStream : Microsoft.CognitiveServices.Speech.Audio.AudioInputStream" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit PullAudioInputStream extends Microsoft.CognitiveServices.Speech.Audio.AudioInputStream" />
<TypeSignature Language="DocId" Value="T:Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class PullAudioInputStream
Inherits AudioInputStream" />
<TypeSignature Language="F#" Value="type PullAudioInputStream = 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>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.CognitiveServices.Speech.Audio.AudioInputStream</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents audio input stream used for custom audio input configurations.
</summary>
<remarks>
See also: [About the Speech SDK audio input stream API](/azure/cognitive-services/speech-service/how-to-use-audio-input-streams)
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PullAudioInputStream (Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback callback);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback callback) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream.#ctor(Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (callback As PullAudioInputStreamCallback)" />
<MemberSignature Language="F#" Value="new Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream : Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback -> Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream" Usage="new Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream callback" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.34.0.28</AssemblyVersion>
</AssemblyInfo>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PullAudioInputStream (Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback callback, Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat format);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(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.PullAudioInputStream.#ctor(Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback,Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (callback As PullAudioInputStreamCallback, format As AudioStreamFormat)" />
<MemberSignature Language="F#" Value="new Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream : Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStreamCallback * Microsoft.CognitiveServices.Speech.Audio.AudioStreamFormat -> Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream" Usage="new Microsoft.CognitiveServices.Speech.Audio.PullAudioInputStream (callback, format)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.34.0.28</AssemblyVersion>
</AssemblyInfo>
<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>
<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="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.PullAudioInputStream.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="pullAudioInputStream.Dispose disposing" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.34.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>
</Members>
</Type>