/*
 * Copyright 2023 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
 *
 *      https://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.source.preload;

import androidx.annotation.Nullable;
import androidx.media3.common.util.UnstableApi;
import androidx.media3.exoplayer.source.MediaSource;

/** Controls the target preload status. */
@UnstableApi
public interface TargetPreloadStatusControl<T> {

  /**
   * Returns the target preload status for a source with the given {@code rankingData}. May be null
   * if a {@link MediaSource} with the given {@code rankingData} should not be preloaded.
   */
  @Nullable
  PreloadStatus getTargetPreloadStatus(T rankingData);

  /** Defines the status of the preloading for a {@link MediaSource}. */
  interface PreloadStatus {

    /** The stage of the preloading. */
    int getStage();

    /** The associated value of the preloading stage. */
    long getValue();
  }
}