Further MediaPeriod.selectTracks documentation tweak

PiperOrigin-RevId: 261917229
This commit is contained in:
olly 2019-08-06 16:18:33 +01:00 committed by Oliver Woodman
parent a9b93d7ec2
commit fd803a39a3

View File

@ -113,15 +113,17 @@ public interface MediaPeriod extends SequenceableLoader {
* corresponding flag in {@code streamResetFlags} will be set to true. This flag will also be set * corresponding flag in {@code streamResetFlags} will be set to true. This flag will also be set
* if a new sample stream is created. * if a new sample stream is created.
* *
* <p>Note that previously received {@link TrackSelection TrackSelections} are no longer valid and * <p>Note that previously passed {@link TrackSelection TrackSelections} are no longer valid, and
* references need to be replaced even if the corresponding {@link SampleStream} is kept. * any references to them must be updated to point to the new selections.
* *
* <p>This method is only called after the period has been prepared. * <p>This method is only called after the period has been prepared.
* *
* @param selections The renderer track selections. * @param selections The renderer track selections.
* @param mayRetainStreamFlags Flags indicating whether the existing sample stream can be retained * @param mayRetainStreamFlags Flags indicating whether the existing sample stream can be retained
* for each selection. A {@code true} value indicates that the selection is unchanged, and * for each track selection. A {@code true} value indicates that the selection is equivalent
* that the caller does not require that the sample stream be recreated. * to the one that was previously passed, and that the caller does not require that the sample
* stream be recreated. If a retained sample stream holds any references to the track
* selection then they must be updated to point to the new selection.
* @param streams The existing sample streams, which will be updated to reflect the provided * @param streams The existing sample streams, which will be updated to reflect the provided
* selections. * selections.
* @param streamResetFlags Will be updated to indicate new sample streams, and sample streams that * @param streamResetFlags Will be updated to indicate new sample streams, and sample streams that