Stay organized with collections
Save and categorize content based on your preferences.
Connection.RttTextStream
public
static
final
class
Connection.RttTextStream
extends Object
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
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. |
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. |
write
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.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# Connection.RttTextStream\n\nAdded in [API level 28](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nConnection.RttTextStream\n========================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/telecom/Connection.RttTextStream \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\nstatic\nfinal\n\nclass\nConnection.RttTextStream\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|------------------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.telecom.Connection.RttTextStream |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nProvides methods to read and write RTT data to/from the in-call app.\n\nSummary\n-------\n\n| ### Public methods ||\n|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` `[String](/reference/java/lang/String) | ` `[read](/reference/android/telecom/Connection.RttTextStream#read())`() ` Reads a string from the in-call app, blocking if there is no data available. |\n| ` `[String](/reference/java/lang/String) | ` `[readImmediately](/reference/android/telecom/Connection.RttTextStream#readImmediately())`() ` Non-blocking version of [read()](/reference/android/telecom/Connection.RttTextStream#read()). |\n| ` void` | ` `[write](/reference/android/telecom/Connection.RttTextStream#write(java.lang.String))`(`[String](/reference/java/lang/String)` input) ` Writes the string into the text stream to the UI for this RTT call. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long,%20int))`(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](/reference/java/lang/Object#wait(long))`(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](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic methods\n--------------\n\n### read\n\nAdded in [API level 28](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic String read ()\n```\n\nReads a string from the in-call app, blocking if there is no data available. Returns\n`null` if the RTT conversation has been terminated and there is no further data\nto read.\n\n\nThis method is not thread-safe -- calling it from multiple threads simultaneously may\nlead to interleaved text.\n\n\u003cbr /\u003e\n\n| Returns ||\n|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| [String](/reference/java/lang/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. \u003cbr /\u003e |\n\n| Throws ||\n|-----------------------------------------------|---|\n| [IOException](/reference/java/io/IOException) | |\n\n### readImmediately\n\nAdded in [API level 28](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic String readImmediately ()\n```\n\nNon-blocking version of [read()](/reference/android/telecom/Connection.RttTextStream#read()). Returns `null` if there is nothing to\nbe read.\n\n\u003cbr /\u003e\n\n| Returns ||\n|---------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| [String](/reference/java/lang/String) | A string containing text entered by the user, or `null` if the user has not entered any new text yet. \u003cbr /\u003e |\n\n| Throws ||\n|-----------------------------------------------|---|\n| [IOException](/reference/java/io/IOException) | |\n\n### write\n\nAdded in [API level 28](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic void write (String input)\n```\n\nWrites the string into the text stream to the UI for this RTT call. Since\nRTT transmits text in real-time, this method should be called as often as text snippets\nare received from the remote user, even if it is only one character.\n\n\nThis method is not thread-safe -- calling it from multiple threads simultaneously may\nlead to interleaved text.\n\n\u003cbr /\u003e\n\n| Throws ||\n|-----------------------------------------------|---|\n| [IOException](/reference/java/io/IOException) | |"]]
