Clarify Javadoc of AudioProcessor.queueInput

PiperOrigin-RevId: 425341138
This commit is contained in:
kimvde 2022-01-31 13:25:27 +00:00 committed by Andrew Lewis
parent d4eb1edff6
commit 23ef7b111e

View File

@ -104,13 +104,14 @@ public interface AudioProcessor {
boolean isActive();
/**
* Queues audio data between the position and limit of the input {@code buffer} for processing.
* {@code buffer} must be a direct byte buffer with native byte order. Its contents are treated as
* read-only. Its position will be advanced by the number of bytes consumed (which may be zero).
* The caller retains ownership of the provided buffer. Calling this method invalidates any
* previous buffer returned by {@link #getOutput()}.
* Queues audio data between the position and limit of the {@code inputBuffer} for processing.
* After calling this method, processed output may be available via {@link #getOutput()}. Calling
* {@code queueInput(ByteBuffer)} again invalidates any pending output.
*
* @param inputBuffer The input buffer to process.
* @param inputBuffer The input buffer to process. It must be a direct byte buffer with native
* byte order. Its contents are treated as read-only. Its position will be advanced by the
* number of bytes consumed (which may be zero). The caller retains ownership of the provided
* buffer.
*/
void queueInput(ByteBuffer inputBuffer);