RttCall

Kotlin |Java

class RttCall

kotlin.Any
↳	android.telecom.Call.RttCall

A class that holds the state that describes the state of the RTT channel to the remote party, if it is active.

Summary

Constants
static Int	`RTT_MODE_FULL` Indicates that there should be a bidirectional audio stream between the two parties on the call.
static Int	`RTT_MODE_HCO` Indicates that the local user should be able to hear the audio stream from the remote user, but not vice versa.
static Int	`RTT_MODE_VCO` Indicates that the remote user should be able to hear the audio stream from the local user, but not vice versa.

Public methods
Int	`getRttAudioMode()` Returns the current RTT audio mode.
String!	`read()` Reads a string from the remote user, blocking if there is no data available.
String!	`readImmediately()` Non-blocking version of `read()`.
Unit	`setRttMode(mode: Int)` Sets the RTT audio mode.
Unit	`write(input: String!)` Writes the string {@param input} into the outgoing text stream for this RTT call.

Constants

RTT_MODE_FULL

Added in API level 26

static val RTT_MODE_FULL: Int

Indicates that there should be a bidirectional audio stream between the two parties on the call.

Value: 1

RTT_MODE_HCO

Added in API level 26

static val RTT_MODE_HCO: Int

Indicates that the local user should be able to hear the audio stream from the remote user, but not vice versa. Equivalent to muting the microphone.

Value: 2

RTT_MODE_VCO

Added in API level 26

static val RTT_MODE_VCO: Int

Indicates that the remote user should be able to hear the audio stream from the local user, but not vice versa. Equivalent to setting the volume to zero.

Value: 3

Public methods

getRttAudioMode

Added in API level 26

fun getRttAudioMode(): Int

Returns the current RTT audio mode.

Return
`Int`	Current RTT audio mode. One of `RTT_MODE_FULL`, `RTT_MODE_VCO`, or `RTT_MODE_HCO`.

read

Added in API level 26

fun read(): String!

Reads a string from the remote user, blocking if there is no data available. Returns null if the RTT conversation has been terminated and there is no further data to read. This method is not thread-safe -- calling it from multiple threads simultaneously may lead to interleaved text.

Return
`String!`	A string containing text sent by the remote user, or `null` if the conversation has been terminated or if there was an error while reading.

readImmediately

Added in API level 27

fun readImmediately(): String!

Non-blocking version of read(). Returns null if there is nothing to be read.

Return
`String!`	A string containing text entered by the user, or `null` if the user has not entered any new text yet.

setRttMode

Added in API level 26

fun setRttMode(mode: Int): Unit

Sets the RTT audio mode. The requested mode change will be communicated through Callback#onRttModeChanged(Call, int).

Parameters
`mode`	Int: The desired RTT audio mode, one of `RTT_MODE_FULL`, `RTT_MODE_VCO`, or `RTT_MODE_HCO`. Value is android.telecom.Call.RttCall.RTT_MODE_INVALID, `android.telecom.Call.RttCall#RTT_MODE_FULL`, `android.telecom.Call.RttCall#RTT_MODE_HCO`, or `android.telecom.Call.RttCall#RTT_MODE_VCO`

write

Added in API level 26

fun write(input: String!): Unit

Writes the string {@param input} into the outgoing text stream for this RTT call. Since RTT transmits text in real-time, this method should be called once for each user action. For example, when the user enters text as discrete characters using the keyboard, this method should be called once for each character. However, if the user enters text by pasting or autocomplete, the entire contents of the pasted or autocompleted text should be sent in one call to this method. This method is not thread-safe -- calling it from multiple threads simultaneously may lead to interleaved text.

Parameters
`input`	String!: The message to send to the remote user.