FrameWriterToHardwareBufferFrameQueueAdapter


@RequiresApi(value = 26)
@ExperimentalApi
public final class FrameWriterToHardwareBufferFrameQueueAdapter implements HardwareBufferFrameQueue


Adapts a FrameWriter to the HardwareBufferFrameQueue interface.

Summary

Public methods

@Nullable HardwareBufferFrame
dequeue(
    HardwareBufferFrameQueue.FrameFormat format,
    Runnable wakeupListener
)

Attempts to dequeue a HardwareBufferFrame matching the specified format.

void

Queues a HardwareBufferFrame for consumption by the downstream component.

void

Releases all resources associated with this instance.

void

Signals that no more frames will be queued.

Public constructors

FrameWriterToHardwareBufferFrameQueueAdapter

public FrameWriterToHardwareBufferFrameQueueAdapter(FrameWriter writer)

Public methods

dequeue

public @Nullable HardwareBufferFrame dequeue(
    HardwareBufferFrameQueue.FrameFormat format,
    Runnable wakeupListener
)

Attempts to dequeue a HardwareBufferFrame matching the specified format.

If the queue has reached its capacity and no buffers are available for reuse, this method returns null. In this case, the wakeupListener will be invoked when a buffer is eventually returned to the pool.

If this method is called multiple times without returning a frame, only the most recent wakeupListener is guaranteed to be invoked.

If a dequeued HardwareBufferFrame cannot be filled and queued back for any reason, it must be released.

Parameters
HardwareBufferFrameQueue.FrameFormat format

The required format for the dequeued buffer.

Runnable wakeupListener

A callback to notify the caller when a buffer becomes available.

Returns
@Nullable HardwareBufferFrame

A HardwareBufferFrame, or null if the queue is currently full.

queue

public void queue(HardwareBufferFrame frame)

Queues a HardwareBufferFrame for consumption by the downstream component.

The implementation is responsible for ensuring the buffer is correctly reused or released once the downstream component has finished processing it.

Parameters
HardwareBufferFrame frame

The frame to be processed.

release

public void release()

Releases all resources associated with this instance.

signalEndOfStream

public void signalEndOfStream()

Signals that no more frames will be queued.

This propagates an end-of-stream signal to the downstream consumer.