Package ai.rev.speechtotext

Class StreamingClient

java.lang.Object

ai.rev.speechtotext.StreamingClient

public class StreamingClient
extends Object

Constructor Summary

Constructors

Constructor	Description
StreamingClient(String accessToken)	Constructs the streaming client that is used to establish a WebSocket connection with the Rev AI server and stream audio data.

Method Summary

Modifier and Type	Method	Description
void	close()	Will close the WebSocket connection by informing the server that it's the End of Stream
void	connect(RevAiWebSocketListener revAiWebSocketListener, StreamContentType streamContentType)	Overload of connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig) without the optional metadata and sessionConfig.
void	connect(RevAiWebSocketListener revAiWebSocketListener, StreamContentType streamContentType, SessionConfig sessionConfig)	Overload of connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig) without the optional metadata.
void	connect(RevAiWebSocketListener revAiWebSocketListener, StreamContentType streamContentType, String metadata)	Overload of connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig) without the optional sessionConfig.
void	connect(RevAiWebSocketListener revAiWebSocketListener, StreamContentType streamContentType, String metadata, SessionConfig sessionConfig)	Sends an HTTP request and upon authorization is upgraded to a WebSocket connection.
void	sendAudioData(okio.ByteString byteString)	Sends data over WebSocket in the form of a ByteString
void	setHost(String host)	This methods sets the URL host name.
void	setPort(int port)	This method sets a port number to be used in the WebSocket connect request.
void	setScheme(String scheme)	This method sets the URL scheme to be used in the WebSocket connect request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamingClient

public StreamingClient(String accessToken)

Constructs the streaming client that is used to establish a WebSocket connection with the Rev AI server and stream audio data. The user access token can be generated on the website at https://www.rev.ai/access_token.

Parameters:

accessToken - Rev AI authorization token.

Method Detail

setScheme

public void setScheme(String scheme)

This method sets the URL scheme to be used in the WebSocket connect request

Parameters:

scheme - URL scheme.

setHost

public void setHost(String host)

This methods sets the URL host name. By default the host name is api.rev.ai.

Parameters:

host - URL host name.

setPort

public void setPort(int port)

This method sets a port number to be used in the WebSocket connect request.

Parameters:

port - the port used to connect to

connect

public void connect(RevAiWebSocketListener revAiWebSocketListener,
                    StreamContentType streamContentType,
                    String metadata,
                    SessionConfig sessionConfig)

Sends an HTTP request and upon authorization is upgraded to a WebSocket connection. Use RevAiWebSocketListener to handle web socket events. To establish a successful connection a valid StreamContentType must be provided.

Providing metadata is optional but helps to identify the stream.

Providing a SessionConfig is optional. Use this object to enable the profanity filter and provide a custom vocabulary id.

Parameters:

revAiWebSocketListener - the listener used to capture WebSocket events.

streamContentType - content-type query parameter.

metadata - used to identify the stream.

sessionConfig - object containing the filter profanity setting and custom vocabulary id

See Also:

RevAiWebSocketListener, StreamContentType, SessionConfig

connect

public void connect(RevAiWebSocketListener revAiWebSocketListener,
                    StreamContentType streamContentType)

Overload of connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig) without the optional metadata and sessionConfig.

See Also:

connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig)

connect

public void connect(RevAiWebSocketListener revAiWebSocketListener,
                    StreamContentType streamContentType,
                    String metadata)

Overload of connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig) without the optional sessionConfig.

See Also:

connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig)

connect

public void connect(RevAiWebSocketListener revAiWebSocketListener,
                    StreamContentType streamContentType,
                    SessionConfig sessionConfig)

Overload of connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig) without the optional metadata.

See Also:

connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig)

sendAudioData

public void sendAudioData(okio.ByteString byteString)

Sends data over WebSocket in the form of a ByteString

Parameters:

byteString - Audio data in the form of a ByteString

close

public void close()

Will close the WebSocket connection by informing the server that it's the End of Stream