DataRecognitionClient Class

A client using speech recognition with data (for example from a file or audio source). The data is broken up into buffers and each buffer is sent to the Speech Recognition Service. No modification is done to the buffers, so the user can apply their Silence Detection. Returns only text recognition results. The audio must be PCM, mono, 16-bit sample, with sample rate of 8000 Hz or 16000 Hz.

Inheritance Hierarchy

Object
  Microsoft.CognitiveServices.SpeechRecognitionConversation
    Microsoft.CognitiveServices.SpeechRecognitionDataRecognitionClient
      Microsoft.CognitiveServices.SpeechRecognitionDataRecognitionClientWithIntent

Namespace: Microsoft.CognitiveServices.SpeechRecognition
Assembly: SpeechClient (in SpeechClient.dll) Version: 0.0.0.0

Syntax

Copy

public class DataRecognitionClient : Conversation, 
	IDataRecognitionClient

Public Class DataRecognitionClient
	Inherits Conversation
	Implements IDataRecognitionClient

public ref class DataRecognitionClient : public Conversation, 
	IDataRecognitionClient

type DataRecognitionClient =  
    class
        inherit Conversation
        interface IDataRecognitionClient
    end

The DataRecognitionClient type exposes the following members.

Methods

	Name	Description
	AudioStart	The microphone is turned on and data from the microphone is sent to the Speech Recognition Service. A built in Silence Detector is applied to the microphone data before it is sent to the recognition service. (Inherited from Conversation.)
	AudioStop	The microphone is turned off and the connection to the Speech Recognition Server is severed. (Inherited from Conversation.)
	CreateAudioStream	Gets an audio stream with no format specified. This method is used when the format information can be detected within the stream itself. (Inherited from Conversation.)
	CreateAudioStream(SpeechAudioFormat)	Gets an audio stream with the specified format. Use this method when sending raw audio samples. (Inherited from Conversation.)
	Dispose	(Inherited from Conversation.)
	Dispose(Boolean)	Releases the unmanaged resources used by the DataRecognitionClient and optionally releases the managed resources (Overrides ConversationDispose(Boolean).)
	EndAudio	Notify the server that client is done sending audio buffers to the Speech Recognition Service. This work is queued onto a background worker.
	Equals	(Inherited from Object.)
	Finalize	Should only be called when client is ready to break the connection with the Speech Recognition Server. For example, after the Speech Recognition Server returns the final speech recognition result. (Overrides Object.Finalize.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	SendAudio	Send buffers of audio to the Speech Recognition Service.Note for wave files, you can just send data from the file right to the server. The audio must be PCM, mono, 16-bit sample, with sample rate of 8000 Hz or 16000 Hz. In the case you are not an audio file in wave format, and instead you have just raw data(for example audio coming over bluetooth), then before sending up any audio data with this method, you must first send up an SpeechAudioFormat descriptor to describe the layout and format of your raw audio data via DataRecognitionClient's sendAudioFormat() method. This work is queued onto a background worker.
	SendAudioFormat	If you are not sending up a audio file in wave format, and instead you have just raw data, then before sending up any audio data, you must first send up an SpeechAudioFormat descriptor to describe the layout and format of your raw audio data. The audio must be PCM, mono, 16-bit sample, with sample rate of 8000 Hz or 16000 Hz.
	ToString	(Inherited from Object.)

Top

Properties

	Name	Description
	AuthenticationUri	Represents the authentication service endpoint (Inherited from Conversation.)

Top

Events

	Name	Description
	OnConversationError	Event fired when a conversation error occurs (Inherited from Conversation.)
	OnIntent	Event fired when a Speech Recognition has finished, the recognized text has been parsed with LUIS for intent and entities, and the structured JSON result is available. (Inherited from Conversation.)
	OnMicrophoneStatus	Event fired when the microphone recording status has changed. (Inherited from Conversation.)
	OnPartialResponseReceived	Event fired when a partial response is received (Inherited from Conversation.)
	OnResponseReceived	Event fired when a response is received (Inherited from Conversation.)

Top

Reference

Microsoft.CognitiveServices.SpeechRecognition Namespace