Class RevAiJobOptions
- java.lang.Object
-
- ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
-
public class RevAiJobOptions extends Object
A RevAiJobOptions object represents parameters that are submitted along a new job.
-
-
Constructor Summary
Constructors Constructor Description RevAiJobOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetCallbackUrl()Returns the callback url.List<CustomVocabulary>getCustomVocabularies()Returns a list ofCustomVocabularyobjects.StringgetMediaUrl()Returns the media url.StringgetMetadata()Returns the metadata.BooleangetSkipDiarization()Returns the value of the skip diarization Boolean.BooleangetSkipPunctuation()Returns the value of the skip punctuation Boolean.IntegergetSpeakerChannelsCount()Returns the speaker channel count.voidsetCallbackUrl(String callbackUrl)Specifies the callback url that Rev.ai will POST to when job processing is complete.voidsetCustomVocabularies(List<CustomVocabulary> customVocabularies)Provides the custom vocabularies to be used by the speech engine when processing the transcript.voidsetMediaUrl(String mediaUrl)Specifies the url where the media can be downloaded.voidsetMetadata(String metadata)Optional metadata that is provided during job submission limited to 512 characters.voidsetSkipDiarization(Boolean skipDiarization)Specifies if speaker diarization will be skipped by the speech engine.voidsetSkipPunctuation(Boolean skipPunctuation)Specifies if the "punct" elements will be skipped by the speech engine.voidsetSpeakerChannelsCount(Integer speakerChannelsCount)Specifies the number of speaker channels in the audio.
-
-
-
Method Detail
-
getMediaUrl
public String getMediaUrl()
Returns the media url.- Returns:
- The media url.
-
setMediaUrl
public void setMediaUrl(String mediaUrl)
Specifies the url where the media can be downloaded.- Parameters:
mediaUrl- The direct download url to the file.
-
getCallbackUrl
public String getCallbackUrl()
Returns the callback url.- Returns:
- the callback url.
-
setCallbackUrl
public void setCallbackUrl(String callbackUrl)
Specifies the callback url that Rev.ai will POST to when job processing is complete. This property is optional.- Parameters:
callbackUrl- The url to POST to when job processing is complete.
-
getSkipDiarization
public Boolean getSkipDiarization()
Returns the value of the skip diarization Boolean.- Returns:
- The skip diarization value.
-
setSkipDiarization
public void setSkipDiarization(Boolean skipDiarization)
Specifies if speaker diarization will be skipped by the speech engine. This property is optional and defaults to false.- Parameters:
skipDiarization- The value of the Boolean.
-
getSkipPunctuation
public Boolean getSkipPunctuation()
Returns the value of the skip punctuation Boolean.- Returns:
- The skip punctuation value.
-
setSkipPunctuation
public void setSkipPunctuation(Boolean skipPunctuation)
Specifies if the "punct" elements will be skipped by the speech engine. This property is optional and defaults to false.- Parameters:
skipPunctuation- The value of the Boolean.
-
getSpeakerChannelsCount
public Integer getSpeakerChannelsCount()
Returns the speaker channel count.- Returns:
- The speaker channel count.
-
setSpeakerChannelsCount
public void setSpeakerChannelsCount(Integer speakerChannelsCount)
Specifies the number of speaker channels in the audio. Each speaker channel is processed separately. When set the account will be charged the file * duration multiplied by the number of specified channels. This property is optional and defaults to null.- Parameters:
speakerChannelsCount- The number of separate speaker channels in the audio.
-
getCustomVocabularies
public List<CustomVocabulary> getCustomVocabularies()
Returns a list ofCustomVocabularyobjects.- Returns:
- A list of
CustomVocabularyobjects. - See Also:
CustomVocabulary
-
setCustomVocabularies
public void setCustomVocabularies(List<CustomVocabulary> customVocabularies)
Provides the custom vocabularies to be used by the speech engine when processing the transcript. List size is limited to 50 items. Providing custom vocabularies is optional.- Parameters:
customVocabularies- A list of custom vocabularies.- See Also:
CustomVocabulary
-
getMetadata
public String getMetadata()
Returns the metadata.- Returns:
- A String that contains the metadata.
-
setMetadata
public void setMetadata(String metadata)
Optional metadata that is provided during job submission limited to 512 characters.- Parameters:
metadata- A String to set as the metadata.
-
-