com.google.android.exoplayer2.trackselection

Class MappingTrackSelector

java.lang.Object

com.google.android.exoplayer2.trackselection.TrackSelector

com.google.android.exoplayer2.trackselection.MappingTrackSelector

Direct Known Subclasses:

DefaultTrackSelector

public abstract class MappingTrackSelector
extends TrackSelector

Base class for TrackSelectors that first establish a mapping between TrackGroups and Renderers, and then from that mapping create a TrackSelection for each renderer.

Track overrides

Mapping track selectors support overriding of track selections for each renderer. To specify an override for a renderer it's first necessary to obtain the tracks that have been mapped to it:

 
 MappedTrackInfo mappedTrackInfo = trackSelector.getCurrentMappedTrackInfo();
 TrackGroupArray rendererTrackGroups = mappedTrackInfo == null ? null
     : mappedTrackInfo.getTrackGroups(rendererIndex);
 

If rendererTrackGroups is null then there aren't any currently mapped tracks, and so setting an override isn't possible. Note that a Player.EventListener registered on the player can be used to determine when the current tracks (and therefore the mapping) changes. If rendererTrackGroups is non-null then an override can be set. The next step is to query the properties of the available tracks to determine the groupIndex of the track group you want to select and the trackIndices within it. You can then create and set the override:

 
 trackSelector.setSelectionOverride(rendererIndex, rendererTrackGroups,
     new SelectionOverride(trackSelectionFactory, groupIndex, trackIndices));
 

where trackSelectionFactory is a TrackSelection.Factory for generating concrete TrackSelection instances for the override. It's also possible to pass null as the selection override if you don't want any tracks to be selected.

Note that an override applies only when the track groups available to the renderer match the TrackGroupArray for which the override was specified. Overrides can be cleared using the clearSelectionOverride methods.

Disabling renderers

Renderers can be disabled using setRendererDisabled(int, boolean). Disabling a renderer differs from setting a null override because the renderer is disabled unconditionally, whereas a null override is applied only when the track groups available to the renderer match the TrackGroupArray for which it was specified.

Tunneling

Tunneled playback can be enabled in cases where the combination of renderers and selected tracks support it. See setTunnelingAudioSessionId(int) for more details.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MappingTrackSelector.MappedTrackInfo Provides mapped track information for each renderer.
static class	MappingTrackSelector.SelectionOverride A track selection override.

Nested classes/interfaces inherited from class com.google.android.exoplayer2.trackselection.TrackSelector

TrackSelector.InvalidationListener

Constructor Summary

Constructors

Constructor and Description
MappingTrackSelector()

Method Summary

Modifier and Type	Method and Description
void	clearSelectionOverride(int rendererIndex, TrackGroupArray groups) Clears a track selection override for the specified renderer and TrackGroupArray.
void	clearSelectionOverrides() Clears all track selection overrides for all renderers.
void	clearSelectionOverrides(int rendererIndex) Clears all track selection overrides for the specified renderer.
MappingTrackSelector.MappedTrackInfo	getCurrentMappedTrackInfo() Returns the mapping information for the currently active track selection, or null if no selection is currently active.
boolean	getRendererDisabled(int rendererIndex) Returns whether the renderer is disabled.
MappingTrackSelector.SelectionOverride	getSelectionOverride(int rendererIndex, TrackGroupArray groups) Returns the override for the specified renderer and TrackGroupArray.
boolean	hasSelectionOverride(int rendererIndex, TrackGroupArray groups) Returns whether there is an override for the specified renderer and TrackGroupArray.
void	onSelectionActivated(java.lang.Object info) Called by the player when a TrackSelectorResult previously generated by TrackSelector.selectTracks(RendererCapabilities[], TrackGroupArray) is activated.
TrackSelectorResult	selectTracks(RendererCapabilities[] rendererCapabilities, TrackGroupArray trackGroups) Called by the player to perform a track selection.
protected abstract TrackSelection[]	selectTracks(RendererCapabilities[] rendererCapabilities, TrackGroupArray[] rendererTrackGroupArrays, int[][][] rendererFormatSupports) Given an array of renderer capabilities and the TrackGroupArrays mapped to each of them, provides a TrackSelection per renderer.
void	setRendererDisabled(int rendererIndex, boolean disabled) Sets whether the renderer at the specified index is disabled.
void	setSelectionOverride(int rendererIndex, TrackGroupArray groups, MappingTrackSelector.SelectionOverride override) Overrides the track selection for the renderer at the specified index.
void	setTunnelingAudioSessionId(int tunnelingAudioSessionId) Enables or disables tunneling.

Methods inherited from class com.google.android.exoplayer2.trackselection.TrackSelector

init, invalidate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MappingTrackSelector

public MappingTrackSelector()

Method Detail

getCurrentMappedTrackInfo

public final MappingTrackSelector.MappedTrackInfo getCurrentMappedTrackInfo()

Returns the mapping information for the currently active track selection, or null if no selection is currently active.

setRendererDisabled

public final void setRendererDisabled(int rendererIndex,
                                      boolean disabled)

Sets whether the renderer at the specified index is disabled. Disabling a renderer prevents the selector from selecting any tracks for it.

Parameters:

rendererIndex - The renderer index.

disabled - Whether the renderer is disabled.

getRendererDisabled

public final boolean getRendererDisabled(int rendererIndex)

Returns whether the renderer is disabled.

Parameters:

rendererIndex - The renderer index.

Returns:

Whether the renderer is disabled.

setSelectionOverride

public final void setSelectionOverride(int rendererIndex,
                                       TrackGroupArray groups,
                                       MappingTrackSelector.SelectionOverride override)

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 TrackGroupArray 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(int, boolean) because the renderer is disabled conditionally on the TrackGroupArray mapped to it, where-as setRendererDisabled(int, boolean) disables the renderer unconditionally.

To remove overrides use clearSelectionOverride(int, TrackGroupArray), clearSelectionOverrides(int) or clearSelectionOverrides().

Parameters:

rendererIndex - The renderer index.

groups - The TrackGroupArray for which the override should be applied.

override - The override.

hasSelectionOverride

public final boolean hasSelectionOverride(int rendererIndex,
                                          TrackGroupArray groups)

Returns whether there is an override for the specified renderer and TrackGroupArray.

Parameters:

rendererIndex - The renderer index.

groups - The TrackGroupArray.

Returns:

Whether there is an override.

getSelectionOverride

public final MappingTrackSelector.SelectionOverride getSelectionOverride(int rendererIndex,
                                                                         TrackGroupArray groups)

Returns the override for the specified renderer and TrackGroupArray.

Parameters:

rendererIndex - The renderer index.

groups - The TrackGroupArray.

Returns:

The override, or null if no override exists.

clearSelectionOverride

public final void clearSelectionOverride(int rendererIndex,
                                         TrackGroupArray groups)

Clears a track selection override for the specified renderer and TrackGroupArray.

Parameters:

rendererIndex - The renderer index.

groups - The TrackGroupArray for which the override should be cleared.

clearSelectionOverrides

public final void clearSelectionOverrides(int rendererIndex)

Clears all track selection overrides for the specified renderer.

Parameters:

rendererIndex - The renderer index.

clearSelectionOverrides

public final void clearSelectionOverrides()

Clears all track selection overrides for all renderers.

setTunnelingAudioSessionId

public void setTunnelingAudioSessionId(int tunnelingAudioSessionId)

Enables or disables tunneling. To enable tunneling, pass an audio session id to use when in tunneling mode. Session ids can be generated using C.generateAudioSessionIdV21(Context). To disable tunneling pass C.AUDIO_SESSION_ID_UNSET. Tunneling will only be activated if it's both enabled and supported by the audio and video renderers for the selected tracks.

Parameters:

tunnelingAudioSessionId - The audio session id to use when tunneling, or C.AUDIO_SESSION_ID_UNSET to disable tunneling.

selectTracks

public final TrackSelectorResult selectTracks(RendererCapabilities[] rendererCapabilities,
                                              TrackGroupArray trackGroups)
                                       throws ExoPlaybackException

Description copied from class: TrackSelector

Called by the player to perform a track selection.

Specified by:

selectTracks in class TrackSelector

Parameters:

rendererCapabilities - The RendererCapabilities of the renderers for which tracks are to be selected.

trackGroups - The available track groups.

Returns:

A TrackSelectorResult describing the track selections.

Throws:

ExoPlaybackException - If an error occurs selecting tracks.

onSelectionActivated

public final void onSelectionActivated(java.lang.Object info)

Description copied from class: TrackSelector

Called by the player when a TrackSelectorResult previously generated by TrackSelector.selectTracks(RendererCapabilities[], TrackGroupArray) is activated.

Specified by:

onSelectionActivated in class TrackSelector

Parameters:

info - The value of TrackSelectorResult.info in the activated selection.

selectTracks

protected abstract TrackSelection[] selectTracks(RendererCapabilities[] rendererCapabilities,
                                                 TrackGroupArray[] rendererTrackGroupArrays,
                                                 int[][][] rendererFormatSupports)
                                          throws ExoPlaybackException

Given an array of renderer capabilities and the TrackGroupArrays mapped to each of them, provides a TrackSelection per renderer.

Parameters:

rendererCapabilities - The RendererCapabilities of the renderers for which TrackSelections are to be generated.

rendererTrackGroupArrays - The TrackGroupArrays mapped to each of the renderers.

rendererFormatSupports - The result of RendererCapabilities.supportsFormat(com.google.android.exoplayer2.Format) for each mapped track, indexed by renderer index, track group index and track index (in that order).

Throws:

ExoPlaybackException - If an error occurs while selecting the tracks.