Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit def39f47 authored by Tyler Gunn's avatar Tyler Gunn Committed by Automerger Merge Worker
Browse files

Merge "Clarify start/stop DTMF tone API documentation." am: b212a4bf 

Original change: https://android-review.googlesource.com/c/platform/frameworks/base/+/2423245



Change-Id: I3fe36c88c02f281d63246007c2e004ebd75791f0
Signed-off-by: default avatarAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
parents f2a74a3a b212a4bf

telecomm/java/android/telecom/Call.java

+9 −2
Original line number Diff line number Diff line
@@ -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 '#'}.