Call.RttCall

Kotlin |Java

public static final class Call.RttCall
extends Object

java.lang.Object
↳	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
`int`	`RTT_MODE_FULL` Indicates that there should be a bidirectional audio stream between the two parties on the call.
`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.
`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()`.
`void`	`setRttMode(int mode)` Sets the RTT audio mode.
`void`	`write(String input)` Writes the string into the outgoing text stream for this RTT call.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

RTT_MODE_FULL

Added in API level 26

public static final int RTT_MODE_FULL

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

Constant Value: 1 (0x00000001)

RTT_MODE_HCO

Added in API level 26

public static final 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. Equivalent to muting the microphone.

Constant Value: 2 (0x00000002)

RTT_MODE_VCO

Added in API level 26

public static final 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. Equivalent to setting the volume to zero.

Constant Value: 3 (0x00000003)

Public methods

getRttAudioMode

Added in API level 26

public int getRttAudioMode ()

Returns the current RTT audio mode.

Returns
`int`	Current RTT audio mode. One of `RTT_MODE_FULL`, `RTT_MODE_VCO`, or `RTT_MODE_HCO`.

read

Added in API level 26

public String read ()

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.

Returns
`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

public String readImmediately ()

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

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

Throws
`IOException`

setRttMode

Added in API level 26

public void setRttMode (int mode)

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, `RTT_MODE_FULL`, `RTT_MODE_HCO`, or `RTT_MODE_VCO`

write

Added in API level 26

public void write (String input)

Writes the string 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.

Throws
`IOException`