PacketConsumerToFrameProcessorAdapter


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


Adapts a RenderingPacketConsumer to the FrameProcessor interface.

Summary

Public constructors

PacketConsumerToFrameProcessorAdapter(
    PacketConsumer<ImmutableList<HardwareBufferFrame>> packetConsumer,
    Executor listenerExecutor,
    FrameProcessor.Listener listener
)

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

Public constructors

PacketConsumerToFrameProcessorAdapter

public PacketConsumerToFrameProcessorAdapter(
    PacketConsumer<ImmutableList<HardwareBufferFrame>> packetConsumer,
    Executor listenerExecutor,
    FrameProcessor.Listener listener
)

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.