Clarify JavaDoc of MediaPeriod.

Two of MediaPeriod's methods are only called after the media period has been
prepared. Added this to JavaDoc of these method to simplify implementations.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=160510373
This commit is contained in:
tonihei 2017-06-29 04:16:16 -07:00 committed by Oliver Woodman
parent 50530147d0
commit 6509dce6b7

View file

@ -108,6 +108,8 @@ public interface MediaPeriod extends SequenceableLoader {
/**
* Discards buffered media up to the specified position.
* <p>
* This method should only be called after the period has been prepared.
*
* @param positionUs The position in microseconds.
*/
@ -118,6 +120,8 @@ public interface MediaPeriod extends SequenceableLoader {
* <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.
* <p>
* This method should only be 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}.