FakeFrameProcessor

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

A no-op FrameProcessor that holds a reference to all queued frames for testing.

Summary

Nested types

Marker class representing a signalEndOfStream call.
public interface FakeFrameProcessor.Event

Marker interface for ordering frames and EOS signals.

A factory for FakeFrameProcessor implementations.

Holds the frames queued in a queue call.

Public fields
@Nullable List<AsyncFrame>

Public methods
void

Blocks until all resources are released.
ImmutableList<ImmutableList<Long>>

Returns an ImmutableList of content timestamps for all queued frames.
ImmutableList<FakeFrameProcessor.Event>

Returns an ImmutableList of all queued events.
boolean

Returns true if the last Event queued was an EosEvent.
boolean

Attempts to queue a List of frames for processing.
void

Notifies this processor that the current stream has ended.
void

Simulates a video frame processing error by notifying the listener.

Inherited methods
From java.lang.AutoCloseable
abstract void

Public fields

lastFrames

public @Nullable List<AsyncFrame> lastFrames

Public methods

close

public void close()

Blocks until all resources are released.

getQueuedContentTimesUs

public ImmutableList<ImmutableList<Long>> getQueuedContentTimesUs()

Returns an ImmutableList of content timestamps for all queued frames. EOS frames return TIME_UNSET.

getQueuedEvents

public ImmutableList<FakeFrameProcessor.Event> getQueuedEvents()

Returns an ImmutableList of all queued events.

isEnded

public boolean isEnded()

Returns true if the last Event queued was an EosEvent.

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.

triggerError

public void triggerError(VideoFrameProcessingException exception)

Simulates a video frame processing error by notifying the listener.