TrackSelectionParameters

Kotlin |Java

public class TrackSelectionParameters implements Bundleable

Known direct subclasses

DefaultTrackSelector.Parameters

DefaultTrackSelector.Parameters

Extends Parameters by adding fields that are specific to DefaultTrackSelector.

Parameters for controlling track selection.

Parameters can be queried and set on a Player. For example the following code modifies the parameters to restrict video track selections to SD, and to select a German audio track if there is one:

// Build on the current parameters.
TrackSelectionParameters currentParameters = player.getTrackSelectionParameters();
// Build the resulting parameters.
TrackSelectionParameters newParameters = currentParameters
    .buildUpon()
    .setMaxVideoSizeSd()
    .setPreferredAudioLanguage("de")
    .build();
// Set the new parameters.
player.setTrackSelectionParameters(newParameters);

Summary

Nested types
`@UnstableApi public final class TrackSelectionParameters.AudioOffloadPreferences implements Bundleable` Preferences and constraints for enabling audio offload.
`@Documented @Retention(value = SOURCE) @Target(value = TYPE_USE) @IntDef(value = ) public annotation TrackSelectionParameters.AudioOffloadPreferences.AudioOffloadMode` The preference level for enabling audio offload on the audio sink.
`public final class TrackSelectionParameters.AudioOffloadPreferences.Builder` A builder for `AudioOffloadPreferences`.
`public class TrackSelectionParameters.Builder` A builder for `TrackSelectionParameters`.

Constants
`static final Bundleable.Creator<TrackSelectionParameters>`	`@UnstableApi CREATOR` This field is deprecated. Use `fromBundle` instead.
`static final TrackSelectionParameters`	`@UnstableApi DEFAULT` This field is deprecated. This instance is not configured using `Context` constraints.
`static final TrackSelectionParameters`	`@UnstableApi DEFAULT_WITHOUT_CONTEXT` An instance with default values, except those obtained from the `Context`.
`static final int`	`@UnstableApi FIELD_CUSTOM_ID_BASE = 1000` Defines a minimum field ID value for subclasses to use when implementing `toBundle` and delegating to `Builder`.

Public fields
`final TrackSelectionParameters.AudioOffloadPreferences`	`@UnstableApi audioOffloadPreferences` The preferred offload mode settings for audio playback.
`final ImmutableSet<@C.TrackType Integer>`	`disabledTrackTypes` The track types that are disabled.
`final boolean`	`forceHighestSupportedBitrate` Whether to force selection of the highest bitrate audio and video tracks that comply with all other constraints.
`final boolean`	`forceLowestBitrate` Whether to force selection of the single lowest bitrate audio and video tracks that comply with all other constraints.
`final int`	`@C.SelectionFlags ignoredTextSelectionFlags` Bitmask of selection flags that are ignored for text track selections.
`final boolean`	`@UnstableApi isPrioritizeImageOverVideoEnabled` Whether an image track will be selected over a video track if both are available.
`final int`	`maxAudioBitrate` Maximum allowed audio bitrate in bits per second.
`final int`	`maxAudioChannelCount` Maximum allowed audio channel count.
`final int`	`maxVideoBitrate` Maximum allowed video bitrate in bits per second.
`final int`	`maxVideoFrameRate` Maximum allowed video frame rate in hertz.
`final int`	`maxVideoHeight` Maximum allowed video height in pixels.
`final int`	`maxVideoWidth` Maximum allowed video width in pixels.
`final int`	`minVideoBitrate` Minimum allowed video bitrate in bits per second.
`final int`	`minVideoFrameRate` Minimum allowed video frame rate in hertz.
`final int`	`minVideoHeight` Minimum allowed video height in pixels.
`final int`	`minVideoWidth` Minimum allowed video width in pixels.
`final ImmutableMap<TrackGroup, TrackSelectionOverride>`	`overrides` Overrides to force selection of specific tracks.
`final ImmutableList<String>`	`preferredAudioLanguages` The preferred languages for audio and forced text tracks as IETF BCP 47 conformant tags in order of preference.
`final ImmutableList<String>`	`preferredAudioMimeTypes` The preferred sample MIME types for audio tracks in order of preference, or an empty list for no preference.
`final int`	`@C.RoleFlags preferredAudioRoleFlags` The preferred `C.RoleFlags` for audio tracks.
`final ImmutableList<String>`	`preferredTextLanguages` The preferred languages for text tracks as IETF BCP 47 conformant tags in order of preference.
`final int`	`@C.RoleFlags preferredTextRoleFlags` The preferred `C.RoleFlags` for text tracks.
`final ImmutableList<String>`	`preferredVideoMimeTypes` The preferred sample MIME types for video tracks in order of preference, or an empty list for no preference.
`final int`	`@C.RoleFlags preferredVideoRoleFlags` The preferred `C.RoleFlags` for video tracks.
`final boolean`	`selectUndeterminedTextLanguage` Whether a text track with undetermined language should be selected if no track with `preferredTextLanguages` is available, or if `preferredTextLanguages` is unset.
`final int`	`viewportHeight` Viewport height in pixels.
`final boolean`	`viewportOrientationMayChange` Whether the viewport orientation may change during playback.
`final int`	`viewportWidth` Viewport width in pixels.

Protected constructors
`@UnstableApi TrackSelectionParameters(TrackSelectionParameters.Builder builder)`

Public methods
`TrackSelectionParameters.Builder`	`buildUpon()` Creates a new `Builder`, copying the initial values from this instance.
`boolean`	`equals(@Nullable Object obj)`
`static TrackSelectionParameters`	`fromBundle(Bundle bundle)` Construct an instance from a `Bundle` produced by `toBundle`.
`static TrackSelectionParameters`	`getDefaults(Context context)` Returns an instance configured with default values.
`int`	`hashCode()`
`Bundle`	`toBundle()` Returns a `Bundle` representing the information stored in this object.

Constants

CREATOR

@UnstableApi
public static final Bundleable.Creator<TrackSelectionParameters> CREATOR

DEFAULT

@UnstableApi
public static final TrackSelectionParameters DEFAULT

DEFAULT_WITHOUT_CONTEXT

@UnstableApi
public static final TrackSelectionParameters DEFAULT_WITHOUT_CONTEXT

An instance with default values, except those obtained from the Context.

If possible, use getDefaults instead.

This instance will not have the following settings:

Viewport constraints configured for the primary display.
Preferred text language and role flags configured to the accessibility settings of CaptioningManager.

FIELD_CUSTOM_ID_BASE

@UnstableApi
protected static final int FIELD_CUSTOM_ID_BASE = 1000

Defines a minimum field ID value for subclasses to use when implementing toBundle and delegating to Builder.

Subclasses should obtain keys for their Bundle representation by applying a non-negative offset on this constant and passing the result to intToStringMaxRadix.

Public fields

audioOffloadPreferences

@UnstableApi
public final TrackSelectionParameters.AudioOffloadPreferences audioOffloadPreferences

The preferred offload mode settings for audio playback. The default is DEFAULT.

disabledTrackTypes

public final ImmutableSet<@C.TrackType Integer> disabledTrackTypes

The track types that are disabled. No track of a disabled type will be selected, thus no track type contained in the set will be played. The default value is that no track type is disabled (empty set).

forceHighestSupportedBitrate

public final boolean forceHighestSupportedBitrate

Whether to force selection of the highest bitrate audio and video tracks that comply with all other constraints. The default value is false.

forceLowestBitrate

public final boolean forceLowestBitrate

Whether to force selection of the single lowest bitrate audio and video tracks that comply with all other constraints. The default value is false.

ignoredTextSelectionFlags

@C.SelectionFlags
public final int ignoredTextSelectionFlags

Bitmask of selection flags that are ignored for text track selections. See . The default value is 0 (i.e., no flags are ignored).

isPrioritizeImageOverVideoEnabled

@UnstableApi
public final boolean isPrioritizeImageOverVideoEnabled

Whether an image track will be selected over a video track if both are available. The default value is false.

maxAudioBitrate

public final int maxAudioBitrate

Maximum allowed audio bitrate in bits per second. The default value is MAX_VALUE (i.e. no constraint).

maxAudioChannelCount

public final int maxAudioChannelCount

Maximum allowed audio channel count. The default value is MAX_VALUE (i.e. no constraint).

maxVideoBitrate

public final int maxVideoBitrate

Maximum allowed video bitrate in bits per second. The default value is MAX_VALUE (i.e. no constraint).

maxVideoFrameRate

public final int maxVideoFrameRate

Maximum allowed video frame rate in hertz. The default value is MAX_VALUE (i.e. no constraint).

maxVideoHeight

public final int maxVideoHeight

Maximum allowed video height in pixels. The default value is MAX_VALUE (i.e. no constraint).

To constrain adaptive video track selections to be suitable for a given viewport (the region of the display within which video will be played), use (viewportWidth, viewportHeight and viewportOrientationMayChange) instead.

maxVideoWidth

public final int maxVideoWidth

Maximum allowed video width in pixels. The default value is MAX_VALUE (i.e. no constraint).

minVideoBitrate

public final int minVideoBitrate

Minimum allowed video bitrate in bits per second. The default value is 0 (i.e. no constraint).

minVideoFrameRate

public final int minVideoFrameRate

Minimum allowed video frame rate in hertz. The default value is 0 (i.e. no constraint).

minVideoHeight

public final int minVideoHeight

Minimum allowed video height in pixels. The default value is 0 (i.e. no constraint).

minVideoWidth

public final int minVideoWidth

Minimum allowed video width in pixels. The default value is 0 (i.e. no constraint).

overrides

public final ImmutableMap<TrackGroup, TrackSelectionOverride> overrides

Overrides to force selection of specific tracks.

preferredAudioLanguages

public final ImmutableList<String> preferredAudioLanguages

The preferred languages for audio and forced text tracks as IETF BCP 47 conformant tags in order of preference. An empty list selects the default track, or the first track if there's no default. The default value is an empty list.

preferredAudioMimeTypes

public final ImmutableList<String> preferredAudioMimeTypes

The preferred sample MIME types for audio tracks in order of preference, or an empty list for no preference. The default is an empty list.

preferredAudioRoleFlags

@C.RoleFlags
public final int preferredAudioRoleFlags

The preferred C.RoleFlags for audio tracks. 0 selects the default track if there is one, or the first track if there's no default. The default value is 0.

preferredTextLanguages

public final ImmutableList<String> preferredTextLanguages

The preferred languages for text tracks as IETF BCP 47 conformant tags in order of preference. An empty list selects the default track if there is one, or no track otherwise. The default value is an empty list, or the language of the accessibility CaptioningManager if enabled.

preferredTextRoleFlags

@C.RoleFlags
public final int preferredTextRoleFlags

The preferred C.RoleFlags for text tracks. 0 selects the default track if there is one, or no track otherwise. The default value is 0, or ROLE_FLAG_SUBTITLE | ROLE_FLAG_DESCRIBES_MUSIC_AND_SOUND if the accessibility CaptioningManager is enabled.

preferredVideoMimeTypes

public final ImmutableList<String> preferredVideoMimeTypes

The preferred sample MIME types for video tracks in order of preference, or an empty list for no preference. The default is an empty list.

preferredVideoRoleFlags

@C.RoleFlags
public final int preferredVideoRoleFlags

The preferred C.RoleFlags for video tracks. 0 selects the default track if there is one, or the first track if there's no default. The default value is 0.

selectUndeterminedTextLanguage

public final boolean selectUndeterminedTextLanguage

Whether a text track with undetermined language should be selected if no track with preferredTextLanguages is available, or if preferredTextLanguages is unset. The default value is false.

viewportHeight

public final int viewportHeight

Viewport height in pixels. Constrains video track selections for adaptive content so that only tracks suitable for the viewport are selected. The default value is the physical height of the primary display, in pixels.

viewportOrientationMayChange

public final boolean viewportOrientationMayChange

Whether the viewport orientation may change during playback. Constrains video track selections for adaptive content so that only tracks suitable for the viewport are selected. The default value is true.

viewportWidth

public final int viewportWidth

Viewport width in pixels. Constrains video track selections for adaptive content so that only tracks suitable for the viewport are selected. The default value is the physical width of the primary display, in pixels.

Protected constructors