Fix docs on playUntilStartOfMediaItem to match playUntilPosition

The behaviour and docs of `playUntilPosition` were changed in
00c7a9bcbb.

This change also affects `playUntilStartOfMediaItem` (since it delegates
to `playUntilPosition`), so the same doc change should also be made
here.

#minor-release

PiperOrigin-RevId: 607364897
This commit is contained in:
ibaker 2024-02-15 09:47:27 -08:00 committed by Copybara-Service
parent fb7438378d
commit fa3212e73e

View File

@ -340,8 +340,12 @@ public class TestPlayerRunHelper {
/**
* Calls {@link Player#play()}, runs tasks of the main {@link Looper} until the {@code player}
* reaches the specified media item or a playback error occurs, and then pauses the {@code
* player}.
* reaches the specified media item or a playback error occurs.
*
* <p>The playback thread is automatically blocked from making further progress after reaching the
* media item and will only be unblocked by other {@code run/playUntil...} methods, custom {@link
* RobolectricUtil#runMainLooperUntil} conditions or an explicit {@link
* ThreadTestUtil#unblockThreadsWaitingForProgressOnCurrentLooper()} on the main thread.
*
* <p>If a playback error occurs it will be thrown wrapped in an {@link IllegalStateException}.
*