# FakeFrameWriter

Artifact: [androidx.media3:media3-test-utils](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/test/utils/FakeFrameWriter.java+class:androidx.media3.test.utils.FakeFrameWriter)

*** ** * ** ***


```
@RequiresApi(value = 26)
@ExperimentalApi
public class FakeFrameWriter implements FrameWriter
```

<br />

*** ** * ** ***

A fake `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter` implementation for testing.

## Summary

| ### Public fields |
|---|---|
| `volatile @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/common/Format` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#configuredFormat()` |
| `final https://developer.android.com/reference/java/util/concurrent/CountDownLatch.html` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#configuredLatch()` |
| `final https://developer.android.com/reference/java/util/concurrent/CountDownLatch.html` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#dequeueAttemptedLatch()` |
| `final https://developer.android.com/reference/java/util/concurrent/CountDownLatch.html` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#eosLatch()` |
| `final https://developer.android.com/reference/java/util/concurrent/atomic/AtomicBoolean.html` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#eosSignaled()` |
| `volatile https://developer.android.com/reference/java/util/concurrent/CountDownLatch.html` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#frameLatch()` |
| `final https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/media3/common/video/Frame>` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#queuedFrames()` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#FakeFrameWriter()()` Creates a new instance. |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#close()()` Blocks until all resources are released. |
| `void` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#configure(androidx.media3.common.Format,long)(https://developer.android.com/reference/androidx/media3/common/Format format, @https://developer.android.com/reference/androidx/media3/common/video/Frame.Usage long usage)` Format and usage support can be `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter.Info#isSupported(androidx.media3.common.Format,long)` on the `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter.Info` before configuring. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/common/video/AsyncFrame` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#dequeueInputFrame(java.util.concurrent.Executor,java.lang.Runnable)(https://developer.android.com/reference/java/util/concurrent/Executor.html wakeupExecutor, https://developer.android.com/reference/java/lang/Runnable.html wakeupListener)` Dequeues an `https://developer.android.com/reference/androidx/media3/common/video/AsyncFrame` storing a `https://developer.android.com/reference/androidx/media3/common/video/Frame` of the `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter#configure(androidx.media3.common.Format,long)` format and usage, and a `https://developer.android.com/reference/androidx/media3/common/video/SyncFenceWrapper` that must be waited on before filling the frame. |
| `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter.Info` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#getInfo()()` Returns the `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter.Info` for this FrameWriter. |
| `void` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#prepareInputFrame(androidx.media3.common.video.Frame)(https://developer.android.com/reference/androidx/media3/common/video/Frame frame)` Makes a frame available to be returned by the next `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#dequeueInputFrame(java.util.concurrent.Executor,java.lang.Runnable)` call. |
| `void` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#queueInputFrame(androidx.media3.common.video.Frame,androidx.media3.common.video.SyncFenceWrapper)( https://developer.android.com/reference/androidx/media3/common/video/Frame frame, @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/common/video/SyncFenceWrapper writeCompleteFence )` Queues a filled frame for further processing. |
| `void` | `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#signalEndOfStream()()` Notifies this `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter` that the current stream has ended. |

### Inherited methods

From [java.lang.AutoCloseable](https://developer.android.com/reference/java/lang/AutoCloseable.html) `abstract void` `https://developer.android.com/reference/java/lang/AutoCloseable.html#close()()`

## Public fields

### configuredFormat

```
volatile public @Nullable Format configuredFormat
```

### configuredLatch

```
public final CountDownLatch configuredLatch
```

### dequeueAttemptedLatch

```
public final CountDownLatch dequeueAttemptedLatch
```

### eosLatch

```
public final CountDownLatch eosLatch
```

### eosSignaled

```
public final AtomicBoolean eosSignaled
```

### frameLatch

```
volatile public CountDownLatch frameLatch
```

### queuedFrames

```
public final List<Frame> queuedFrames
```

## Public constructors

### FakeFrameWriter

```
public FakeFrameWriter()
```

Creates a new instance.

## Public methods

### close

```
public void close()
```

Blocks until all resources are released.

### configure

```
public void configure(Format format, @Frame.Usage long usage)
```

Format and usage support can be `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter.Info#isSupported(androidx.media3.common.Format,long)` on the `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter.Info` before configuring.

Must be called before `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter#dequeueInputFrame(java.util.concurrent.Executor,java.lang.Runnable)`.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/media3/common/Format format` | The format to configure. |
| `@https://developer.android.com/reference/androidx/media3/common/video/Frame.Usage long usage` | The `@FrameUsage` flags describing how the frame will be used. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException.html` | if any frames are dequeued at the point this method is called. |
| `https://developer.android.com/reference/java/lang/IllegalArgumentException.html` | if the format or usage is unsupported. |

### dequeueInputFrame

```
public @Nullable AsyncFrame dequeueInputFrame(Executor wakeupExecutor, Runnable wakeupListener)
```

Dequeues an `https://developer.android.com/reference/androidx/media3/common/video/AsyncFrame` storing a `https://developer.android.com/reference/androidx/media3/common/video/Frame` of the `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter#configure(androidx.media3.common.Format,long)` format and usage, and a `https://developer.android.com/reference/androidx/media3/common/video/SyncFenceWrapper` that must be waited on before filling the frame.

The returned frame must be filled and `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter#queueInputFrame(androidx.media3.common.video.Frame,androidx.media3.common.video.SyncFenceWrapper)` back for processing.

If the `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter` is at capacity, this method returns null and will notify the listener when capacity is available, and it can be called again.

Only the most recent `wakeupListener` will be notified when capacity is available.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/util/concurrent/Executor.html wakeupExecutor` | The `https://developer.android.com/reference/java/util/concurrent/Executor.html` on which the `wakeupListener` is invoked. |
| `https://developer.android.com/reference/java/lang/Runnable.html wakeupListener` | A `https://developer.android.com/reference/java/lang/Runnable.html` to be invoked when capacity becomes available. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/common/video/AsyncFrame` | The dequeued frame, or null if the writer is at capacity. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException.html` | if `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter#configure(androidx.media3.common.Format,long)` has not been called. |

### getInfo

```
public FrameWriter.Info getInfo()
```

Returns the `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter.Info` for this FrameWriter.

### prepareInputFrame

```
public void prepareInputFrame(Frame frame)
```

Makes a frame available to be returned by the next `https://developer.android.com/reference/androidx/media3/test/utils/FakeFrameWriter#dequeueInputFrame(java.util.concurrent.Executor,java.lang.Runnable)` call.

### queueInputFrame

```
public void queueInputFrame(
    Frame frame,
    @Nullable SyncFenceWrapper writeCompleteFence
)
```

Queues a filled frame for further processing.

The queued frame must have been previously `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter#dequeueInputFrame(java.util.concurrent.Executor,java.lang.Runnable)` from this writer.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/media3/common/video/Frame frame` | The filled frame to queue. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/common/video/SyncFenceWrapper writeCompleteFence` | A `https://developer.android.com/reference/androidx/media3/common/video/SyncFenceWrapper` that will signal when the caller has finished writing to the frame, or `null` if the write was synchronous. |

### signalEndOfStream

```
public void signalEndOfStream()
```

Notifies this `https://developer.android.com/reference/androidx/media3/common/video/FrameWriter` that the current stream has ended.

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