A builder for TrackSelectionParameters. See the TrackSelectionParameters documentation for explanations of the parameters that can be configured using this builder.

Summary

Constructors
public	Builder()
protected	Builder(Bundle bundle) Creates a builder with the initial values specified in bundle.
public	Builder(Context context) Creates a builder with default initial values.

Methods
public TrackSelectionParameters.Builder	addOverride(TrackSelectionOverride override) Adds an override, replacing any override for the same TrackGroup.
public TrackSelectionParameters	build() Builds a TrackSelectionParameters instance with the selected values.
public TrackSelectionParameters.Builder	clearOverride(TrackGroup mediaTrackGroup) Removes the override for the provided media TrackGroup, if there is one.
public TrackSelectionParameters.Builder	clearOverrides() Removes all overrides.
public TrackSelectionParameters.Builder	clearOverridesOfType(int trackType) Removes all overrides of the provided track type.
public TrackSelectionParameters.Builder	clearVideoSizeConstraints() Equivalent to setMaxVideoSize(Integer.MAX_VALUE, Integer.MAX_VALUE).
public TrackSelectionParameters.Builder	clearViewportSizeConstraints() Equivalent to setViewportSize(Integer.MAX_VALUE, Integer.MAX_VALUE, true).
protected TrackSelectionParameters.Builder	set(TrackSelectionParameters parameters) Overrides the value of the builder with the value of TrackSelectionParameters.
public TrackSelectionParameters.Builder	setAudioOffloadPreferences(TrackSelectionParameters.AudioOffloadPreferences audioOffloadPreferences) Sets the audio offload mode preferences.
public TrackSelectionParameters.Builder	setDisabledTrackTypes(java.util.Set<java.lang.Integer> disabledTrackTypes) Sets the disabled track types, preventing all tracks of those types from being selected for playback.
public TrackSelectionParameters.Builder	setForceHighestSupportedBitrate(boolean forceHighestSupportedBitrate) Sets whether to force selection of the highest bitrate audio and video tracks that comply with all other constraints.
public TrackSelectionParameters.Builder	setForceLowestBitrate(boolean forceLowestBitrate) Sets whether to force selection of the single lowest bitrate audio and video tracks that comply with all other constraints.
public TrackSelectionParameters.Builder	setIgnoredTextSelectionFlags(int ignoredTextSelectionFlags) Sets a bitmask of selection flags that are ignored for text track selections.
public TrackSelectionParameters.Builder	setMaxAudioBitrate(int maxAudioBitrate) Sets the maximum allowed audio bitrate.
public TrackSelectionParameters.Builder	setMaxAudioChannelCount(int maxAudioChannelCount) Sets the maximum allowed audio channel count.
public TrackSelectionParameters.Builder	setMaxVideoBitrate(int maxVideoBitrate) Sets the maximum allowed video bitrate.
public TrackSelectionParameters.Builder	setMaxVideoFrameRate(int maxVideoFrameRate) Sets the maximum allowed video frame rate.
public TrackSelectionParameters.Builder	setMaxVideoSize(int maxVideoWidth, int maxVideoHeight) Sets the maximum allowed video width and height.
public TrackSelectionParameters.Builder	setMaxVideoSizeSd() Equivalent to setMaxVideoSize(1279, 719).
public TrackSelectionParameters.Builder	setMinVideoBitrate(int minVideoBitrate) Sets the minimum allowed video bitrate.
public TrackSelectionParameters.Builder	setMinVideoFrameRate(int minVideoFrameRate) Sets the minimum allowed video frame rate.
public TrackSelectionParameters.Builder	setMinVideoSize(int minVideoWidth, int minVideoHeight) Sets the minimum allowed video width and height.
public TrackSelectionParameters.Builder	setOverrideForType(TrackSelectionOverride override) Sets an override, replacing all existing overrides with the same track type.
public TrackSelectionParameters.Builder	setPreferredAudioLanguage(java.lang.String preferredAudioLanguage) Sets the preferred language for audio and forced text tracks.
public TrackSelectionParameters.Builder	setPreferredAudioLanguages(java.lang.String preferredAudioLanguages[]) Sets the preferred languages for audio and forced text tracks.
public TrackSelectionParameters.Builder	setPreferredAudioMimeType(java.lang.String mimeType) Sets the preferred sample MIME type for audio tracks.
public TrackSelectionParameters.Builder	setPreferredAudioMimeTypes(java.lang.String mimeTypes[]) Sets the preferred sample MIME types for audio tracks.
public TrackSelectionParameters.Builder	setPreferredAudioRoleFlags(int preferredAudioRoleFlags) Sets the preferred C.RoleFlags for audio tracks.
public TrackSelectionParameters.Builder	setPreferredTextLanguage(java.lang.String preferredTextLanguage) Sets the preferred language for text tracks.
public TrackSelectionParameters.Builder	setPreferredTextLanguageAndRoleFlagsToCaptioningManagerSettings(Context context) Sets the preferred language and role flags for text tracks based on the accessibility settings of `CaptioningManager`.
public TrackSelectionParameters.Builder	setPreferredTextLanguages(java.lang.String preferredTextLanguages[]) Sets the preferred languages for text tracks.
public TrackSelectionParameters.Builder	setPreferredTextRoleFlags(int preferredTextRoleFlags) Sets the preferred C.RoleFlags for text tracks.
public TrackSelectionParameters.Builder	setPreferredVideoMimeType(java.lang.String mimeType) Sets the preferred sample MIME type for video tracks.
public TrackSelectionParameters.Builder	setPreferredVideoMimeTypes(java.lang.String mimeTypes[]) Sets the preferred sample MIME types for video tracks.
public TrackSelectionParameters.Builder	setPreferredVideoRoleFlags(int preferredVideoRoleFlags) Sets the preferred C.RoleFlags for video tracks.
public TrackSelectionParameters.Builder	setPrioritizeImageOverVideoEnabled(boolean isPrioritizeImageOverVideoEnabled) Sets whether an image track would be selected over a video track if both are available.
public TrackSelectionParameters.Builder	setSelectUndeterminedTextLanguage(boolean selectUndeterminedTextLanguage) Sets whether a text track with undetermined language should be selected if no track with a preferred language is available, or if the preferred language is unset.
public TrackSelectionParameters.Builder	setTrackTypeDisabled(int trackType, boolean disabled) Sets whether a track type is disabled.
public TrackSelectionParameters.Builder	setViewportSize(int viewportWidth, int viewportHeight, boolean viewportOrientationMayChange) Sets the viewport size to constrain adaptive video selections so that only tracks suitable for the viewport are selected.
public TrackSelectionParameters.Builder	setViewportSizeToPhysicalDisplaySize(Context context, boolean viewportOrientationMayChange) Equivalent to calling TrackSelectionParameters.Builder.setViewportSize(int, int, boolean) with the viewport size obtained from Util.getCurrentDisplayModeSize(Context).
from java.lang.Object	clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public Builder()

Deprecated: constraints will not be set using this constructor. Use TrackSelectionParameters.Builder.Builder(Context) instead.

public Builder(Context context)

Creates a builder with default initial values.

Parameters:

context: Any context.

protected Builder(Bundle bundle)

Creates a builder with the initial values specified in bundle.

Methods

protected TrackSelectionParameters.Builder set(TrackSelectionParameters parameters)

Overrides the value of the builder with the value of TrackSelectionParameters.

public TrackSelectionParameters.Builder setMaxVideoSizeSd()

Equivalent to setMaxVideoSize(1279, 719).

Returns:

This builder.

public TrackSelectionParameters.Builder clearVideoSizeConstraints()

Equivalent to setMaxVideoSize(Integer.MAX_VALUE, Integer.MAX_VALUE).

Returns:

This builder.

public TrackSelectionParameters.Builder setMaxVideoSize(int maxVideoWidth, int maxVideoHeight)

Sets the maximum allowed video width and height.

Parameters:

maxVideoWidth: Maximum allowed video width in pixels.
maxVideoHeight: Maximum allowed video height in pixels.

Returns:

This builder.

public TrackSelectionParameters.Builder setMaxVideoFrameRate(int maxVideoFrameRate)

Sets the maximum allowed video frame rate.

Parameters:

maxVideoFrameRate: Maximum allowed video frame rate in hertz.

Returns:

This builder.

public TrackSelectionParameters.Builder setMaxVideoBitrate(int maxVideoBitrate)

Sets the maximum allowed video bitrate.

Parameters:

maxVideoBitrate: Maximum allowed video bitrate in bits per second.

Returns:

This builder.

public TrackSelectionParameters.Builder setMinVideoSize(int minVideoWidth, int minVideoHeight)

Sets the minimum allowed video width and height.

Parameters:

minVideoWidth: Minimum allowed video width in pixels.
minVideoHeight: Minimum allowed video height in pixels.

Returns:

This builder.

public TrackSelectionParameters.Builder setMinVideoFrameRate(int minVideoFrameRate)

Sets the minimum allowed video frame rate.

Parameters:

minVideoFrameRate: Minimum allowed video frame rate in hertz.

Returns:

This builder.

public TrackSelectionParameters.Builder setMinVideoBitrate(int minVideoBitrate)

Sets the minimum allowed video bitrate.

Parameters:

minVideoBitrate: Minimum allowed video bitrate in bits per second.

Returns:

This builder.

public TrackSelectionParameters.Builder setViewportSizeToPhysicalDisplaySize(Context context, boolean viewportOrientationMayChange)

Equivalent to calling TrackSelectionParameters.Builder.setViewportSize(int, int, boolean) with the viewport size obtained from Util.getCurrentDisplayModeSize(Context).

Parameters:

context: Any context.
viewportOrientationMayChange: Whether the viewport orientation may change during playback.

Returns:

This builder.

public TrackSelectionParameters.Builder clearViewportSizeConstraints()

Equivalent to setViewportSize(Integer.MAX_VALUE, Integer.MAX_VALUE, true).

Returns:

This builder.

public TrackSelectionParameters.Builder setViewportSize(int viewportWidth, int viewportHeight, boolean viewportOrientationMayChange)

Sets the viewport size to constrain adaptive video selections so that only tracks suitable for the viewport are selected.

Parameters:

viewportWidth: Viewport width in pixels.
viewportHeight: Viewport height in pixels.
viewportOrientationMayChange: Whether the viewport orientation may change during playback.

Returns:

This builder.

public TrackSelectionParameters.Builder setPreferredVideoMimeType(java.lang.String mimeType)

Sets the preferred sample MIME type for video tracks.

Parameters:

mimeType: The preferred MIME type for video tracks, or null to clear a previously set preference.

Returns:

This builder.

public TrackSelectionParameters.Builder setPreferredVideoMimeTypes(java.lang.String mimeTypes[])

Sets the preferred sample MIME types for video tracks.

Parameters:

mimeTypes: The preferred MIME types for video tracks in order of preference, or an empty list for no preference.

Returns:

This builder.

public TrackSelectionParameters.Builder setPreferredVideoRoleFlags(int preferredVideoRoleFlags)

Sets the preferred C.RoleFlags for video tracks.

Parameters:

preferredVideoRoleFlags: Preferred video role flags.

Returns:

This builder.

public TrackSelectionParameters.Builder setPreferredAudioLanguage(java.lang.String preferredAudioLanguage)

Sets the preferred language for audio and forced text tracks.

Parameters:

preferredAudioLanguage: Preferred audio language as an IETF BCP 47 conformant tag, or null to select the default track, or the first track if there's no default.

Returns:

This builder.

public TrackSelectionParameters.Builder setPreferredAudioLanguages(java.lang.String preferredAudioLanguages[])

Sets the preferred languages for audio and forced text tracks.

Parameters:

preferredAudioLanguages: Preferred audio languages as IETF BCP 47 conformant tags in order of preference, or an empty array to select the default track, or the first track if there's no default.

Returns:

This builder.

public TrackSelectionParameters.Builder setPreferredAudioRoleFlags(int preferredAudioRoleFlags)

Sets the preferred C.RoleFlags for audio tracks.

Parameters:

preferredAudioRoleFlags: Preferred audio role flags.

Returns:

This builder.

public TrackSelectionParameters.Builder setMaxAudioChannelCount(int maxAudioChannelCount)

Sets the maximum allowed audio channel count.

Parameters:

maxAudioChannelCount: Maximum allowed audio channel count.

Returns:

This builder.

public TrackSelectionParameters.Builder setMaxAudioBitrate(int maxAudioBitrate)

Sets the maximum allowed audio bitrate.

Parameters:

maxAudioBitrate: Maximum allowed audio bitrate in bits per second.

Returns:

This builder.

public TrackSelectionParameters.Builder setPreferredAudioMimeType(java.lang.String mimeType)

Sets the preferred sample MIME type for audio tracks.

Parameters:

mimeType: The preferred MIME type for audio tracks, or null to clear a previously set preference.

Returns:

This builder.

public TrackSelectionParameters.Builder setPreferredAudioMimeTypes(java.lang.String mimeTypes[])

Sets the preferred sample MIME types for audio tracks.

Parameters:

mimeTypes: The preferred MIME types for audio tracks in order of preference, or an empty list for no preference.

Returns:

This builder.

public TrackSelectionParameters.Builder setAudioOffloadPreferences(TrackSelectionParameters.AudioOffloadPreferences audioOffloadPreferences)

Sets the audio offload mode preferences. This includes whether to enable/disable offload as well as to set requirements like if the device must support gapless transitions or speed change during offload.

public TrackSelectionParameters.Builder setPreferredTextLanguageAndRoleFlagsToCaptioningManagerSettings(Context context)

Sets the preferred language and role flags for text tracks based on the accessibility settings of CaptioningManager.

Does nothing when the CaptioningManager is disabled.

Parameters:

context: A .

Returns:

This builder.

public TrackSelectionParameters.Builder setPreferredTextLanguage(java.lang.String preferredTextLanguage)

Sets the preferred language for text tracks.

Parameters:

preferredTextLanguage: Preferred text language as an IETF BCP 47 conformant tag, or null to select the default track if there is one, or no track otherwise.

Returns:

This builder.

public TrackSelectionParameters.Builder setPreferredTextLanguages(java.lang.String preferredTextLanguages[])

Sets the preferred languages for text tracks.

Parameters:

preferredTextLanguages: Preferred text languages as IETF BCP 47 conformant tags in order of preference, or an empty array to select the default track if there is one, or no track otherwise.

Returns:

This builder.

public TrackSelectionParameters.Builder setPreferredTextRoleFlags(int preferredTextRoleFlags)

Sets the preferred C.RoleFlags for text tracks.

Parameters:

preferredTextRoleFlags: Preferred text role flags.

Returns:

This builder.

public TrackSelectionParameters.Builder setIgnoredTextSelectionFlags(int ignoredTextSelectionFlags)

Sets a bitmask of selection flags that are ignored for text track selections.

Parameters:

ignoredTextSelectionFlags: A bitmask of C.SelectionFlags that are ignored for text track selections.

Returns:

This builder.

public TrackSelectionParameters.Builder setSelectUndeterminedTextLanguage(boolean selectUndeterminedTextLanguage)

Sets whether a text track with undetermined language should be selected if no track with a preferred language is available, or if the preferred language is unset.

Parameters:

selectUndeterminedTextLanguage: Whether a text track with undetermined language should be selected if no preferred language track is available.

Returns:

This builder.

public TrackSelectionParameters.Builder setPrioritizeImageOverVideoEnabled(boolean isPrioritizeImageOverVideoEnabled)

Sets whether an image track would be selected over a video track if both are available.

Parameters:

isPrioritizeImageOverVideoEnabled: Whether an image track would be selected over a video track if both are available.

Returns:

This builder.

public TrackSelectionParameters.Builder setForceLowestBitrate(boolean forceLowestBitrate)

Sets whether to force selection of the single lowest bitrate audio and video tracks that comply with all other constraints.

Parameters:

forceLowestBitrate: Whether to force selection of the single lowest bitrate audio and video tracks.

Returns:

This builder.

public TrackSelectionParameters.Builder setForceHighestSupportedBitrate(boolean forceHighestSupportedBitrate)

Sets whether to force selection of the highest bitrate audio and video tracks that comply with all other constraints.

Parameters:

forceHighestSupportedBitrate: Whether to force selection of the highest bitrate audio and video tracks.

Returns:

This builder.

public TrackSelectionParameters.Builder addOverride(TrackSelectionOverride override)

Adds an override, replacing any override for the same TrackGroup.

public TrackSelectionParameters.Builder setOverrideForType(TrackSelectionOverride override)

Sets an override, replacing all existing overrides with the same track type.

public TrackSelectionParameters.Builder clearOverride(TrackGroup mediaTrackGroup)

Removes the override for the provided media TrackGroup, if there is one.

public TrackSelectionParameters.Builder clearOverridesOfType(int trackType)

Removes all overrides of the provided track type.

public TrackSelectionParameters.Builder clearOverrides()

Removes all overrides.

public TrackSelectionParameters.Builder setDisabledTrackTypes(java.util.Set<java.lang.Integer> disabledTrackTypes)

Deprecated: Use TrackSelectionParameters.Builder.setTrackTypeDisabled(int, boolean).

Sets the disabled track types, preventing all tracks of those types from being selected for playback. Any previously disabled track types are cleared.

Parameters:

disabledTrackTypes: The track types to disable.

Returns:

This builder.

public TrackSelectionParameters.Builder setTrackTypeDisabled(int trackType, boolean disabled)

Sets whether a track type is disabled. If disabled, no tracks of the specified type will be selected for playback.

Parameters:

trackType: The track type.
disabled: Whether the track type should be disabled.

Returns:

This builder.

public TrackSelectionParameters build()

Builds a TrackSelectionParameters instance with the selected values.