Index (Rev.ai speech to text SDK for Java 1.0.0 API)

A B C D E F G H I M O P R S T V
All Classes All Packages

A

ai.rev.speechtotext - package ai.rev.speechtotext
ai.rev.speechtotext.exceptions - package ai.rev.speechtotext.exceptions
ai.rev.speechtotext.helpers - package ai.rev.speechtotext.helpers
ai.rev.speechtotext.models - package ai.rev.speechtotext.models
ai.rev.speechtotext.models.asynchronous - package ai.rev.speechtotext.models.asynchronous
ai.rev.speechtotext.models.streaming - package ai.rev.speechtotext.models.streaming
ApiClient - Class in ai.rev.speechtotext: The ApiClient object provides methods to send and retrieve information from all the Rev.AI API endpoints using the Retrofit HTTP client.
ApiClient(String) - Constructor for class ai.rev.speechtotext.ApiClient: Constructs the API client used to send HTTP requests to Rev.ai.
ApiInterceptor - Class in ai.rev.speechtotext: An ApiInterceptor object appends authorization information to all API calls and is used to check the status of the request for debugging purposes.
ApiInterceptor(String, String) - Constructor for class ai.rev.speechtotext.ApiInterceptor
apiInterface - Variable in class ai.rev.speechtotext.ApiClient: Interface that ApiClient methods use to make requests
ApiInterface - Interface in ai.rev.speechtotext: The ApiInterface is a type-safe Retrofit interface that presents all the endpoints that are made to communicate with the Rev.AI API.
ASYNC - ai.rev.speechtotext.models.asynchronous.RevAiJobType: The type used for asynchronous jobs.
AuthorizationException - Exception in ai.rev.speechtotext.exceptions: The AuthorizationException happens when an invalid token access is used to query the account information endpoint.
AuthorizationException(JSONObject) - Constructor for exception ai.rev.speechtotext.exceptions.AuthorizationException

B

buildContentString() - Method in class ai.rev.speechtotext.StreamContentType: Returns the content string compiled from the StreamContentType properties to be used in the query parameter for the request to the /stream endpoint.

C

close() - Method in class ai.rev.speechtotext.StreamingClient: Will close the WebSocket connection by informing the server that it's the End of Stream
closeConnection() - Method in class ai.rev.speechtotext.ApiClient: Manually closes the connection when the code is running in a JVM
connect(RevAiWebSocketListener, StreamContentType) - Method in class ai.rev.speechtotext.StreamingClient: Overload of StreamingClient.connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig) without the optional metadata and sessionConfig.
connect(RevAiWebSocketListener, StreamContentType, SessionConfig) - Method in class ai.rev.speechtotext.StreamingClient: Overload of StreamingClient.connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig) without the optional metadata.
connect(RevAiWebSocketListener, StreamContentType, String) - Method in class ai.rev.speechtotext.StreamingClient: Overload of StreamingClient.connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig) without the optional sessionConfig.
connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig) - Method in class ai.rev.speechtotext.StreamingClient: Sends an HTTP request and upon authorization is upgraded to a WebSocket connection.
CONNECTED - ai.rev.speechtotext.models.streaming.MessageType: The type of message sent when the WebSocket connects.
ConnectedMessage - Class in ai.rev.speechtotext.models.streaming: Represents the connected message sent from Rev.ai and contains the id of the stream
ConnectedMessage() - Constructor for class ai.rev.speechtotext.models.streaming.ConnectedMessage
create(InputStream, MediaType) - Static method in class ai.rev.speechtotext.FileStreamRequestBody
CustomVocabulary - Class in ai.rev.speechtotext.models: A CustomVocabulary object provides all the custom phrases that are submitted along with a job.
CustomVocabulary(List<String>) - Constructor for class ai.rev.speechtotext.models.CustomVocabulary: Creates a new custom vocabulary with a list of phrases limited to alphabetic characters and spaces.

D

deleteJob(String) - Method in class ai.rev.speechtotext.ApiClient: This method sends a DELETE request to the /jobs/{id} endpoint.
deleteJob(String) - Method in interface ai.rev.speechtotext.ApiInterface
DOWNLOAD_FAILURE - ai.rev.speechtotext.models.asynchronous.RevAiFailureType: The failure used when the media provided in the submission request fails to download.

E

Element - Class in ai.rev.speechtotext.models.asynchronous: An Element object presents all the information the models inferred from a single interval of audio.
Element() - Constructor for class ai.rev.speechtotext.models.asynchronous.Element
EMPTY_MEDIA - ai.rev.speechtotext.models.asynchronous.RevAiFailureType: The failure used when the media provided doesn't contain any audio.
ErrorInterceptor - Class in ai.rev.speechtotext: The ErrorInterceptor class is used to intercept all responses with erroneous response codes.
ErrorInterceptor() - Constructor for class ai.rev.speechtotext.ErrorInterceptor

F

FAILED - ai.rev.speechtotext.models.asynchronous.RevAiJobStatus: The status when transcription has failed.
FileStreamRequestBody - Class in ai.rev.speechtotext: Customized request body used for submitting local file jobs.
FileStreamRequestBody() - Constructor for class ai.rev.speechtotext.FileStreamRequestBody
FINAL - ai.rev.speechtotext.models.streaming.MessageType: The type of message sent when the WebSocket returns a final hypotheses.
ForbiddenStateException - Exception in ai.rev.speechtotext.exceptions: The ForbiddenStateException occurs when a user attempts to retrieve the transcript or caption of a unprocessed job.
ForbiddenStateException(JSONObject) - Constructor for exception ai.rev.speechtotext.exceptions.ForbiddenStateException

G

getAccount() - Method in class ai.rev.speechtotext.ApiClient: This method sends a GET request to the /account endpoint and returns an RevAiAccount object.
getAccount() - Method in interface ai.rev.speechtotext.ApiInterface
getBalanceSeconds() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiAccount: Returns the remaining number of credits in seconds that can be used on the account.
getCallbackUrl() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Returns the callback url provided in the submission request.
getCallbackUrl() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Returns the callback url.
getCaptions(String) - Method in class ai.rev.speechtotext.ApiClient: An overload of ApiClient.getCaptions(String, RevAiCaptionType, Integer) without the optional caption type and channel ID.
getCaptions(String, RevAiCaptionType) - Method in class ai.rev.speechtotext.ApiClient: An overload of ApiClient.getCaptions(String, RevAiCaptionType, Integer) without the optional channel ID.
getCaptions(String, RevAiCaptionType, Integer) - Method in class ai.rev.speechtotext.ApiClient: The method sends a GET request to the /jobs/{id}/captions endpoint and returns captions for the provided job ID in the form of an InputStream.
getCaptions(String, Integer) - Method in class ai.rev.speechtotext.ApiClient: An overload of ApiClient.getCaptions(String, RevAiCaptionType, Integer) without the optional caption type.
getCaptionText(String, Map<String, String>, Map<String, String>) - Method in interface ai.rev.speechtotext.ApiInterface
getChannels() - Method in class ai.rev.speechtotext.StreamContentType: Returns the number of channels.
getCompletedOn() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Returns a String that contains the date and time the job was completed on in ISO-8601 UTC form.
getConfidence() - Method in class ai.rev.speechtotext.models.asynchronous.Element: Returns the confidence score of the value provided in this transcript element.
getContentType() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiCaptionType: Returns the String value of the enumeration.
getContentType() - Method in class ai.rev.speechtotext.StreamContentType: Returns the content type.
getCreatedOn() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Returns a String that contains the date and time the job was created on in ISO-8601 UTC form.
getCustomVocabularies() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Returns a list of CustomVocabulary objects.
getCustomVocabularyId() - Method in class ai.rev.speechtotext.SessionConfig: Returns the custom vocabulary ID.
getDurationSeconds() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Returns the audio duration of the file in seconds.
getElements() - Method in class ai.rev.speechtotext.models.asynchronous.Monologue: Returns a list of Element objects.
getElements() - Method in class ai.rev.speechtotext.models.streaming.Hypothesis: Returns a list of Element objects.
getEmail() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiAccount: Returns a String containing the account email.
getEndTimestamp() - Method in class ai.rev.speechtotext.models.asynchronous.Element: Returns the end timestamp for this audio interval.
getEndTs() - Method in class ai.rev.speechtotext.models.streaming.Hypothesis: Returns the ending timestamp of a transcribed audio sample.
getFailure() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Returns the RevAiFailureType enumeration value.
getFailureDetails() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Returns a detailed, human readable explanation of the failure.
getFailureType() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiFailureType: Returns the String value of the enumeration.
getFilterProfanity() - Method in class ai.rev.speechtotext.SessionConfig: Returns the value of the filter profanity option.
getFormat() - Method in class ai.rev.speechtotext.StreamContentType: Returns the format of the audio samples.
getId() - Method in class ai.rev.speechtotext.models.streaming.ConnectedMessage
getJobDetails(String) - Method in class ai.rev.speechtotext.ApiClient: This method sends a GET request to the /jobs/{id} endpoint and returns a RevAiJob object.
getJobDetails(String) - Method in interface ai.rev.speechtotext.ApiInterface
getJobId() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Returns a String that contains the job ID.
getJobStatus() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Returns the RevAiJobStatus enumeration value.
getJobType() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobType: Returns the String value of the enumeration.
getLayout() - Method in class ai.rev.speechtotext.StreamContentType: Returns the channel layout.
getListOfJobs() - Method in class ai.rev.speechtotext.ApiClient: Overload of ApiClient.getListOfJobs(Integer, String) without the optional limit and startingAfter parameter.
getListOfJobs(Integer) - Method in class ai.rev.speechtotext.ApiClient: Overload of ApiClient.getListOfJobs(Integer, String) without the optional startingAfter parameter.
getListOfJobs(Integer, String) - Method in class ai.rev.speechtotext.ApiClient: This method sends a GET request to the /jobs endpoint and returns a list of RevAiJob objects.
getListOfJobs(String) - Method in class ai.rev.speechtotext.ApiClient: Overload of ApiClient.getListOfJobs(Integer, String) without the optional limit parameter.
getListOfJobs(Map<String, String>) - Method in interface ai.rev.speechtotext.ApiInterface
getMediaType() - Method in class ai.rev.speechtotext.MockInterceptor
getMediaUrl() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Returns the media url provided in the submission request.
getMediaUrl() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Returns the media url.
getMessageType() - Method in enum ai.rev.speechtotext.models.streaming.MessageType: Returns the String value of the enumeration.
getMetadata() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Returns the metadata provided in the submission request.
getMetadata() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Returns the metadata.
getMetaData() - Method in class ai.rev.speechtotext.SessionConfig: Returns the metadata.
getMonologues() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiTranscript: Returns a list on Monologue objects.
getName() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Returns the name of the file provided in the submission request.
getPhrases() - Method in class ai.rev.speechtotext.models.CustomVocabulary: Returns a list of phrases
getRate() - Method in class ai.rev.speechtotext.StreamContentType: Returns the audio sample rate.
getRequest() - Method in class ai.rev.speechtotext.MockInterceptor
getResponseCode() - Method in class ai.rev.speechtotext.MockInterceptor
getSampleResponse() - Method in class ai.rev.speechtotext.MockInterceptor
getSdkVersion() - Static method in class ai.rev.speechtotext.helpers.SDKHelper: Helper function that reads the current sdk version from pom.xml.
getSkipDiarization() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Returns the value of the skip diarization Boolean.
getSkipPunctuation() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Returns the value of the skip punctuation Boolean.
getSpeaker() - Method in class ai.rev.speechtotext.models.asynchronous.Monologue: Returns the speaker number for this monologue.
getSpeakerChannelsCount() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Returns the speaker channel count.
getStartTimestamp() - Method in class ai.rev.speechtotext.models.asynchronous.Element: Returns the starting timestamp of this audio interval.
getStatus() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobStatus: Returns the String value of the enumeration.
getTranscriptObject(String) - Method in class ai.rev.speechtotext.ApiClient: The method sends a GET request to the /jobs/{id}/transcript endpoint and returns a RevAiTranscript object.
getTranscriptObject(String) - Method in interface ai.rev.speechtotext.ApiInterface
getTranscriptText(String) - Method in class ai.rev.speechtotext.ApiClient: The method sends a GET request to the /jobs/{id}/transcript endpoint and returns the transcript as a String.
getTranscriptText(String) - Method in interface ai.rev.speechtotext.ApiInterface
getTs() - Method in class ai.rev.speechtotext.models.streaming.Hypothesis: Returns the starting timestamp of a transcribed audio sample.
getType() - Method in class ai.rev.speechtotext.models.asynchronous.Element: Returns the type of transcript element contained within this audio interval.
getType() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Returns the RevAiJobType enumeration value.
getType() - Method in class ai.rev.speechtotext.models.streaming.StreamingResponseMessage: Returns the MessageType enumeration value.
getValue() - Method in class ai.rev.speechtotext.models.asynchronous.Element: Returns the value of the transcript element.

H

Hypothesis - Class in ai.rev.speechtotext.models.streaming: Represents the message returned over WebSocket containing the transcription of audio data.
Hypothesis() - Constructor for class ai.rev.speechtotext.models.streaming.Hypothesis

I

IN_PROGRESS - ai.rev.speechtotext.models.asynchronous.RevAiJobStatus: The status when transcription of the file is in progress.
INSUFFICIENT_BALANCE - ai.rev.speechtotext.models.asynchronous.RevAiFailureType: The failure used when the account does not have enough credits remaining.
intercept(Interceptor.Chain) - Method in class ai.rev.speechtotext.ApiInterceptor
intercept(Interceptor.Chain) - Method in class ai.rev.speechtotext.ErrorInterceptor
intercept(Interceptor.Chain) - Method in class ai.rev.speechtotext.MockInterceptor
INTERNAL_PROCESSING - ai.rev.speechtotext.models.asynchronous.RevAiFailureType: The failure used when there is a processing error.
INVALID_MEDIA - ai.rev.speechtotext.models.asynchronous.RevAiFailureType: The failure used when the file submitted is not a valid or supported media file.
InvalidHeaderException - Exception in ai.rev.speechtotext.exceptions: The InvalidHeaderException occurs when a header that's passed along a query is not recognized by the API.
InvalidHeaderException(JSONObject) - Constructor for exception ai.rev.speechtotext.exceptions.InvalidHeaderException
InvalidParameterException - Exception in ai.rev.speechtotext.exceptions: The InvalidParameterException occurs when a parameter that's passed along a query is not recognized by the API.
InvalidParameterException(JSONObject) - Constructor for exception ai.rev.speechtotext.exceptions.InvalidParameterException
INVOICING_LIMIT_EXCEEDED - ai.rev.speechtotext.models.asynchronous.RevAiFailureType: The failure used when the account has reached or exceeded its invoicing limit.

M

MessageType - Enum in ai.rev.speechtotext.models.streaming: Specifies constants that define the WebSocket message type.
MockInterceptor - Class in ai.rev.speechtotext: A MockInterceptor object is used to mock the responses for testing purposes.
MockInterceptor(MediaType, Integer) - Constructor for class ai.rev.speechtotext.MockInterceptor
Monologue - Class in ai.rev.speechtotext.models.asynchronous: A Monologue object presents information about a segment of a transcript owned by an individual speaker.
Monologue() - Constructor for class ai.rev.speechtotext.models.asynchronous.Monologue

O

onClose(int, String) - Method in interface ai.rev.speechtotext.RevAiWebSocketListener: Supplies the close code and close reason received during a WebSocket CloseEvent.
onConnected(ConnectedMessage) - Method in interface ai.rev.speechtotext.RevAiWebSocketListener: Supplies the connection message received from Rev.ai.
onError(Throwable, Response) - Method in interface ai.rev.speechtotext.RevAiWebSocketListener: Supplies the error and response received during a WebSocket ErrorEvent.
onHypothesis(Hypothesis) - Method in interface ai.rev.speechtotext.RevAiWebSocketListener: Supplies the Hypothesis returned from Rev.ai.
onOpen(Response) - Method in interface ai.rev.speechtotext.RevAiWebSocketListener: Supplies the response received during the handshake.

P

PARTIAL - ai.rev.speechtotext.models.streaming.MessageType: The type of message sent when the WebSocket returns a partial hypotheses.

R

request - Variable in class ai.rev.speechtotext.MockInterceptor
ResourceNotFoundException - Exception in ai.rev.speechtotext.exceptions: The ResourceNotFoundException occurs when a job ID queried is not associated with a job submitted by the user.
ResourceNotFoundException(JSONObject) - Constructor for exception ai.rev.speechtotext.exceptions.ResourceNotFoundException
REV_JSON_CONTENT_TYPE - Static variable in interface ai.rev.speechtotext.ApiInterface
REV_TEXT_CONTENT_TYPE - Static variable in interface ai.rev.speechtotext.ApiInterface
RevAiAccount - Class in ai.rev.speechtotext.models.asynchronous: The RevAiAccount object provides basic information about a Rev.ai account associated with a valid access token.
RevAiAccount() - Constructor for class ai.rev.speechtotext.models.asynchronous.RevAiAccount
RevAiApiException - Exception in ai.rev.speechtotext.exceptions: The RevAiApiException wraps standard Java IOException and enriches them with custom information.
RevAiApiException(String, JSONObject, int) - Constructor for exception ai.rev.speechtotext.exceptions.RevAiApiException
RevAiCaptionType - Enum in ai.rev.speechtotext.models.asynchronous: Specifies constants that define support caption formats.
RevAiFailureType - Enum in ai.rev.speechtotext.models.asynchronous: Specifies constants that define Rev.ai failure types.
RevAiJob - Class in ai.rev.speechtotext.models.asynchronous: A RevAi Job object provides all the information associated with a job submitted by the user.
RevAiJob() - Constructor for class ai.rev.speechtotext.models.asynchronous.RevAiJob
RevAiJobOptions - Class in ai.rev.speechtotext.models.asynchronous: A RevAiJobOptions object represents parameters that are submitted along a new job.
RevAiJobOptions() - Constructor for class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
RevAiJobStatus - Enum in ai.rev.speechtotext.models.asynchronous: Specifies constants that define Rev.ai job statuses.
RevAiJobType - Enum in ai.rev.speechtotext.models.asynchronous: Specifies constants that define Rev.ai job types.
RevAiTranscript - Class in ai.rev.speechtotext.models.asynchronous: A RevAiTranscript object presents a list of monologues as the transcript of a specific job.
RevAiTranscript() - Constructor for class ai.rev.speechtotext.models.asynchronous.RevAiTranscript
RevAiWebSocketListener - Interface in ai.rev.speechtotext: Listens for events over the WebSocket connection to Rev.ai

S

SDKHelper - Class in ai.rev.speechtotext.helpers: A helper class that provides methods for getting SDK information.
SDKHelper() - Constructor for class ai.rev.speechtotext.helpers.SDKHelper
sendAudioData(ByteString) - Method in class ai.rev.speechtotext.StreamingClient: Sends data over WebSocket in the form of a ByteString
SessionConfig - Class in ai.rev.speechtotext: The SessionConfig represents additional streaming options that can be provided.
SessionConfig() - Constructor for class ai.rev.speechtotext.SessionConfig
setBalanceSeconds(Integer) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiAccount: Sets the balanceSeconds value.
setCallbackUrl(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Sets the callback url.
setCallbackUrl(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Specifies the callback url that Rev.ai will POST to when job processing is complete.
setChannels(Integer) - Method in class ai.rev.speechtotext.StreamContentType: Specifies the number of audio channels that the audio samples contain.
setCompletedOn(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Set the date and time the job was completed on.
setConfidence(Double) - Method in class ai.rev.speechtotext.models.asynchronous.Element: Sets the confidence score to the Double provided.
setContentType(String) - Method in class ai.rev.speechtotext.StreamContentType: Specifies the content type of the audio.
setCreatedOn(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Sets the time and date the job was created on.
setCustomVocabularies(List<CustomVocabulary>) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Provides the custom vocabularies to be used by the speech engine when processing the transcript.
setCustomVocabularyId(String) - Method in class ai.rev.speechtotext.SessionConfig: Specifies the ID of the custom vocabulary the speech engine should use while processing audio samples.
setDurationSeconds(Double) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Sets the audio duration.
setElements(Element[]) - Method in class ai.rev.speechtotext.models.streaming.Hypothesis: Sets elements to the list of Element objects provided.
setElements(List<Element>) - Method in class ai.rev.speechtotext.models.asynchronous.Monologue: Sets elements to the list of Element objects provided.
setEmail(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiAccount: Sets the email value.
setEndTimestamp(Double) - Method in class ai.rev.speechtotext.models.asynchronous.Element: Sets the end timestamp for this audio interval.
setEndTs(Double) - Method in class ai.rev.speechtotext.models.streaming.Hypothesis: Sets the ending timestamp.
setFailure(RevAiFailureType) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Sets the failure to the provided RevAiFailureType enumeration.
setFailureDetails(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Sets the failure details to the provided value.
setFilterProfanity(Boolean) - Method in class ai.rev.speechtotext.SessionConfig: Specifies whether or not the speech engine should filter profanity in the output.
setFormat(String) - Method in class ai.rev.speechtotext.StreamContentType: Specifies the format of the audio samples.
setHost(String) - Method in class ai.rev.speechtotext.StreamingClient: This methods sets the URL host name.
setId(String) - Method in class ai.rev.speechtotext.models.streaming.ConnectedMessage
setJobId(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Sets the Job ID.
setJobStatus(RevAiJobStatus) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Sets the job status to the provided RevAiJobStatus enumeration value.
setLayout(String) - Method in class ai.rev.speechtotext.StreamContentType: Specifies the layout of channels within the buffer.
setMediaType(MediaType) - Method in class ai.rev.speechtotext.MockInterceptor
setMediaUrl(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Sets the media url.
setMediaUrl(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Specifies the url where the media can be downloaded.
setMetadata(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Sets the metadata.
setMetadata(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Optional metadata that is provided during job submission limited to 512 characters.
setMetaData(String) - Method in class ai.rev.speechtotext.SessionConfig: Specifies the metadata to be used in the submission request to /jobs.
setMonologues(List<Monologue>) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiTranscript: Sets the monologues to the list of monologues provided.
setName(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Sets the file name.
setPhrases(List<String>) - Method in class ai.rev.speechtotext.models.CustomVocabulary: Sets the list of phrases to be used in the custom vocabulary.
setPort(int) - Method in class ai.rev.speechtotext.StreamingClient: This method sets a port number to be used in the WebSocket connect request.
setRate(Integer) - Method in class ai.rev.speechtotext.StreamContentType: Specifies the sample rate of the audio.
setRequest(Request) - Method in class ai.rev.speechtotext.MockInterceptor
setResponseCode(Integer) - Method in class ai.rev.speechtotext.MockInterceptor
setSampleResponse(String) - Method in class ai.rev.speechtotext.MockInterceptor
setScheme(String) - Method in class ai.rev.speechtotext.StreamingClient: This method sets the URL scheme to be used in the WebSocket connect request
setSkipDiarization(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Specifies if speaker diarization will be skipped by the speech engine.
setSkipPunctuation(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Specifies if the "punct" elements will be skipped by the speech engine.
setSpeaker(Integer) - Method in class ai.rev.speechtotext.models.asynchronous.Monologue: Sets the speaker number for this monologue.
setSpeakerChannelsCount(Integer) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions: Specifies the number of speaker channels in the audio.
setStartTimestamp(Double) - Method in class ai.rev.speechtotext.models.asynchronous.Element: Sets the starting timestamp for this audio interval.
setTs(Double) - Method in class ai.rev.speechtotext.models.streaming.Hypothesis: Sets the starting timestamp.
setType(RevAiJobType) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob: Sets the job type to the provided RevAiJobType enumeration.
setType(MessageType) - Method in class ai.rev.speechtotext.models.streaming.StreamingResponseMessage: Specifies the WebSocket message type.
setType(String) - Method in class ai.rev.speechtotext.models.asynchronous.Element: Sets the type to the String provided
setValue(String) - Method in class ai.rev.speechtotext.models.asynchronous.Element: Sets the value of the transcript element to the String provided.
SRT - ai.rev.speechtotext.models.asynchronous.RevAiCaptionType: The SubRip caption file format.
STREAM - ai.rev.speechtotext.models.asynchronous.RevAiJobType: The type used for streaming jobs.
StreamContentType - Class in ai.rev.speechtotext: The StreamContentType describes the format of the audio being sent over the WebSocket.
StreamContentType() - Constructor for class ai.rev.speechtotext.StreamContentType
StreamingClient - Class in ai.rev.speechtotext
StreamingClient(String) - Constructor for class ai.rev.speechtotext.StreamingClient: Constructs the streaming client that is used to establish a WebSocket connection with the Rev.ai server and stream audio data.
StreamingResponseMessage - Class in ai.rev.speechtotext.models.streaming: A parent class that can be used to serialize and deserialize the "type" in the WebSocket messages.
StreamingResponseMessage() - Constructor for class ai.rev.speechtotext.models.streaming.StreamingResponseMessage
submitJobLocalFile(InputStream) - Method in class ai.rev.speechtotext.ApiClient: An overload of ApiClient.submitJobLocalFile(InputStream, String, RevAiJobOptions) without the optional filename and transcription options.
submitJobLocalFile(InputStream, RevAiJobOptions) - Method in class ai.rev.speechtotext.ApiClient: An overload of ApiClient.submitJobLocalFile(InputStream, String, RevAiJobOptions) without the optional filename.
submitJobLocalFile(InputStream, String) - Method in class ai.rev.speechtotext.ApiClient: An overload of ApiClient.submitJobLocalFile(InputStream, String, RevAiJobOptions) without the additional transcription options.
submitJobLocalFile(InputStream, String, RevAiJobOptions) - Method in class ai.rev.speechtotext.ApiClient: The method sends a POST request to the /jobs endpoint, starts an asynchronous job to transcribe the media file provided by InputStream and returns a RevAiJob object.
submitJobLocalFile(String) - Method in class ai.rev.speechtotext.ApiClient: An overload of ApiClient.submitJobLocalFile(String, RevAiJobOptions) without the additional transcription options.
submitJobLocalFile(String, RevAiJobOptions) - Method in class ai.rev.speechtotext.ApiClient: The method sends multipart/form request to the /jobs endpoint, starts an asynchronous job to transcribe the local media file provided and returns a RevAiJob object.
submitJobLocalFile(MultipartBody.Part, RevAiJobOptions) - Method in interface ai.rev.speechtotext.ApiInterface
submitJobUrl(RevAiJobOptions) - Method in interface ai.rev.speechtotext.ApiInterface
submitJobUrl(String) - Method in class ai.rev.speechtotext.ApiClient: An overload of ApiClient.submitJobUrl(String, RevAiJobOptions) without the additional transcription options.
submitJobUrl(String, RevAiJobOptions) - Method in class ai.rev.speechtotext.ApiClient: The method sends a POST request to the /jobs endpoint, starts an asynchronous job to transcribe the media file located at the url provided and returns a RevAiJob object.

T

ThrottlingLimitException - Exception in ai.rev.speechtotext.exceptions: ThrottlingLimitException occurs when the number of queries within a given period reaches a throttling limit.
ThrottlingLimitException(JSONObject) - Constructor for exception ai.rev.speechtotext.exceptions.ThrottlingLimitException
toString() - Method in class ai.rev.speechtotext.models.asynchronous.Element
toString() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiCaptionType
toString() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiFailureType
toString() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
toString() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobStatus
toString() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobType
toString() - Method in class ai.rev.speechtotext.models.streaming.ConnectedMessage
toString() - Method in class ai.rev.speechtotext.models.streaming.Hypothesis
toString() - Method in enum ai.rev.speechtotext.models.streaming.MessageType
toString() - Method in class ai.rev.speechtotext.models.streaming.StreamingResponseMessage
TRANSCRIBED - ai.rev.speechtotext.models.asynchronous.RevAiJobStatus: The status when the file has been transcribed.
TRANSCRIPTION - ai.rev.speechtotext.models.asynchronous.RevAiFailureType: The failure used when an error occurs during transcription and prevents job completion.

V

valueOf(String) - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiCaptionType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiFailureType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.rev.speechtotext.models.streaming.MessageType: Returns the enum constant of this type with the specified name.
values() - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiCaptionType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiFailureType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.rev.speechtotext.models.streaming.MessageType: Returns an array containing the constants of this enum type, in the order they are declared.
VTT - ai.rev.speechtotext.models.asynchronous.RevAiCaptionType: The WebVTT caption file format.

A B C D E F G H I M O P R S T V
All Classes All Packages