com.amazonaws.services.transcribe.model

Class Settings

java.lang.Object

com.amazonaws.services.transcribe.model.Settings

All Implemented Interfaces:

Serializable

public class Settings
extends Object
implements Serializable

Provides optional settings for the StartTranscriptionJob operation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Settings()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getChannelIdentification() Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Integer	getMaxSpeakerLabels() The maximum number of speakers to identify in the input audio.
Boolean	getShowSpeakerLabels() Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
String	getVocabularyName() The name of a vocabulary to use when processing the transcription job.
int	hashCode()
Boolean	isChannelIdentification() Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Boolean	isShowSpeakerLabels() Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
void	setChannelIdentification(Boolean channelIdentification) Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
void	setMaxSpeakerLabels(Integer maxSpeakerLabels) The maximum number of speakers to identify in the input audio.
void	setShowSpeakerLabels(Boolean showSpeakerLabels) Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
void	setVocabularyName(String vocabularyName) The name of a vocabulary to use when processing the transcription job.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Settings	withChannelIdentification(Boolean channelIdentification) Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Settings	withMaxSpeakerLabels(Integer maxSpeakerLabels) The maximum number of speakers to identify in the input audio.
Settings	withShowSpeakerLabels(Boolean showSpeakerLabels) Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
Settings	withVocabularyName(String vocabularyName) The name of a vocabulary to use when processing the transcription job.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Settings

public Settings()

Method Detail

getVocabularyName

public String getVocabularyName()

The name of a vocabulary to use when processing the transcription job.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Returns:

The name of a vocabulary to use when processing the transcription job.

setVocabularyName

public void setVocabularyName(String vocabularyName)

The name of a vocabulary to use when processing the transcription job.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

vocabularyName -

The name of a vocabulary to use when processing the transcription job.

withVocabularyName

public Settings withVocabularyName(String vocabularyName)

The name of a vocabulary to use when processing the transcription job.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

vocabularyName -

The name of a vocabulary to use when processing the transcription job.

Returns:

A reference to this updated object so that method calls can be chained together.

isShowSpeakerLabels

public Boolean isShowSpeakerLabels()

Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Returns:

Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .

getShowSpeakerLabels

public Boolean getShowSpeakerLabels()

Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Returns:

Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .

setShowSpeakerLabels

public void setShowSpeakerLabels(Boolean showSpeakerLabels)

Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Parameters:

showSpeakerLabels -

Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

withShowSpeakerLabels

public Settings withShowSpeakerLabels(Boolean showSpeakerLabels)

Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Returns a reference to this object so that method calls can be chained together.

Parameters:

showSpeakerLabels -

Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxSpeakerLabels

public Integer getMaxSpeakerLabels()

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

Constraints:
Range: 2 - 10

Returns:

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

setMaxSpeakerLabels

public void setMaxSpeakerLabels(Integer maxSpeakerLabels)

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

Constraints:
Range: 2 - 10

Parameters:

maxSpeakerLabels -

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

withMaxSpeakerLabels

public Settings withMaxSpeakerLabels(Integer maxSpeakerLabels)

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 2 - 10

Parameters:

maxSpeakerLabels -

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

Returns:

A reference to this updated object so that method calls can be chained together.

isChannelIdentification

public Boolean isChannelIdentification()

Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Returns:

Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .

getChannelIdentification

public Boolean getChannelIdentification()

Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Returns:

Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .

setChannelIdentification

public void setChannelIdentification(Boolean channelIdentification)

Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Parameters:

channelIdentification -

Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

withChannelIdentification

public Settings withChannelIdentification(Boolean channelIdentification)

Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Returns a reference to this object so that method calls can be chained together.

Parameters:

channelIdentification -

Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object