Package ai.rev.speechtotext.models.streaming

Class StreamContentType

java.lang.Object

ai.rev.speechtotext.models.streaming.StreamContentType

public class StreamContentType
extends Object

The StreamContentType describes the format of the audio being sent over the WebSocket.

See Also:

https://docs.rev.ai/api/streaming/requests/#content-type

Constructor Summary

Constructors

Constructor	Description
StreamContentType()

Method Summary

Modifier and Type	Method	Description
String	buildContentString()	Returns the content string compiled from the StreamContentType properties to be used in the query parameter for the request to the /stream endpoint.
Integer	getChannels()	Returns the number of channels.
String	getContentType()	Returns the content type.
String	getFormat()	Returns the format of the audio samples.
String	getLayout()	Returns the channel layout.
Integer	getRate()	Returns the audio sample rate.
void	setChannels(Integer channels)	Specifies the number of audio channels that the audio samples contain.
void	setContentType(String contentType)	Specifies the content type of the audio.
void	setFormat(String format)	Specifies the format of the audio samples.
void	setLayout(String layout)	Specifies the layout of channels within the buffer.
void	setRate(Integer rate)	Specifies the sample rate of the audio.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamContentType

public StreamContentType()

Method Detail

getContentType

public String getContentType()

Returns the content type.

Returns:

The content type.

setContentType

public void setContentType(String contentType)

Specifies the content type of the audio.

Parameters:

contentType - The type of audio.

See Also:

https://docs.rev.ai/api/streaming/requests/#content-type

getLayout

public String getLayout()

Returns the channel layout.

Returns:

The channel layout.

setLayout

public void setLayout(String layout)

Specifies the layout of channels within the buffer.

Parameters:

layout - The channel layout.

See Also:

https://docs.rev.ai/api/streaming/requests/#content-type

getRate

public Integer getRate()

Returns the audio sample rate.

Returns:

The audio sample rate.

setRate

public void setRate(Integer rate)

Specifies the sample rate of the audio.

Parameters:

rate - The sample rate of the audio.

See Also:

https://docs.rev.ai/api/streaming/requests/#content-type

getFormat

public String getFormat()

Returns the format of the audio samples.

Returns:

The format of the audio samples.

setFormat

public void setFormat(String format)

Specifies the format of the audio samples.

Parameters:

format - The format of the audio samples.

See Also:

https://docs.rev.ai/api/streaming/requests/#content-type, Valid formats

getChannels

public Integer getChannels()

Returns the number of channels.

Returns:

The number of channels.

setChannels

public void setChannels(Integer channels)

Specifies the number of audio channels that the audio samples contain.

Parameters:

channels - the number of audio channels in the audio.

See Also:

https://docs.rev.ai/api/streaming/requests/#content-type

buildContentString

public String buildContentString()

Returns the content string compiled from the StreamContentType properties to be used in the query parameter for the request to the /stream endpoint.

Returns:

The content string used as the query parameter.