Call.RttCall
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. |
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
| |
Constants
RTT_MODE_FULL
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
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
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
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
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.
|
setRttMode
void setRttMode (int mode)
Sets the RTT audio mode. The requested mode change will be communicated through
onRttModeChanged(Call, int).
| Parameters | |
|---|---|
mode |
int: The desired RTT audio mode, one of RTT_MODE_FULL,
RTT_MODE_VCO, or RTT_MODE_HCO.
|
write
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 character the user enters into the device. This method is not thread-safe -- calling it from multiple threads simultaneously may lead to interleaved text.
| Throws | |
|---|---|
IOException |
|
Classes
- Call
- Call.Callback
- Call.Details
- Call.RttCall
- CallAudioState
- CallScreeningService
- CallScreeningService.CallResponse
- CallScreeningService.CallResponse.Builder
- Conference
- Conferenceable
- Connection
- Connection.RttModifyStatus
- Connection.VideoProvider
- ConnectionRequest
- ConnectionService
- DisconnectCause
- GatewayInfo
- InCallService
- InCallService.VideoCall
- InCallService.VideoCall.Callback
- PhoneAccount
- PhoneAccount.Builder
- PhoneAccountHandle
- RemoteConference
- RemoteConference.Callback
- RemoteConnection
- RemoteConnection.Callback
- RemoteConnection.VideoProvider
- RemoteConnection.VideoProvider.Callback
- StatusHints
- TelecomManager
- VideoProfile
- VideoProfile.CameraCapabilities

