Improve Javadoc of VideoSink.registerInputFrame/queueBitmap

Document that the stream must be registered before

PiperOrigin-RevId: 648648650
This commit is contained in:
kimvde 2024-07-02 02:47:48 -07:00 committed by Copybara-Service
parent 03a205f220
commit a2087ba5bb

View File

@ -238,7 +238,8 @@ public interface VideoSink {
* Informs the video sink that a frame will be queued to its {@linkplain #getInputSurface() input * Informs the video sink that a frame will be queued to its {@linkplain #getInputSurface() input
* surface}. * surface}.
* *
* <p>Must be called after the sink is {@linkplain #initialize(Format) initialized}. * <p>Must be called after the corresponding stream is {@linkplain #registerInputStream(int,
* Format) registered}.
* *
* @param framePresentationTimeUs The frame's presentation time, in microseconds. * @param framePresentationTimeUs The frame's presentation time, in microseconds.
* @param isLastFrame Whether this is the last frame of the video stream. * @param isLastFrame Whether this is the last frame of the video stream.
@ -251,7 +252,8 @@ public interface VideoSink {
/** /**
* Provides an input {@link Bitmap} to the video sink. * Provides an input {@link Bitmap} to the video sink.
* *
* <p>Must be called after the sink is {@linkplain #initialize(Format) initialized}. * <p>Must be called after the corresponding stream is {@linkplain #registerInputStream(int,
* Format) registered}.
* *
* @param inputBitmap The {@link Bitmap} queued to the video sink. * @param inputBitmap The {@link Bitmap} queued to the video sink.
* @param timestampIterator The times within the current stream that the bitmap should be shown * @param timestampIterator The times within the current stream that the bitmap should be shown