loliball/media3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify MediaPeriod.readDiscontinuity Javadoc

Browse Source 
It currently wrongly documents that it is only called before reading
streams (that has never been the case and all MediaPeriods already need
to handle calls after reading samples from the streams).

It was also a bit unclear what a discontinuity implies and the new
Javadoc calls out the main use case for discontinuties and the intended
meaning of returning a discontinuity.

#minor-release

PiperOrigin-RevId: 543989124
This commit is contained in:
tonihei 2023-06-28 08:55:56 +00:00 committed by Tianyi Feng
parent a632118875
commit b324b8aa72
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
libraries/exoplayer/src/main/java/androidx/media3/exoplayer/source/MediaPeriod.java
View File

@ -158,14 +158,18 @@ public interface MediaPeriod extends SequenceableLoader {
/**
* Attempts to read a discontinuity.
*
* <p>A discontinuity implies that the provided {@link SampleStream SampleStreams} will start from
* a new playback position and any output pipelines need to be reset. This happens for example if
* the streams provide decode-only samples before the intended playback start position that need
* to be dropped.
*
* <p>After this method has returned a value other than {@link C#TIME_UNSET}, all {@link
* SampleStream}s provided by the period are guaranteed to start from a key frame.
* SampleStream SampleStreams} provided by the period are guaranteed to start from a key frame.
*
* <p>This method is only called after the period has been prepared and before reading from any
* {@link SampleStream}s provided by the period.
* <p>This method is only called after the period has been prepared.
*
* @return If a discontinuity was read then the playback position in microseconds after the
* discontinuity. Else {@link C#TIME_UNSET}.
* @return The playback position after the discontinuity, in microseconds, or {@link C#TIME_UNSET}
* if there is no discontinuity.
*/
long readDiscontinuity();