DefaultTrackSelector.ParametersBuilder
class DefaultTrackSelector.ParametersBuilder : TrackSelectionParameters.Builder
| kotlin.Any | ||
| ↳ | androidx.media3.common.TrackSelectionParameters.Builder | |
| ↳ | androidx.media3.exoplayer.trackselection.DefaultTrackSelector.ParametersBuilder | |
Summary
Public constructors |
|---|
|
This function is deprecated.
|
ParametersBuilder(context: Context!)Creates a builder with default initial values. |
Protected functions |
|
|---|---|
DefaultTrackSelector.ParametersBuilder! |
@CanIgnoreReturnValueOverrides the value of the builder with the value of |
Public constructors
ParametersBuilder
ParametersBuilder(context: Context!)
Creates a builder with default initial values.
| Parameters | |
|---|---|
context: Context! |
Any context. |
Public functions
addOverride
@CanIgnoreReturnValue
fun addOverride(override: TrackSelectionOverride!): DefaultTrackSelector.ParametersBuilder!
Adds an override, replacing any override for the same TrackGroup.
build
fun build(): DefaultTrackSelector.Parameters!
Builds a Parameters instance with the selected values.
clearOverride
@CanIgnoreReturnValue
fun clearOverride(trackGroup: TrackGroup!): DefaultTrackSelector.ParametersBuilder!
Removes the override for the provided media TrackGroup, if there is one.
clearOverrides
@CanIgnoreReturnValue
fun clearOverrides(): DefaultTrackSelector.ParametersBuilder!
Removes all overrides.
clearOverridesOfType
@CanIgnoreReturnValue
fun clearOverridesOfType(@C.TrackType trackType: Int): DefaultTrackSelector.ParametersBuilder!
Removes all overrides of the provided track type.
clearSelectionOverride
@CanIgnoreReturnValue
funclearSelectionOverride(rendererIndex: Int, groups: TrackGroupArray!): DefaultTrackSelector.ParametersBuilder!
Clears a track selection override for the specified renderer and TrackGroupArray.
| Parameters | |
|---|---|
rendererIndex: Int |
The renderer index. |
groups: TrackGroupArray! |
The |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
clearSelectionOverrides
@CanIgnoreReturnValue
funclearSelectionOverrides(): DefaultTrackSelector.ParametersBuilder!
Clears all track selection overrides for all renderers.
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
clearSelectionOverrides
@CanIgnoreReturnValue
funclearSelectionOverrides(rendererIndex: Int): DefaultTrackSelector.ParametersBuilder!
Clears all track selection overrides for the specified renderer.
| Parameters | |
|---|---|
rendererIndex: Int |
The renderer index. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
clearVideoSizeConstraints
@CanIgnoreReturnValue
fun clearVideoSizeConstraints(): DefaultTrackSelector.ParametersBuilder!
Equivalent to setMaxVideoSize(Integer.MAX_VALUE, Integer.MAX_VALUE).
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
clearViewportSizeConstraints
@CanIgnoreReturnValue
fun clearViewportSizeConstraints(): DefaultTrackSelector.ParametersBuilder!
Equivalent to setViewportSize(Integer.MAX_VALUE, Integer.MAX_VALUE, true).
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setAllowAudioMixedChannelCountAdaptiveness
@CanIgnoreReturnValue
fun setAllowAudioMixedChannelCountAdaptiveness(
allowAudioMixedChannelCountAdaptiveness: Boolean
): DefaultTrackSelector.ParametersBuilder!
Sets whether to allow adaptive audio selections containing mixed channel counts.
Adaptations between different channel counts may not be completely seamless.
| Parameters | |
|---|---|
allowAudioMixedChannelCountAdaptiveness: Boolean |
Whether to allow adaptive audio selections containing mixed channel counts. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setAllowAudioMixedDecoderSupportAdaptiveness
@CanIgnoreReturnValue
fun setAllowAudioMixedDecoderSupportAdaptiveness(
allowAudioMixedDecoderSupportAdaptiveness: Boolean
): DefaultTrackSelector.ParametersBuilder!
Sets whether to allow adaptive audio selections with mixed levels of and .
| Parameters | |
|---|---|
allowAudioMixedDecoderSupportAdaptiveness: Boolean |
Whether to allow adaptive audio selections with mixed levels of decoder and hardware acceleration support. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setAllowAudioMixedMimeTypeAdaptiveness
@CanIgnoreReturnValue
fun setAllowAudioMixedMimeTypeAdaptiveness(
allowAudioMixedMimeTypeAdaptiveness: Boolean
): DefaultTrackSelector.ParametersBuilder!
Sets whether to allow adaptive audio selections containing mixed MIME types.
Adaptations between different MIME types may not be completely seamless, in which case setAllowAudioNonSeamlessAdaptiveness also needs to be true for mixed MIME type selections to be made.
| Parameters | |
|---|---|
allowAudioMixedMimeTypeAdaptiveness: Boolean |
Whether to allow adaptive audio selections containing mixed MIME types. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setAllowAudioMixedSampleRateAdaptiveness
@CanIgnoreReturnValue
fun setAllowAudioMixedSampleRateAdaptiveness(
allowAudioMixedSampleRateAdaptiveness: Boolean
): DefaultTrackSelector.ParametersBuilder!
Sets whether to allow adaptive audio selections containing mixed sample rates.
Adaptations between different sample rates may not be completely seamless.
| Parameters | |
|---|---|
allowAudioMixedSampleRateAdaptiveness: Boolean |
Whether to allow adaptive audio selections containing mixed sample rates. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setAllowMultipleAdaptiveSelections
@CanIgnoreReturnValue
fun setAllowMultipleAdaptiveSelections(
allowMultipleAdaptiveSelections: Boolean
): DefaultTrackSelector.ParametersBuilder!
Sets whether multiple adaptive selections with more than one track are allowed.
| Parameters | |
|---|---|
allowMultipleAdaptiveSelections: Boolean |
Whether multiple adaptive selections are allowed. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setAllowVideoMixedDecoderSupportAdaptiveness
@CanIgnoreReturnValue
fun setAllowVideoMixedDecoderSupportAdaptiveness(
allowVideoMixedDecoderSupportAdaptiveness: Boolean
): DefaultTrackSelector.ParametersBuilder!
Sets whether to allow adaptive video selections with mixed levels of and .
| Parameters | |
|---|---|
allowVideoMixedDecoderSupportAdaptiveness: Boolean |
Whether to allow adaptive video selections with mixed levels of decoder and hardware acceleration support. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setAllowVideoMixedMimeTypeAdaptiveness
@CanIgnoreReturnValue
fun setAllowVideoMixedMimeTypeAdaptiveness(
allowVideoMixedMimeTypeAdaptiveness: Boolean
): DefaultTrackSelector.ParametersBuilder!
Sets whether to allow adaptive video selections containing mixed MIME types.
Adaptations between different MIME types may not be completely seamless, in which case setAllowVideoNonSeamlessAdaptiveness also needs to be true for mixed MIME type selections to be made.
| Parameters | |
|---|---|
allowVideoMixedMimeTypeAdaptiveness: Boolean |
Whether to allow adaptive video selections containing mixed MIME types. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setAllowVideoNonSeamlessAdaptiveness
@CanIgnoreReturnValue
fun setAllowVideoNonSeamlessAdaptiveness(
allowVideoNonSeamlessAdaptiveness: Boolean
): DefaultTrackSelector.ParametersBuilder!
Sets whether to allow adaptive video selections where adaptation may not be completely seamless.
| Parameters | |
|---|---|
allowVideoNonSeamlessAdaptiveness: Boolean |
Whether to allow adaptive video selections where adaptation may not be completely seamless. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setAudioOffloadPreferences
@CanIgnoreReturnValue
fun setAudioOffloadPreferences(
audioOffloadPreferences: TrackSelectionParameters.AudioOffloadPreferences!
): DefaultTrackSelector.ParametersBuilder!
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.
setDisabledTextTrackSelectionFlags
@CanIgnoreReturnValue
funsetDisabledTextTrackSelectionFlags(
@C.SelectionFlags disabledTextTrackSelectionFlags: Int
): DefaultTrackSelector.ParametersBuilder!
setDisabledTrackTypes
@CanIgnoreReturnValue
funsetDisabledTrackTypes(disabledTrackTypes: (Mutable)Set<@C.TrackType Int!>!): DefaultTrackSelector.ParametersBuilder!
setExceedAudioConstraintsIfNecessary
@CanIgnoreReturnValue
fun setExceedAudioConstraintsIfNecessary(
exceedAudioConstraintsIfNecessary: Boolean
): DefaultTrackSelector.ParametersBuilder!
Sets whether to exceed the setMaxAudioChannelCount and setMaxAudioBitrate constraints when no selection can be made otherwise.
| Parameters | |
|---|---|
exceedAudioConstraintsIfNecessary: Boolean |
Whether to exceed audio constraints when no selection can be made otherwise. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setExceedRendererCapabilitiesIfNecessary
@CanIgnoreReturnValue
fun setExceedRendererCapabilitiesIfNecessary(
exceedRendererCapabilitiesIfNecessary: Boolean
): DefaultTrackSelector.ParametersBuilder!
Sets whether to exceed renderer capabilities when no selection can be made otherwise.
This parameter applies when all of the tracks available for a renderer exceed the renderer's reported capabilities. If the parameter is true then the lowest quality track will still be selected. Playback may succeed if the renderer has under-reported its true capabilities. If false then no track will be selected.
| Parameters | |
|---|---|
exceedRendererCapabilitiesIfNecessary: Boolean |
Whether to exceed renderer capabilities when no selection can be made otherwise. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setExceedVideoConstraintsIfNecessary
@CanIgnoreReturnValue
fun setExceedVideoConstraintsIfNecessary(
exceedVideoConstraintsIfNecessary: Boolean
): DefaultTrackSelector.ParametersBuilder!
Sets whether to exceed the setMaxVideoBitrate, setMaxVideoSize and setMaxVideoFrameRate constraints when no selection can be made otherwise.
| Parameters | |
|---|---|
exceedVideoConstraintsIfNecessary: Boolean |
Whether to exceed video constraints when no selection can be made otherwise. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setForceHighestSupportedBitrate
@CanIgnoreReturnValue
fun setForceHighestSupportedBitrate(forceHighestSupportedBitrate: Boolean): DefaultTrackSelector.ParametersBuilder!
Sets whether to force selection of the highest bitrate audio and video tracks that comply with all other constraints.
| Parameters | |
|---|---|
forceHighestSupportedBitrate: Boolean |
Whether to force selection of the highest bitrate audio and video tracks. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setForceLowestBitrate
@CanIgnoreReturnValue
fun setForceLowestBitrate(forceLowestBitrate: Boolean): DefaultTrackSelector.ParametersBuilder!
Sets whether to force selection of the single lowest bitrate audio and video tracks that comply with all other constraints.
| Parameters | |
|---|---|
forceLowestBitrate: Boolean |
Whether to force selection of the single lowest bitrate audio and video tracks. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setIgnoredTextSelectionFlags
@CanIgnoreReturnValue
fun setIgnoredTextSelectionFlags(
@C.SelectionFlags ignoredTextSelectionFlags: Int
): DefaultTrackSelector.ParametersBuilder!
Sets a bitmask of selection flags that are ignored for text track selections.
| Parameters | |
|---|---|
@C.SelectionFlags ignoredTextSelectionFlags: Int |
A bitmask of |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setMaxAudioBitrate
@CanIgnoreReturnValue
fun setMaxAudioBitrate(maxAudioBitrate: Int): DefaultTrackSelector.ParametersBuilder!
Sets the maximum allowed audio bitrate.
| Parameters | |
|---|---|
maxAudioBitrate: Int |
Maximum allowed audio bitrate in bits per second. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setMaxAudioChannelCount
@CanIgnoreReturnValue
fun setMaxAudioChannelCount(maxAudioChannelCount: Int): DefaultTrackSelector.ParametersBuilder!
Sets the maximum allowed audio channel count.
| Parameters | |
|---|---|
maxAudioChannelCount: Int |
Maximum allowed audio channel count. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setMaxVideoBitrate
@CanIgnoreReturnValue
fun setMaxVideoBitrate(maxVideoBitrate: Int): DefaultTrackSelector.ParametersBuilder!
Sets the maximum allowed video bitrate.
| Parameters | |
|---|---|
maxVideoBitrate: Int |
Maximum allowed video bitrate in bits per second. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setMaxVideoFrameRate
@CanIgnoreReturnValue
fun setMaxVideoFrameRate(maxVideoFrameRate: Int): DefaultTrackSelector.ParametersBuilder!
Sets the maximum allowed video frame rate.
| Parameters | |
|---|---|
maxVideoFrameRate: Int |
Maximum allowed video frame rate in hertz. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setMaxVideoSize
@CanIgnoreReturnValue
fun setMaxVideoSize(maxVideoWidth: Int, maxVideoHeight: Int): DefaultTrackSelector.ParametersBuilder!
Sets the maximum allowed video width and height.
| Parameters | |
|---|---|
maxVideoWidth: Int |
Maximum allowed video width in pixels. |
maxVideoHeight: Int |
Maximum allowed video height in pixels. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setMaxVideoSizeSd
@CanIgnoreReturnValue
fun setMaxVideoSizeSd(): DefaultTrackSelector.ParametersBuilder!
Equivalent to setMaxVideoSize(1279, 719).
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setMinVideoBitrate
@CanIgnoreReturnValue
fun setMinVideoBitrate(minVideoBitrate: Int): DefaultTrackSelector.ParametersBuilder!
Sets the minimum allowed video bitrate.
| Parameters | |
|---|---|
minVideoBitrate: Int |
Minimum allowed video bitrate in bits per second. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setMinVideoFrameRate
@CanIgnoreReturnValue
fun setMinVideoFrameRate(minVideoFrameRate: Int): DefaultTrackSelector.ParametersBuilder!
Sets the minimum allowed video frame rate.
| Parameters | |
|---|---|
minVideoFrameRate: Int |
Minimum allowed video frame rate in hertz. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setMinVideoSize
@CanIgnoreReturnValue
fun setMinVideoSize(minVideoWidth: Int, minVideoHeight: Int): DefaultTrackSelector.ParametersBuilder!
Sets the minimum allowed video width and height.
| Parameters | |
|---|---|
minVideoWidth: Int |
Minimum allowed video width in pixels. |
minVideoHeight: Int |
Minimum allowed video height in pixels. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setOverrideForType
@CanIgnoreReturnValue
fun setOverrideForType(override: TrackSelectionOverride!): DefaultTrackSelector.ParametersBuilder!
Sets an override, replacing all existing overrides with the same track type.
setPreferredAudioLanguage
@CanIgnoreReturnValue
fun setPreferredAudioLanguage(preferredAudioLanguage: String?): DefaultTrackSelector.ParametersBuilder!
Sets the preferred language for audio and forced text tracks.
| Parameters | |
|---|---|
preferredAudioLanguage: String? |
Preferred audio language as an IETF BCP 47 conformant tag, or |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setPreferredAudioLanguages
@CanIgnoreReturnValue
fun setPreferredAudioLanguages(preferredAudioLanguages: Array<String!>!): DefaultTrackSelector.ParametersBuilder!
Sets the preferred languages for audio and forced text tracks.
| Parameters | |
|---|---|
preferredAudioLanguages: Array<String!>! |
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 | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setPreferredAudioMimeType
@CanIgnoreReturnValue
fun setPreferredAudioMimeType(mimeType: String?): DefaultTrackSelector.ParametersBuilder!
Sets the preferred sample MIME type for audio tracks.
| Parameters | |
|---|---|
mimeType: String? |
The preferred MIME type for audio tracks, or |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setPreferredAudioMimeTypes
@CanIgnoreReturnValue
fun setPreferredAudioMimeTypes(mimeTypes: Array<String!>!): DefaultTrackSelector.ParametersBuilder!
Sets the preferred sample MIME types for audio tracks.
| Parameters | |
|---|---|
mimeTypes: Array<String!>! |
The preferred MIME types for audio tracks in order of preference, or an empty list for no preference. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setPreferredAudioRoleFlags
@CanIgnoreReturnValue
fun setPreferredAudioRoleFlags(@C.RoleFlags preferredAudioRoleFlags: Int): DefaultTrackSelector.ParametersBuilder!
Sets the preferred C.RoleFlags for audio tracks.
| Parameters | |
|---|---|
@C.RoleFlags preferredAudioRoleFlags: Int |
Preferred audio role flags. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setPreferredTextLanguage
@CanIgnoreReturnValue
fun setPreferredTextLanguage(preferredTextLanguage: String?): DefaultTrackSelector.ParametersBuilder!
Sets the preferred language for text tracks.
| Parameters | |
|---|---|
preferredTextLanguage: String? |
Preferred text language as an IETF BCP 47 conformant tag, or |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setPreferredTextLanguageAndRoleFlagsToCaptioningManagerSettings
@CanIgnoreReturnValue
fun setPreferredTextLanguageAndRoleFlagsToCaptioningManagerSettings(
context: Context!
): DefaultTrackSelector.ParametersBuilder!
Sets the preferred language and role flags for text tracks based on the accessibility settings of CaptioningManager.
Does nothing when the CaptioningManager is disabled.
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setPreferredTextLanguages
@CanIgnoreReturnValue
fun setPreferredTextLanguages(preferredTextLanguages: Array<String!>!): DefaultTrackSelector.ParametersBuilder!
Sets the preferred languages for text tracks.
| Parameters | |
|---|---|
preferredTextLanguages: Array<String!>! |
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 | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setPreferredTextRoleFlags
@CanIgnoreReturnValue
fun setPreferredTextRoleFlags(@C.RoleFlags preferredTextRoleFlags: Int): DefaultTrackSelector.ParametersBuilder!
Sets the preferred C.RoleFlags for text tracks.
| Parameters | |
|---|---|
@C.RoleFlags preferredTextRoleFlags: Int |
Preferred text role flags. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setPreferredVideoMimeType
@CanIgnoreReturnValue
fun setPreferredVideoMimeType(mimeType: String?): DefaultTrackSelector.ParametersBuilder!
Sets the preferred sample MIME type for video tracks.
| Parameters | |
|---|---|
mimeType: String? |
The preferred MIME type for video tracks, or |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setPreferredVideoMimeTypes
@CanIgnoreReturnValue
fun setPreferredVideoMimeTypes(mimeTypes: Array<String!>!): DefaultTrackSelector.ParametersBuilder!
Sets the preferred sample MIME types for video tracks.
| Parameters | |
|---|---|
mimeTypes: Array<String!>! |
The preferred MIME types for video tracks in order of preference, or an empty list for no preference. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setPreferredVideoRoleFlags
@CanIgnoreReturnValue
fun setPreferredVideoRoleFlags(@C.RoleFlags preferredVideoRoleFlags: Int): DefaultTrackSelector.ParametersBuilder!
Sets the preferred C.RoleFlags for video tracks.
| Parameters | |
|---|---|
@C.RoleFlags preferredVideoRoleFlags: Int |
Preferred video role flags. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setPrioritizeImageOverVideoEnabled
@CanIgnoreReturnValue
fun setPrioritizeImageOverVideoEnabled(
isPrioritizeImageOverVideoEnabled: Boolean
): DefaultTrackSelector.ParametersBuilder!
Sets whether an image track would be selected over a video track if both are available.
| Parameters | |
|---|---|
isPrioritizeImageOverVideoEnabled: Boolean |
Whether an image track would be selected over a video track if both are available. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setRendererDisabled
@CanIgnoreReturnValue
fun setRendererDisabled(rendererIndex: Int, disabled: Boolean): DefaultTrackSelector.ParametersBuilder!
Sets whether the renderer at the specified index is disabled. Disabling a renderer prevents the selector from selecting any tracks for it.
| Parameters | |
|---|---|
rendererIndex: Int |
The renderer index. |
disabled: Boolean |
Whether the renderer is disabled. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setSelectUndeterminedTextLanguage
@CanIgnoreReturnValue
fun setSelectUndeterminedTextLanguage(
selectUndeterminedTextLanguage: Boolean
): DefaultTrackSelector.ParametersBuilder!
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: Boolean |
Whether a text track with undetermined language should be selected if no preferred language track is available. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setSelectionOverride
@CanIgnoreReturnValue
funsetSelectionOverride(
rendererIndex: Int,
groups: TrackGroupArray!,
override: DefaultTrackSelector.SelectionOverride?
): DefaultTrackSelector.ParametersBuilder!
Overrides the track selection for the renderer at the specified index.
When the TrackGroupArray mapped to the renderer matches the one provided, the override is applied. When the TrackGroupArray does not match, the override has no effect. The override replaces any previous override for the specified TrackGroupArray for the specified Renderer.
Passing a null override will cause the renderer to be disabled when the mapped to it matches the one provided. When the TrackGroupArray does not match a null override has no effect. Hence a null override differs from disabling the renderer using setRendererDisabled because the renderer is disabled conditionally on the TrackGroupArray mapped to it, where-as setRendererDisabled disables the renderer unconditionally.
To remove overrides use clearSelectionOverride, clearSelectionOverrides or clearSelectionOverrides.
| Parameters | |
|---|---|
rendererIndex: Int |
The renderer index. |
groups: TrackGroupArray! |
The |
override: DefaultTrackSelector.SelectionOverride? |
The override. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setTrackTypeDisabled
@CanIgnoreReturnValue
fun setTrackTypeDisabled(@C.TrackType trackType: Int, disabled: Boolean): DefaultTrackSelector.ParametersBuilder!
Sets whether a track type is disabled. If disabled, no tracks of the specified type will be selected for playback.
| Parameters | |
|---|---|
@C.TrackType trackType: Int |
The track type. |
disabled: Boolean |
Whether the track type should be disabled. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setTunnelingEnabled
@CanIgnoreReturnValue
fun setTunnelingEnabled(tunnelingEnabled: Boolean): DefaultTrackSelector.ParametersBuilder!
Sets whether to enable tunneling if possible. Tunneling will only be enabled if it's supported by the audio and video renderers for the selected tracks.
Tunneling is known to have many device specific issues and limitations. Manual testing is strongly recommended to check that the media plays correctly when this option is enabled. See:
| Parameters | |
|---|---|
tunnelingEnabled: Boolean |
Whether to enable tunneling if possible. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setViewportSize
@CanIgnoreReturnValue
fun setViewportSize(
viewportWidth: Int,
viewportHeight: Int,
viewportOrientationMayChange: Boolean
): DefaultTrackSelector.ParametersBuilder!
Sets the viewport size to constrain adaptive video selections so that only tracks suitable for the viewport are selected.
| Parameters | |
|---|---|
viewportWidth: Int |
Viewport width in pixels. |
viewportHeight: Int |
Viewport height in pixels. |
viewportOrientationMayChange: Boolean |
Whether the viewport orientation may change during playback. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
setViewportSizeToPhysicalDisplaySize
@CanIgnoreReturnValue
fun setViewportSizeToPhysicalDisplaySize(
context: Context!,
viewportOrientationMayChange: Boolean
): DefaultTrackSelector.ParametersBuilder!
Equivalent to calling setViewportSize with the viewport size obtained from getCurrentDisplayModeSize.
| Parameters | |
|---|---|
context: Context! |
Any context. |
viewportOrientationMayChange: Boolean |
Whether the viewport orientation may change during playback. |
| Returns | |
|---|---|
DefaultTrackSelector.ParametersBuilder! |
This builder. |
Protected functions
set
@CanIgnoreReturnValue
protected fun set(parameters: TrackSelectionParameters!): DefaultTrackSelector.ParametersBuilder!
Overrides the value of the builder with the value of TrackSelectionParameters.