xml/Microsoft.CognitiveServices.Speech/Recognizer.xml

<Type Name="Recognizer" FullName="Microsoft.CognitiveServices.Speech.Recognizer"> <TypeSignature Language="C#" Value="public class Recognizer : IDisposable" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Recognizer extends System.Object implements class System.IDisposable" /> <TypeSignature Language="DocId" Value="T:Microsoft.CognitiveServices.Speech.Recognizer" /> <TypeSignature Language="VB.NET" Value="Public Class Recognizer
Implements IDisposable" /> <TypeSignature Language="F#" Value="type Recognizer = 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> <AssemblyVersion>1.43.0.28</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>System.Object</BaseTypeName> </Base> <Interfaces> <Interface> <InterfaceName>System.IDisposable</InterfaceName> </Interface> </Interfaces> <Docs> <summary> Base class that mostly contains common event handlers. </summary> <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName="_tokenCredential"> <MemberSignature Language="C#" Value="protected readonly Azure.Core.TokenCredential _tokenCredential;" /> <MemberSignature Language="ILAsm" Value=".field family initonly class Azure.Core.TokenCredential _tokenCredential" /> <MemberSignature Language="DocId" Value="F:Microsoft.CognitiveServices.Speech.Recognizer._tokenCredential" /> <MemberSignature Language="VB.NET" Value="Protected ReadOnly _tokenCredential As TokenCredential " /> <MemberSignature Language="F#" Value="val mutable _tokenCredential : Azure.Core.TokenCredential" Usage="Microsoft.CognitiveServices.Speech.Recognizer._tokenCredential" /> <MemberType>Field</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.0.28</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Core.TokenCredential</ReturnType> </ReturnValue> <Docs> <summary> AAD token credential. </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:Microsoft.CognitiveServices.Speech.Recognizer.Dispose" /> <MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" /> <MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="recognizer.Dispose " /> <MemberType>Method</MemberType> <Implements> <InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember> </Implements> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.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.Recognizer.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="recognizer.Dispose disposing" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.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="disposed"> <MemberSignature Language="C#" Value="protected bool disposed;" /> <MemberSignature Language="ILAsm" Value=".field family bool disposed" /> <MemberSignature Language="DocId" Value="F:Microsoft.CognitiveServices.Speech.Recognizer.disposed" /> <MemberSignature Language="VB.NET" Value="Protected disposed As Boolean " /> <MemberSignature Language="F#" Value="val mutable disposed : bool" Usage="Microsoft.CognitiveServices.Speech.Recognizer.disposed" /> <MemberType>Field</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.0.28</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> <summary> disposed is a flag used to indicate if object is disposed. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Finalize"> <MemberSignature Language="C#" Value="~Recognizer ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Recognizer.Finalize" /> <MemberSignature Language="VB.NET" Value="Finalize ()" /> <MemberSignature Language="F#" Value="override this.Finalize : unit -> unit" Usage="recognizer.Finalize " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.0.28</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="gch"> <MemberSignature Language="C#" Value="protected System.Runtime.InteropServices.GCHandle gch;" /> <MemberSignature Language="ILAsm" Value=".field family valuetype System.Runtime.InteropServices.GCHandle gch" /> <MemberSignature Language="DocId" Value="F:Microsoft.CognitiveServices.Speech.Recognizer.gch" /> <MemberSignature Language="VB.NET" Value="Protected gch As GCHandle " /> <MemberSignature Language="F#" Value="val mutable gch : System.Runtime.InteropServices.GCHandle" Usage="Microsoft.CognitiveServices.Speech.Recognizer.gch" /> <MemberType>Field</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.0.28</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Runtime.InteropServices.GCHandle</ReturnType> </ReturnValue> <Docs> <summary> GC handle for callbacks for context. </summary> <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.Recognizer.isDisposing" /> <MemberSignature Language="VB.NET" Value="Protected isDisposing As Boolean " /> <MemberSignature Language="F#" Value="val mutable isDisposing : bool" Usage="Microsoft.CognitiveServices.Speech.Recognizer.isDisposing" /> <MemberType>Field</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.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> <Member MemberName="pointerHandle"> <MemberSignature Language="C#" Value="protected readonly string pointerHandle;" /> <MemberSignature Language="ILAsm" Value=".field family initonly string pointerHandle" /> <MemberSignature Language="DocId" Value="F:Microsoft.CognitiveServices.Speech.Recognizer.pointerHandle" /> <MemberSignature Language="VB.NET" Value="Protected ReadOnly pointerHandle As String " /> <MemberSignature Language="F#" Value="val mutable pointerHandle : string" Usage="Microsoft.CognitiveServices.Speech.Recognizer.pointerHandle" /> <MemberType>Field</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.0.28</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary> Internal for logging. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="recognizerLock"> <MemberSignature Language="C#" Value="protected object recognizerLock;" /> <MemberSignature Language="ILAsm" Value=".field family object recognizerLock" /> <MemberSignature Language="DocId" Value="F:Microsoft.CognitiveServices.Speech.Recognizer.recognizerLock" /> <MemberSignature Language="VB.NET" Value="Protected recognizerLock As Object " /> <MemberSignature Language="F#" Value="val mutable recognizerLock : obj" Usage="Microsoft.CognitiveServices.Speech.Recognizer.recognizerLock" /> <MemberType>Field</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.0.28</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> <summary> recognizerLock is used to synchronize access to objects member variables from multiple threads </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="SessionStarted"> <MemberSignature Language="C#" Value="public event EventHandler<Microsoft.CognitiveServices.Speech.SessionEventArgs> SessionStarted;" /> <MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.CognitiveServices.Speech.SessionEventArgs> SessionStarted" /> <MemberSignature Language="DocId" Value="E:Microsoft.CognitiveServices.Speech.Recognizer.SessionStarted" /> <MemberSignature Language="VB.NET" Value="Public Custom Event SessionStarted As EventHandler(Of SessionEventArgs) " /> <MemberSignature Language="F#" Value="member this.SessionStarted : EventHandler<Microsoft.CognitiveServices.Speech.SessionEventArgs> " Usage="member this.SessionStarted : System.EventHandler<Microsoft.CognitiveServices.Speech.SessionEventArgs> " /> <MemberType>Event</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.0.28</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.EventHandler<Microsoft.CognitiveServices.Speech.SessionEventArgs></ReturnType> </ReturnValue> <Docs> <summary> Defines event handler for session started event. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="SessionStopped"> <MemberSignature Language="C#" Value="public event EventHandler<Microsoft.CognitiveServices.Speech.SessionEventArgs> SessionStopped;" /> <MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.CognitiveServices.Speech.SessionEventArgs> SessionStopped" /> <MemberSignature Language="DocId" Value="E:Microsoft.CognitiveServices.Speech.Recognizer.SessionStopped" /> <MemberSignature Language="VB.NET" Value="Public Custom Event SessionStopped As EventHandler(Of SessionEventArgs) " /> <MemberSignature Language="F#" Value="member this.SessionStopped : EventHandler<Microsoft.CognitiveServices.Speech.SessionEventArgs> " Usage="member this.SessionStopped : System.EventHandler<Microsoft.CognitiveServices.Speech.SessionEventArgs> " /> <MemberType>Event</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.0.28</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.EventHandler<Microsoft.CognitiveServices.Speech.SessionEventArgs></ReturnType> </ReturnValue> <Docs> <summary> Defines event handler for session stopped event. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="SetUpTokenRefreshCallback"> <MemberSignature Language="C#" Value="protected void SetUpTokenRefreshCallback (Microsoft.CognitiveServices.Speech.PropertyCollection property);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void SetUpTokenRefreshCallback(class Microsoft.CognitiveServices.Speech.PropertyCollection property) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Recognizer.SetUpTokenRefreshCallback(Microsoft.CognitiveServices.Speech.PropertyCollection)" /> <MemberSignature Language="VB.NET" Value="Protected Sub SetUpTokenRefreshCallback (property As PropertyCollection)" /> <MemberSignature Language="F#" Value="member this.SetUpTokenRefreshCallback : Microsoft.CognitiveServices.Speech.PropertyCollection -> unit" Usage="recognizer.SetUpTokenRefreshCallback property" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.0.28</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="property" Type="Microsoft.CognitiveServices.Speech.PropertyCollection" /> </Parameters> <Docs> <param name="property">property</param> <summary> Set up callback of token refresh event </summary> <returns /> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="SpeechEndDetected"> <MemberSignature Language="C#" Value="public event EventHandler<Microsoft.CognitiveServices.Speech.RecognitionEventArgs> SpeechEndDetected;" /> <MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.CognitiveServices.Speech.RecognitionEventArgs> SpeechEndDetected" /> <MemberSignature Language="DocId" Value="E:Microsoft.CognitiveServices.Speech.Recognizer.SpeechEndDetected" /> <MemberSignature Language="VB.NET" Value="Public Custom Event SpeechEndDetected As EventHandler(Of RecognitionEventArgs) " /> <MemberSignature Language="F#" Value="member this.SpeechEndDetected : EventHandler<Microsoft.CognitiveServices.Speech.RecognitionEventArgs> " Usage="member this.SpeechEndDetected : System.EventHandler<Microsoft.CognitiveServices.Speech.RecognitionEventArgs> " /> <MemberType>Event</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.0.28</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.EventHandler<Microsoft.CognitiveServices.Speech.RecognitionEventArgs></ReturnType> </ReturnValue> <Docs> <summary> Defines event handler for speech end detected event. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="SpeechStartDetected"> <MemberSignature Language="C#" Value="public event EventHandler<Microsoft.CognitiveServices.Speech.RecognitionEventArgs> SpeechStartDetected;" /> <MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.CognitiveServices.Speech.RecognitionEventArgs> SpeechStartDetected" /> <MemberSignature Language="DocId" Value="E:Microsoft.CognitiveServices.Speech.Recognizer.SpeechStartDetected" /> <MemberSignature Language="VB.NET" Value="Public Custom Event SpeechStartDetected As EventHandler(Of RecognitionEventArgs) " /> <MemberSignature Language="F#" Value="member this.SpeechStartDetected : EventHandler<Microsoft.CognitiveServices.Speech.RecognitionEventArgs> " Usage="member this.SpeechStartDetected : System.EventHandler<Microsoft.CognitiveServices.Speech.RecognitionEventArgs> " /> <MemberType>Event</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.0.28</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.EventHandler<Microsoft.CognitiveServices.Speech.RecognitionEventArgs></ReturnType> </ReturnValue> <Docs> <summary> Defines event handler for speech start detected event. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="TokenRequested"> <MemberSignature Language="C#" Value="protected event EventHandler<Microsoft.CognitiveServices.Speech.SessionEventArgs> TokenRequested;" /> <MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.CognitiveServices.Speech.SessionEventArgs> TokenRequested" /> <MemberSignature Language="DocId" Value="E:Microsoft.CognitiveServices.Speech.Recognizer.TokenRequested" /> <MemberSignature Language="VB.NET" Value="Protected Custom Event TokenRequested As EventHandler(Of SessionEventArgs) " /> <MemberSignature Language="F#" Value="member this.TokenRequested : EventHandler<Microsoft.CognitiveServices.Speech.SessionEventArgs> " Usage="member this.TokenRequested : System.EventHandler<Microsoft.CognitiveServices.Speech.SessionEventArgs> " /> <MemberType>Event</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName> <AssemblyVersion>1.43.0.28</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.EventHandler<Microsoft.CognitiveServices.Speech.SessionEventArgs></ReturnType> </ReturnValue> <Docs> <summary> Defines event handler for token request event. </summary> <remarks>To be added.</remarks> </Docs> </Member> </Members> </Type>

xml/Microsoft.CognitiveServices.Speech/Recognizer.xml (377 lines of code) (raw):