public final class

TrackSelectorResult

extends java.lang.Object

 java.lang.Object

↳androidx.media3.exoplayer.trackselection.TrackSelectorResult

Gradle dependencies

compile group: 'androidx.media3', name: 'media3-exoplayer', version: '1.0.0-alpha03'

  • groupId: androidx.media3
  • artifactId: media3-exoplayer
  • version: 1.0.0-alpha03

Artifact androidx.media3:media3-exoplayer:1.0.0-alpha03 it located at Google repository (https://maven.google.com/)

Overview

The result of a TrackSelector operation.

Summary

Fields
public final java.lang.Objectinfo

An opaque object that will be returned to TrackSelector.onSelectionActivated(Object) should the selections be activated.

public final intlength

The number of selections in the result.

public final RendererConfigurationrendererConfigurations

A RendererConfiguration for each renderer.

public final ExoTrackSelectionselections

A ExoTrackSelection array containing the track selection for each renderer.

public final TracksInfotracksInfo

Describe the tracks and which one were selected.

Constructors
publicTrackSelectorResult(RendererConfiguration rendererConfigurations[], ExoTrackSelection selections[], java.lang.Object info)

publicTrackSelectorResult(RendererConfiguration rendererConfigurations[], ExoTrackSelection selections[], TracksInfo tracksInfo, java.lang.Object info)

Methods
public booleanisEquivalent(TrackSelectorResult other)

Returns whether this result is equivalent to other for all renderers.

public booleanisEquivalent(TrackSelectorResult other, int index)

Returns whether this result is equivalent to other for the renderer at the given index.

public booleanisRendererEnabled(int index)

Returns whether the renderer at the specified index is enabled.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Fields

public final int length

The number of selections in the result. Greater than or equal to zero.

public final RendererConfiguration rendererConfigurations

A RendererConfiguration for each renderer. A null entry indicates the corresponding renderer should be disabled.

public final ExoTrackSelection selections

A ExoTrackSelection array containing the track selection for each renderer.

public final TracksInfo tracksInfo

Describe the tracks and which one were selected.

public final java.lang.Object info

An opaque object that will be returned to TrackSelector.onSelectionActivated(Object) should the selections be activated.

Constructors

public TrackSelectorResult(RendererConfiguration rendererConfigurations[], ExoTrackSelection selections[], java.lang.Object info)

Deprecated: Use TrackSelectorResult.TrackSelectorResult(RendererConfiguration[], ExoTrackSelection[], TracksInfo, Object).

Parameters:

rendererConfigurations: A RendererConfiguration for each renderer. A null entry indicates the corresponding renderer should be disabled.
selections: A ExoTrackSelection array containing the selection for each renderer.
info: An opaque object that will be returned to TrackSelector.onSelectionActivated(Object) should the selection be activated. May be null.

public TrackSelectorResult(RendererConfiguration rendererConfigurations[], ExoTrackSelection selections[], TracksInfo tracksInfo, java.lang.Object info)

Parameters:

rendererConfigurations: A RendererConfiguration for each renderer. A null entry indicates the corresponding renderer should be disabled.
selections: A ExoTrackSelection array containing the selection for each renderer.
tracksInfo: Description of the available tracks and which one were selected.
info: An opaque object that will be returned to TrackSelector.onSelectionActivated(Object) should the selection be activated. May be null.

Methods

public boolean isRendererEnabled(int index)

Returns whether the renderer at the specified index is enabled.

public boolean isEquivalent(TrackSelectorResult other)

Returns whether this result is equivalent to other for all renderers.

Parameters:

other: The other TrackSelectorResult. May be null, in which case false will be returned.

Returns:

Whether this result is equivalent to other for all renderers.

public boolean isEquivalent(TrackSelectorResult other, int index)

Returns whether this result is equivalent to other for the renderer at the given index. The results are equivalent if they have equal track selections and configurations for the renderer.

Parameters:

other: The other TrackSelectorResult. May be null, in which case false will be returned.
index: The renderer index to check for equivalence.

Returns:

Whether this result is equivalent to other for the renderer at the specified index.

Source

/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package androidx.media3.exoplayer.trackselection;

import androidx.annotation.Nullable;
import androidx.media3.common.TracksInfo;
import androidx.media3.common.util.UnstableApi;
import androidx.media3.common.util.Util;
import androidx.media3.exoplayer.RendererConfiguration;
import org.checkerframework.checker.nullness.compatqual.NullableType;

/** The result of a {@link TrackSelector} operation. */
@UnstableApi
public final class TrackSelectorResult {

  /** The number of selections in the result. Greater than or equal to zero. */
  public final int length;
  /**
   * A {@link RendererConfiguration} for each renderer. A null entry indicates the corresponding
   * renderer should be disabled.
   */
  public final @NullableType RendererConfiguration[] rendererConfigurations;
  /** A {@link ExoTrackSelection} array containing the track selection for each renderer. */
  public final @NullableType ExoTrackSelection[] selections;
  /** Describe the tracks and which one were selected. */
  public final TracksInfo tracksInfo;
  /**
   * An opaque object that will be returned to {@link TrackSelector#onSelectionActivated(Object)}
   * should the selections be activated.
   */
  @Nullable public final Object info;

  /**
   * @param rendererConfigurations A {@link RendererConfiguration} for each renderer. A null entry
   *     indicates the corresponding renderer should be disabled.
   * @param selections A {@link ExoTrackSelection} array containing the selection for each renderer.
   * @param info An opaque object that will be returned to {@link
   *     TrackSelector#onSelectionActivated(Object)} should the selection be activated. May be
   *     {@code null}.
   * @deprecated Use {@link #TrackSelectorResult(RendererConfiguration[], ExoTrackSelection[],
   *     TracksInfo, Object)}.
   */
  @Deprecated
  public TrackSelectorResult(
      @NullableType RendererConfiguration[] rendererConfigurations,
      @NullableType ExoTrackSelection[] selections,
      @Nullable Object info) {
    this(rendererConfigurations, selections, TracksInfo.EMPTY, info);
  }

  /**
   * @param rendererConfigurations A {@link RendererConfiguration} for each renderer. A null entry
   *     indicates the corresponding renderer should be disabled.
   * @param selections A {@link ExoTrackSelection} array containing the selection for each renderer.
   * @param tracksInfo Description of the available tracks and which one were selected.
   * @param info An opaque object that will be returned to {@link
   *     TrackSelector#onSelectionActivated(Object)} should the selection be activated. May be
   *     {@code null}.
   */
  public TrackSelectorResult(
      @NullableType RendererConfiguration[] rendererConfigurations,
      @NullableType ExoTrackSelection[] selections,
      TracksInfo tracksInfo,
      @Nullable Object info) {
    this.rendererConfigurations = rendererConfigurations;
    this.selections = selections.clone();
    this.tracksInfo = tracksInfo;
    this.info = info;
    length = rendererConfigurations.length;
  }

  /** Returns whether the renderer at the specified index is enabled. */
  public boolean isRendererEnabled(int index) {
    return rendererConfigurations[index] != null;
  }

  /**
   * Returns whether this result is equivalent to {@code other} for all renderers.
   *
   * @param other The other {@link TrackSelectorResult}. May be null, in which case {@code false}
   *     will be returned.
   * @return Whether this result is equivalent to {@code other} for all renderers.
   */
  public boolean isEquivalent(@Nullable TrackSelectorResult other) {
    if (other == null || other.selections.length != selections.length) {
      return false;
    }
    for (int i = 0; i < selections.length; i++) {
      if (!isEquivalent(other, i)) {
        return false;
      }
    }
    return true;
  }

  /**
   * Returns whether this result is equivalent to {@code other} for the renderer at the given index.
   * The results are equivalent if they have equal track selections and configurations for the
   * renderer.
   *
   * @param other The other {@link TrackSelectorResult}. May be null, in which case {@code false}
   *     will be returned.
   * @param index The renderer index to check for equivalence.
   * @return Whether this result is equivalent to {@code other} for the renderer at the specified
   *     index.
   */
  public boolean isEquivalent(@Nullable TrackSelectorResult other, int index) {
    if (other == null) {
      return false;
    }
    return Util.areEqual(rendererConfigurations[index], other.rendererConfigurations[index])
        && Util.areEqual(selections[index], other.selections[index]);
  }
}