Commit 241a3426 by ibaker Committed by Ian Baker

Tighten the documentation of MetadataInputDecoder

Document that limit() is respected, but position() and arrayOffset()
are assumed to be zero.

PiperOrigin-RevId: 285384613
parent 412db200
...@@ -16,6 +16,7 @@ ...@@ -16,6 +16,7 @@
package com.google.android.exoplayer2.metadata; package com.google.android.exoplayer2.metadata;
import androidx.annotation.Nullable; import androidx.annotation.Nullable;
import java.nio.ByteBuffer;
/** /**
* Decodes metadata from binary data. * Decodes metadata from binary data.
...@@ -25,6 +26,9 @@ public interface MetadataDecoder { ...@@ -25,6 +26,9 @@ public interface MetadataDecoder {
/** /**
* Decodes a {@link Metadata} element from the provided input buffer. * Decodes a {@link Metadata} element from the provided input buffer.
* *
* <p>Respects {@link ByteBuffer#limit()} of {@code inputBuffer.data}, but assumes {@link
* ByteBuffer#position()} and {@link ByteBuffer#arrayOffset()} are both zero.
*
* @param inputBuffer The input buffer to decode. * @param inputBuffer The input buffer to decode.
* @return The decoded metadata object, or null if the metadata could not be decoded. * @return The decoded metadata object, or null if the metadata could not be decoded.
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment