Commit acdb19e9 by tonihei Committed by Oliver Woodman

Clean up documentation of DefaultTrackSelector.ParametersBuilder.

We don't usually refer to other classes when documenting method parameters
but rather duplicate the actual definition.

PiperOrigin-RevId: 262102714
parent c4ac166f
...@@ -57,9 +57,10 @@ public class TrackSelectionParameters implements Parcelable { ...@@ -57,9 +57,10 @@ public class TrackSelectionParameters implements Parcelable {
} }
/** /**
* See {@link TrackSelectionParameters#preferredAudioLanguage}. * Sets the preferred language for audio and forced text tracks.
* *
* @param preferredAudioLanguage Preferred audio language as an IETF BCP 47 conformant tag. * @param preferredAudioLanguage Preferred audio language as an IETF BCP 47 conformant tag, or
* {@code null} to select the default track, or the first track if there's no default.
* @return This builder. * @return This builder.
*/ */
public Builder setPreferredAudioLanguage(@Nullable String preferredAudioLanguage) { public Builder setPreferredAudioLanguage(@Nullable String preferredAudioLanguage) {
...@@ -70,9 +71,10 @@ public class TrackSelectionParameters implements Parcelable { ...@@ -70,9 +71,10 @@ public class TrackSelectionParameters implements Parcelable {
// Text // Text
/** /**
* See {@link TrackSelectionParameters#preferredTextLanguage}. * Sets the preferred language for text tracks.
* *
* @param preferredTextLanguage Preferred text language as an IETF BCP 47 conformant tag. * @param preferredTextLanguage Preferred text language as an IETF BCP 47 conformant tag, or
* {@code null} to select the default track if there is one, or no track otherwise.
* @return This builder. * @return This builder.
*/ */
public Builder setPreferredTextLanguage(@Nullable String preferredTextLanguage) { public Builder setPreferredTextLanguage(@Nullable String preferredTextLanguage) {
...@@ -81,8 +83,12 @@ public class TrackSelectionParameters implements Parcelable { ...@@ -81,8 +83,12 @@ public class TrackSelectionParameters implements Parcelable {
} }
/** /**
* See {@link TrackSelectionParameters#selectUndeterminedTextLanguage}. * Sets whether a text track with undetermined language should be selected if no track with
* {@link #setPreferredTextLanguage(String)} is available, or if the preferred language is
* unset.
* *
* @param selectUndeterminedTextLanguage Whether a text track with undetermined language should
* be selected if no preferred language track is available.
* @return This builder. * @return This builder.
*/ */
public Builder setSelectUndeterminedTextLanguage(boolean selectUndeterminedTextLanguage) { public Builder setSelectUndeterminedTextLanguage(boolean selectUndeterminedTextLanguage) {
...@@ -91,8 +97,10 @@ public class TrackSelectionParameters implements Parcelable { ...@@ -91,8 +97,10 @@ public class TrackSelectionParameters implements Parcelable {
} }
/** /**
* See {@link TrackSelectionParameters#disabledTextTrackSelectionFlags}. * Sets a bitmask of selection flags that are disabled for text track selections.
* *
* @param disabledTextTrackSelectionFlags A bitmask of {@link C.SelectionFlags} that are
* disabled for text track selections.
* @return This builder. * @return This builder.
*/ */
public Builder setDisabledTextTrackSelectionFlags( public Builder setDisabledTextTrackSelectionFlags(
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment