Merge "media: clarify that flush() is not supported for encoders." into tm-dev

This commit is contained in:
TreeHugger Robot
2022-05-26 09:56:47 +00:00
committed by Android (Google) Code Review

View File

@@ -291,8 +291,11 @@ import java.util.concurrent.locks.ReentrantLock;
most of its life. When you queue an input buffer with the {@linkplain #BUFFER_FLAG_END_OF_STREAM most of its life. When you queue an input buffer with the {@linkplain #BUFFER_FLAG_END_OF_STREAM
end-of-stream marker}, the codec transitions to the End-of-Stream sub-state. In this state the end-of-stream marker}, the codec transitions to the End-of-Stream sub-state. In this state the
codec no longer accepts further input buffers, but still generates output buffers until the codec no longer accepts further input buffers, but still generates output buffers until the
end-of-stream is reached on the output. You can move back to the Flushed sub-state at any time end-of-stream is reached on the output. For decoders, you can move back to the Flushed sub-state
while in the Executing state using {@link #flush}. at any time while in the Executing state using {@link #flush}.
<p class=note>
<strong>Note:</strong> Going back to Flushed state is only supported for decoders, and may not
work for encoders (the behavior is undefined).
<p> <p>
Call {@link #stop} to return the codec to the Uninitialized state, whereupon it may be configured Call {@link #stop} to return the codec to the Uninitialized state, whereupon it may be configured
again. When you are done using a codec, you must release it by calling {@link #release}. again. When you are done using a codec, you must release it by calling {@link #release}.