summaryrefslogtreecommitdiffstats
path: root/mobile/android/exoplayer2/src/main/java/org/mozilla/thirdparty/com/google/android/exoplayer2/upstream/BandwidthMeter.java
diff options
context:
space:
mode:
Diffstat (limited to 'mobile/android/exoplayer2/src/main/java/org/mozilla/thirdparty/com/google/android/exoplayer2/upstream/BandwidthMeter.java')
-rw-r--r--mobile/android/exoplayer2/src/main/java/org/mozilla/thirdparty/com/google/android/exoplayer2/upstream/BandwidthMeter.java71
1 files changed, 71 insertions, 0 deletions
diff --git a/mobile/android/exoplayer2/src/main/java/org/mozilla/thirdparty/com/google/android/exoplayer2/upstream/BandwidthMeter.java b/mobile/android/exoplayer2/src/main/java/org/mozilla/thirdparty/com/google/android/exoplayer2/upstream/BandwidthMeter.java
new file mode 100644
index 0000000000..5606b45702
--- /dev/null
+++ b/mobile/android/exoplayer2/src/main/java/org/mozilla/thirdparty/com/google/android/exoplayer2/upstream/BandwidthMeter.java
@@ -0,0 +1,71 @@
+/*
+ * Copyright (C) 2016 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 org.mozilla.thirdparty.com.google.android.exoplayer2.upstream;
+
+import android.os.Handler;
+import androidx.annotation.Nullable;
+
+/**
+ * Provides estimates of the currently available bandwidth.
+ */
+public interface BandwidthMeter {
+
+ /**
+ * A listener of {@link BandwidthMeter} events.
+ */
+ interface EventListener {
+
+ /**
+ * Called periodically to indicate that bytes have been transferred or the estimated bitrate has
+ * changed.
+ *
+ * <p>Note: The estimated bitrate is typically derived from more information than just {@code
+ * bytes} and {@code elapsedMs}.
+ *
+ * @param elapsedMs The time taken to transfer {@code bytesTransferred}, in milliseconds. This
+ * is at most the elapsed time since the last callback, but may be less if there were
+ * periods during which data was not being transferred.
+ * @param bytesTransferred The number of bytes transferred since the last callback.
+ * @param bitrateEstimate The estimated bitrate in bits/sec.
+ */
+ void onBandwidthSample(int elapsedMs, long bytesTransferred, long bitrateEstimate);
+ }
+
+ /** Returns the estimated bitrate. */
+ long getBitrateEstimate();
+
+ /**
+ * Returns the {@link TransferListener} that this instance uses to gather bandwidth information
+ * from data transfers. May be null if the implementation does not listen to data transfers.
+ */
+ @Nullable
+ TransferListener getTransferListener();
+
+ /**
+ * Adds an {@link EventListener}.
+ *
+ * @param eventHandler A handler for events.
+ * @param eventListener A listener of events.
+ */
+ void addEventListener(Handler eventHandler, EventListener eventListener);
+
+ /**
+ * Removes an {@link EventListener}.
+ *
+ * @param eventListener The listener to be removed.
+ */
+ void removeEventListener(EventListener eventListener);
+}