Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Clarify start/stop DTMF tone API documentation."

Browse Source
This commit is contained in:
Tyler Gunn
2023-02-10 21:32:58 +00:00
committed by Gerrit Code Review
parent d2250b1a4a 2517d03c19
commit b212a4bfc7
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
telecomm/java/android/telecom/Call.java
View File

@@ -1839,8 +1839,15 @@ public final class Call {
/**
* Instructs this {@code Call} to play a dual-tone multi-frequency signaling (DTMF) tone.
*
* Any other currently playing DTMF tone in the specified call is immediately stopped.
* <p>
* Tones are both played locally for the user to hear and sent to the network to be relayed
* to the remote device.
* <p>
* You must ensure that any call to {@link #playDtmfTone(char}) is followed by a matching
* call to {@link #stopDtmfTone()} and that each tone is stopped before a new one is started.
* The play and stop commands are relayed to the underlying
* {@link android.telecom.ConnectionService} as executed; implementations may not correctly
* handle out of order commands.
*
* @param digit A character representing the DTMF digit for which to play the tone. This
* value must be one of {@code '0'} through {@code '9'}, {@code '*'} or {@code '#'}.