SpeakerRecognizer class

Package:

microsoft-cognitiveservices-speech-sdk

Defines SpeakerRecognizer class for Speaker Recognition Handles operations from user for Voice Profile operations (e.g. createProfile, deleteProfile)

Extends

Recognizer

Constructors

SpeakerRecognizer(SpeechConfig, AudioConfig)

Initializes an instance of the SpeakerRecognizer.

Properties

authorizationToken	Gets the authorization token used to communicate with the service.
internalData
properties	The collection of properties and their values defined for this SpeakerRecognizer.
telemetryEnabled	This method returns the current state of the telemetry setting.

Inherited Properties

sessionStarted	Defines event handler for session started events.
sessionStopped	Defines event handler for session stopped events.
speechEndDetected	Defines event handler for speech stopped events.
speechStartDetected	Defines event handler for speech started events.

Methods

close()	Included for compatibility
recognizeOnceAsync(SpeakerIdentificationModel | SpeakerVerificationModel)	Get recognition result for model using given audio

Inherited Methods

enableTelemetry(boolean)

This method globally enables or disables telemetry.

Constructor Details

SpeakerRecognizer(SpeechConfig, AudioConfig)

Initializes an instance of the SpeakerRecognizer.

new SpeakerRecognizer(speechConfig: SpeechConfig, audioConfig: AudioConfig)

Parameters

speechConfig

SpeechConfig

The set of configuration properties.

audioConfig

AudioConfig

An optional audio input config associated with the recognizer

Property Details

authorizationToken

Gets the authorization token used to communicate with the service.

string authorizationToken

Property Value

string

Authorization token.

internalData

object internalData

Property Value

object

properties

The collection of properties and their values defined for this SpeakerRecognizer.

PropertyCollection properties

Property Value

PropertyCollection

The collection of properties and their values defined for this SpeakerRecognizer.

telemetryEnabled

This method returns the current state of the telemetry setting.

static boolean telemetryEnabled

Property Value

boolean

true if the telemetry is enabled, false otherwise.

Inherited Property Details

sessionStarted

Defines event handler for session started events.

public sessionStarted: (sender: Recognizer, event: SessionEventArgs) => void

Property Value

(sender: Recognizer, event: SessionEventArgs) => void

Inherited From Recognizer.sessionStarted

sessionStopped

Defines event handler for session stopped events.

public sessionStopped: (sender: Recognizer, event: SessionEventArgs) => void

Property Value

(sender: Recognizer, event: SessionEventArgs) => void

Inherited From Recognizer.sessionStopped

speechEndDetected

Defines event handler for speech stopped events.

public speechEndDetected: (sender: Recognizer, event: RecognitionEventArgs) => void

Property Value

(sender: Recognizer, event: RecognitionEventArgs) => void

Inherited From Recognizer.speechEndDetected

speechStartDetected

Defines event handler for speech started events.

public speechStartDetected: (sender: Recognizer, event: RecognitionEventArgs) => void

Property Value

(sender: Recognizer, event: RecognitionEventArgs) => void

Inherited From Recognizer.speechStartDetected

Method Details

close()

Included for compatibility

function close(): Promise<void>

Returns

Promise<void>

recognizeOnceAsync(SpeakerIdentificationModel | SpeakerVerificationModel)

Get recognition result for model using given audio

function recognizeOnceAsync(model: SpeakerIdentificationModel | SpeakerVerificationModel): Promise<SpeakerRecognitionResult>

Parameters

model

SpeakerIdentificationModel | SpeakerVerificationModel

Model containing Voice Profiles to be identified

Returns

Promise<SpeakerRecognitionResult>

Inherited Method Details

enableTelemetry(boolean)

This method globally enables or disables telemetry.

static function enableTelemetry(enabled: boolean)

Parameters

enabled

boolean

Global setting for telemetry collection. If set to true, telemetry information like microphone errors, recognition errors are collected and sent to Microsoft. If set to false, no telemetry is sent to Microsoft.

Inherited From Recognizer.enableTelemetry