Share via

MeetingTranscriber class

  • Reference
Package:
microsoft-cognitiveservices-speech-sdk

Constructors

MeetingTranscriber(AudioConfig)

MeetingTranscriber constructor.

Properties

authorizationToken

Gets the authorization token used to communicate with the service.
canceled

The event canceled signals that an error occurred during transcription.
connection
internalData
MeetingCanceled

The event canceled signals that an error occurred during the meeting.
MeetingStarted

Defines event handler for meeting started events.
meetingStopped

Defines event handler for meeting stopped events.
properties

The collection of properties and their values defined for this MeetingTranscriber.
sessionStarted

Defines event handler for session started events.
sessionStopped

Defines event handler for session stopped events.
speechRecognitionLanguage

Gets the spoken language of recognition.
transcribed

The event recognized signals that a final meeting transcription result is received.
transcribing

The event recognizing signals that an intermediate meeting transcription result is received.

Methods

close(() => void, (error: string) => void)

closes all external resources held by an instance of this class.
dispose(boolean)

Disposes any resources held by the object.
joinMeetingAsync(IMeeting, Callback, Callback)
leaveMeetingAsync(Callback, Callback)

Leave the current meeting. After this is called, you will no longer receive any events.
startTranscribingAsync(Callback, Callback)

Starts meeting transcription, until stopTranscribingAsync() is called. User must subscribe to events to receive transcription results.
stopTranscribingAsync(Callback, Callback)

Starts meeting transcription, until stopTranscribingAsync() is called. User must subscribe to events to receive transcription results.

Constructor Details

MeetingTranscriber(AudioConfig)

MeetingTranscriber constructor.

new MeetingTranscriber(audioConfig?: AudioConfig)

Parameters

audioConfig
AudioConfig

An optional audio configuration associated with the recognizer

Property Details

authorizationToken

Gets the authorization token used to communicate with the service.

string authorizationToken

Property Value

string

Authorization token.

canceled

The event canceled signals that an error occurred during transcription.

public canceled: (sender: MeetingHandler, event: CancellationEventArgs) => void

Property Value

(sender: MeetingHandler, event: CancellationEventArgs) => void

connection 

Connection connection

Property Value

Connection

internalData 

object internalData

Property Value

object

MeetingCanceled

The event canceled signals that an error occurred during the meeting.

public MeetingCanceled: (sender: MeetingHandler, event: CancellationEventArgs) => void

Property Value

(sender: MeetingHandler, event: CancellationEventArgs) => void

MeetingStarted

Defines event handler for meeting started events.

public MeetingStarted: (sender: MeetingHandler, event: SessionEventArgs) => void

Property Value

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

meetingStopped

Defines event handler for meeting stopped events.

public meetingStopped: (sender: MeetingHandler, event: SessionEventArgs) => void

Property Value

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

properties

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

PropertyCollection properties

Property Value

PropertyCollection

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

sessionStarted

Defines event handler for session started events.

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

Property Value

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

sessionStopped

Defines event handler for session stopped events.

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

Property Value

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

speechRecognitionLanguage

Gets the spoken language of recognition.

string speechRecognitionLanguage

Property Value

string

The spoken language of recognition.

transcribed

The event recognized signals that a final meeting transcription result is received.

public transcribed: (sender: MeetingTranscriptionHandler, event: MeetingTranscriptionEventArgs) => void

Property Value

(sender: MeetingTranscriptionHandler, event: MeetingTranscriptionEventArgs) => void

transcribing

The event recognizing signals that an intermediate meeting transcription result is received.

public transcribing: (sender: MeetingTranscriptionHandler, event: MeetingTranscriptionEventArgs) => void

Property Value

(sender: MeetingTranscriptionHandler, event: MeetingTranscriptionEventArgs) => void

Method Details

close(() => void, (error: string) => void)

closes all external resources held by an instance of this class.

function close(cb?: () => void, errorCb?: (error: string) => void)

Parameters

cb

() => void

errorCb

(error: string) => void

dispose(boolean)

Disposes any resources held by the object.

function dispose(disposing: boolean): Promise<void>

Parameters

disposing

boolean

true if disposing the object.

Returns

Promise<void>

joinMeetingAsync(IMeeting, Callback, Callback) 

function joinMeetingAsync(meeting: IMeeting, cb?: Callback, err?: Callback)

Parameters

meeting

IMeeting

meeting to be recognized

cb

Callback

err

Callback

leaveMeetingAsync(Callback, Callback)

Leave the current meeting. After this is called, you will no longer receive any events.

function leaveMeetingAsync(cb?: Callback, err?: Callback)

Parameters

cb

Callback

err

Callback

startTranscribingAsync(Callback, Callback)

Starts meeting transcription, until stopTranscribingAsync() is called. User must subscribe to events to receive transcription results.

function startTranscribingAsync(cb?: Callback, err?: Callback)

Parameters

cb

Callback

Callback invoked once the transcription has started.

err

Callback

Callback invoked in case of an error.

stopTranscribingAsync(Callback, Callback)

Starts meeting transcription, until stopTranscribingAsync() is called. User must subscribe to events to receive transcription results.

function stopTranscribingAsync(cb?: Callback, err?: Callback)

Parameters

cb

Callback

Callback invoked once the transcription has started.

err

Callback

Callback invoked in case of an error.