FakeFrameProcessor

Artifact: androidx.media3:media3-test-utils

View Source

---

Kotlin |Java

@ExperimentalApi
class FakeFrameProcessor : FrameProcessor

---

A fake FrameProcessor implementation.

Summary

Nested types
class FakeFrameProcessor.Factory : FrameProcessor.Factory A factory for FakeFrameProcessor implementations.
class FakeFrameProcessor.Listener : FrameProcessor.Listener A fake FrameProcessor.Listener implementation for tests.

Public functions
Unit	close() Blocks until all resources are released.
Boolean	queue(frames: (Mutable)List<AsyncFrame!>!) Attempts to queue a List of frames for processing.
Unit	signalEndOfStream() Notifies this processor that the current stream has ended.
Unit	triggerError(exception: VideoFrameProcessingException!) Simulates a video frame processing error by notifying the listener.

Public properties
AtomicBoolean!	closed
AtomicBoolean!	eosSignaled
FrameWriter!	output
Int	queuedFramesCount

Inherited functions
From java.lang.AutoCloseable abstract Unit close()

Public functions

close

fun close(): Unit

Blocks until all resources are released.

queue

fun queue(frames: (Mutable)List<AsyncFrame!>!): Boolean

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
frames: (Mutable)List<AsyncFrame!>!	The frames to queue.

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

signalEndOfStream

fun signalEndOfStream(): Unit

Notifies this processor that the current stream has ended.

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

triggerError

fun triggerError(exception: VideoFrameProcessingException!): Unit

Simulates a video frame processing error by notifying the listener.

Public properties

closed

val closed: AtomicBoolean!

eosSignaled

val eosSignaled: AtomicBoolean!

output

val output: FrameWriter!

queuedFramesCount

val queuedFramesCount: Int