Simplify DefaultTrackSelector documentation

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=202623116
This commit is contained in:
olly 2018-06-29 03:20:18 -07:00 committed by Oliver Woodman
parent f934df7780
commit 557fa17945

View File

@ -584,28 +584,18 @@ public class DefaultTrackSelector extends MappingTrackSelector {
* Maximum allowed video width. The default value is {@link Integer#MAX_VALUE} (i.e. no * Maximum allowed video width. The default value is {@link Integer#MAX_VALUE} (i.e. no
* constraint). * constraint).
* *
* <p>Note: To restrict adaptive video track selections to be suitable for a given viewport (the * <p>To constrain adaptive video track selections to be suitable for a given viewport (the
* region of the display within which video will be played), it's preferable to use viewport * region of the display within which video will be played), use ({@link #viewportWidth}, {@link
* constraints ({@link #viewportWidth}, {@link #viewportHeight} and * #viewportHeight} and {@link #viewportOrientationMayChange}) instead.
* {@link #viewportOrientationMayChange}) rather than video size constraints
* ({@link #maxVideoWidth and {@link #maxVideoHeight}). This is because selecting video tracks
* for a given viewport is normally more nuanced than imposing fixed limits on resolution (e.g.
* it's normally preferable to select one format that exceeds the size of the viewport, and to
* take into account the possibility that the orientation of the viewport may change).
*/ */
public final int maxVideoWidth; public final int maxVideoWidth;
/** /**
* Maximum allowed video height. The default value is {@link Integer#MAX_VALUE} (i.e. no * Maximum allowed video height. The default value is {@link Integer#MAX_VALUE} (i.e. no
* constraint). * constraint).
* *
* <p>Note: To restrict adaptive video track selections to be suitable for a given viewport (the * <p>To constrain adaptive video track selections to be suitable for a given viewport (the
* region of the display within which video will be played), it's preferable to use viewport * region of the display within which video will be played), use ({@link #viewportWidth}, {@link
* constraints ({@link #viewportWidth}, {@link #viewportHeight} and * #viewportHeight} and {@link #viewportOrientationMayChange}) instead.
* {@link #viewportOrientationMayChange}) rather than video size constraints
* ({@link #maxVideoWidth and {@link #maxVideoHeight}). This is because selecting video tracks
* for a given viewport is normally more nuanced than imposing fixed limits on resolution (e.g.
* it's normally preferable to select one format that exceeds the size of the viewport, and to
* take into account the possibility that the orientation of the viewport may change).
*/ */
public final int maxVideoHeight; public final int maxVideoHeight;
/** /**
@ -654,12 +644,13 @@ public class DefaultTrackSelector extends MappingTrackSelector {
*/ */
public final boolean allowNonSeamlessAdaptiveness; public final boolean allowNonSeamlessAdaptiveness;
/** /**
* Whether to exceed renderer capabilities when no selection can be made otherwise. This * Whether to exceed renderer capabilities when no selection can be made otherwise.
* parameter applies when all of the tracks available for a renderer exceed the renderer's *
* reported capabilities. If the parameter is {@code true} then the lowest quality track will * <p>This parameter applies when all of the tracks available for a renderer exceed the
* still be selected. Playback may succeed if the renderer has under-reported its true * renderer's reported capabilities. If the parameter is {@code true} then the lowest quality
* capabilities. If {@code false} then no track will be selected. The default value is {@code * track will still be selected. Playback may succeed if the renderer has under-reported its
* true}. * true capabilities. If {@code false} then no track will be selected. The default value is
* {@code true}.
*/ */
public final boolean exceedRendererCapabilitiesIfNecessary; public final boolean exceedRendererCapabilitiesIfNecessary;
/** /**