TranscriptionOptions Class

Package:

com.azure.communication.callautomation.models

Maven Artifact:

com.azure:azure-communication-callautomation:1.6.1

• java.lang.Object
• • com.azure.communication.callautomation.models.TranscriptionOptions

public final class TranscriptionOptions

The TranscriptionOptions model.

Constructor Summary

Constructor	Description
TranscriptionOptions(String locale)	Creates a new instance of TranscriptionOptions with default transportType as WEBSOCKET.
TranscriptionOptions(String locale, StreamingTransport transportType)	Creates a new instance of TranscriptionOptions

Method Summary

Modifier and Type	Method and Description
String	getLocale() Get the locale property: locale for the data e.g en-CA, en-AU.
String	getSpeechRecognitionModelEndpointId() Get the speechRecognitionModelEndpointId property: Endpoint where the custom model was deployed.
StreamingTransport	getTransportType() Get the transportType property: The type of transport to be used for live transcription, eg.
String	getTransportUrl() Get the transportUrl property: Transport URL for live transcription.
Boolean	isIntermediateResultsEnabled() Get the enableIntermediateResults property: Enables intermediate results for the transcribed speech.
Boolean	isStartTranscription() Get the startTranscription property: Indicates whether the transcription should start immediately after the call is answered.
TranscriptionOptions	setEnableIntermediateResults(Boolean enableIntermediateResults) Set the enableIntermediateResults property: Enables intermediate results for the transcribed speech.
TranscriptionOptions	setSpeechRecognitionModelEndpointId(String speechRecognitionModelEndpointId) Set the speechRecognitionModelEndpointId property: Endpoint where the custom model was deployed.
TranscriptionOptions	setStartTranscription(Boolean startTranscription) Set the startTranscription property: Indicates whether the transcription should start immediately after the call is answered.
TranscriptionOptions	setTransportUrl(String transportUrl) Set the transportUrl property: Transport URL for live transcription.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TranscriptionOptions

public TranscriptionOptions(String locale)

Creates a new instance of TranscriptionOptions with default transportType as WEBSOCKET.

Parameters:

locale -

• Locale

TranscriptionOptions

public TranscriptionOptions(String locale, StreamingTransport transportType)

Creates a new instance of TranscriptionOptions

Parameters:

locale -

• Locale

transportType -

• The type of transport to be used for live transcription

Method Details

getLocale

public String getLocale()

Get the locale property: locale for the data e.g en-CA, en-AU.

Returns:

the locale value.

getSpeechRecognitionModelEndpointId

public String getSpeechRecognitionModelEndpointId()

Get the speechRecognitionModelEndpointId property: Endpoint where the custom model was deployed.

Returns:

the speechRecognitionModelEndpointId value.

getTransportType

public StreamingTransport getTransportType()

Get the transportType property: The type of transport to be used for live transcription, eg. Websocket.

Returns:

the transportType value.

getTransportUrl

public String getTransportUrl()

Get the transportUrl property: Transport URL for live transcription.

Returns:

the transportUrl value.

isIntermediateResultsEnabled

public Boolean isIntermediateResultsEnabled()

Get the enableIntermediateResults property: Enables intermediate results for the transcribed speech.

Returns:

the enableIntermediateResults value.

isStartTranscription

public Boolean isStartTranscription()

Get the startTranscription property: Indicates whether the transcription should start immediately after the call is answered.

Returns:

the startTranscription value.

setEnableIntermediateResults

public TranscriptionOptions setEnableIntermediateResults(Boolean enableIntermediateResults)

Set the enableIntermediateResults property: Enables intermediate results for the transcribed speech.

Parameters:

enableIntermediateResults - the enableIntermediateResults value to set.

Returns:

the TranscriptionOptions object itself.

setSpeechRecognitionModelEndpointId

public TranscriptionOptions setSpeechRecognitionModelEndpointId(String speechRecognitionModelEndpointId)

Set the speechRecognitionModelEndpointId property: Endpoint where the custom model was deployed.

Parameters:

speechRecognitionModelEndpointId - the speechRecognitionModelEndpointId value to set.

Returns:

the TranscriptionOptions object itself.

setStartTranscription

public TranscriptionOptions setStartTranscription(Boolean startTranscription)

Set the startTranscription property: Indicates whether the transcription should start immediately after the call is answered.

Parameters:

startTranscription - the startTranscription value to set.

Returns:

the TranscriptionOptions object itself.

setTransportUrl

public TranscriptionOptions setTransportUrl(String transportUrl)

Set the transportUrl property: Transport URL for live transcription.

Parameters:

transportUrl - the transportUrl value to set.

Returns:

the TranscriptionOptions object itself.