Connection.RttTextStream

Kotlin |Java

public static final class Connection.RttTextStream
extends Object

java.lang.Object
↳	android.telecom.Connection.RttTextStream

Provides methods to read and write RTT data to/from the in-call app.

Summary

Public methods
`String`	`read()` Reads a string from the in-call app, blocking if there is no data available.
`String`	`readImmediately()` Non-blocking version of `read()`.
`void`	`write(String input)` Writes the string into the text stream to the UI 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.

Public methods

read

Added in API level 28

public String read ()

Reads a string from the in-call app, 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 entered by the user, or `null` if the conversation has been terminated or if there was an error while reading.

Throws
`IOException`

readImmediately

Added in API level 28

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`

write

Added in API level 28

public void write (String input)

Writes the string into the text stream to the UI for this RTT call. Since RTT transmits text in real-time, this method should be called as often as text snippets are received from the remote user, even if it is only one character.

This method is not thread-safe -- calling it from multiple threads simultaneously may lead to interleaved text.

Throws
`IOException`