DefaultGlFrameProcessor

@ExperimentalApi
@RequiresApi(value = 26)
public final class DefaultGlFrameProcessor implements FrameProcessor

A FrameProcessor implementation that executes a chain of GlTextureFrameConsumers.

Summary

Nested types

A FrameProcessor.Factory that creates DefaultGlFrameProcessor instances.

Constants
static final String
KEY_EFFECTS = "KEY_EFFECTS"

Metadata key for storing the List of video effects, in frame metadata
static final String
KEY_FRAME_DISCONTINUITY_NUMBER = "KEY_FRAME_DISCONTINUITY_NUMBER"

Metadata key for storing the frame discontinuity number, in getMetadata and getMetadata.

Public methods
void

Blocks until all resources are released.
boolean

Attempts to queue a List of frames for processing.
void

Notifies this processor that the current stream has ended.

Inherited methods
From java.lang.AutoCloseable
abstract void

Constants

KEY_EFFECTS

public static final String KEY_EFFECTS = "KEY_EFFECTS"

Metadata key for storing the List of video effects, in frame metadata

KEY_FRAME_DISCONTINUITY_NUMBER

public static final String KEY_FRAME_DISCONTINUITY_NUMBER = "KEY_FRAME_DISCONTINUITY_NUMBER"

Metadata key for storing the frame discontinuity number, in getMetadata and getMetadata.

The number is an integer, incremented every time the player reports a discontinuity (for example, when seeking).

The number is only mandatory for previewing use cases. It is used to trigger flushes in GlShaderProgram implementations during discontinuities.

Public methods

close

public void close()

Blocks until all resources are released.

queue

public boolean queue(List<AsyncFrame> frames)

Attempts to queue a List of frames for processing.

All frames provided in a single invocation of this method represent the exact same point in time.

If this consumer is at capacity, this method returns false and the onWakeup will be invoked when capacity becomes available.

If this method returns true, onFrameProcessed must be called once with every input frame instance queued, once the FrameProcessor has finished processing the frames.

Parameters
List<AsyncFrame> frames

The frames to queue.
Returns
boolean

true if the frames were queued, false if the consumer is at capacity.

signalEndOfStream

public void signalEndOfStream()

Notifies this processor that the current stream has ended.

More frames may be queued after calling this method, if the current stream changes.