VideoFrameProcessor

const val DROP_OUTPUT_FRAME = -2: Long

Indicates the frame should be dropped after renderOutputFrame is invoked.

const val INPUT_TYPE_BITMAP = 2: Int

Input frames come from a Bitmap.

const val INPUT_TYPE_SURFACE = 1: Int

Input frames come from a surface.

When receiving input from a Surface, the caller must register input frames before rendering them to the input Surface.

const val INPUT_TYPE_SURFACE_AUTOMATIC_FRAME_REGISTRATION = 4: Int

Input frames come from the input surface and don't need to be registered (unlike with INPUT_TYPE_SURFACE).

Every frame must use the input stream's registered frame info. Also sets the surface's default buffer size.

const val INPUT_TYPE_TEXTURE_ID = 3: Int

Input frames come from a traditional GLES texture.

const val RENDER_OUTPUT_FRAME_IMMEDIATELY = -1: Long

Indicates the frame should be rendered immediately after renderOutputFrame is invoked.

const val RENDER_OUTPUT_FRAME_WITH_PRESENTATION_TIME = -3: Long

Indicates the frame should preserve the input presentation time when renderOutputFrame is invoked.

fun flush(): Unit

Flushes the VideoFrameProcessor.

All the frames that are registered prior to calling this method are no longer considered to be registered when this method returns.

Listener methods invoked prior to calling this method should be ignored.

fun getInputSurface(): Surface!

Returns the input Surface, where VideoFrameProcessor consumes input frames from.

The frames arriving on the Surface will not be consumed by the VideoFrameProcessor until registerInputStream is called with INPUT_TYPE_SURFACE.

For streams with INPUT_TYPE_SURFACE, the returned surface is ready to use immediately and will not have a default buffer size set on it. This is suitable for configuring a decoder.

For streams with INPUT_TYPE_SURFACE_AUTOMATIC_FRAME_REGISTRATION, set a listener for the surface becoming ready via setOnInputSurfaceReadyListener and wait for the event before using the returned surface. This is suitable for use with non-decoder producers like media projection.

fun getPendingInputFrameCount(): Int

Returns the number of input frames that have been made available to the VideoFrameProcessor but have not been processed yet.

fun queueInputBitmap(
    inputBitmap: Bitmap!,
    timestampIterator: TimestampIterator!
): Boolean

Provides an input Bitmap to the VideoFrameProcessor.

Can be called many times after registering the input stream to put multiple frames in the same input stream.

fun queueInputTexture(textureId: Int, presentationTimeUs: Long): Boolean

Provides an input texture ID to the VideoFrameProcessor.

It must be only called after setOnInputFrameProcessedListener and registerInputStream have been called.

fun registerInputFrame(): Boolean

Informs the VideoFrameProcessor that a frame will be queued to its input surface.

Must be called before rendering a frame to the input surface. The caller must not render frames to the input surface when false is returned.

fun registerInputStream(
    @VideoFrameProcessor.InputType inputType: Int,
    effects: (Mutable)List<Effect!>!,
    frameInfo: FrameInfo!
): Unit

Informs the VideoFrameProcessor that a new input stream will be queued with the list of Effects to apply to the new input stream.

After registering the first input stream, this method must only be called after the last frame of the already-registered input stream has been registered, last bitmap queued or last texture id queued.

This method blocks the calling thread until the previous calls to this method finish, that is when onInputStreamRegistered is called after the underlying processing pipeline has been adapted to the registered input stream.

fun release(): Unit

Releases all resources.

If the VideoFrameProcessor is released before it has ended, it will attempt to cancel processing any input frames that have already become available. Input frames that become available after release are ignored.

This method blocks until all resources are released or releasing times out.

This VideoFrameProcessor instance must not be used after this method is called.

fun renderOutputFrame(renderTimeNs: Long): Unit

Renders the oldest unrendered output frame that has become available for rendering at the given renderTimeNs.

This will either render the output frame to the output surface, or drop the frame, per renderTimeNs.

This method must only be called if renderFramesAutomatically was set to false using the Factory and should be called exactly once for each frame that becomes available for rendering.

The renderTimeNs may be passed to eglPresentationTimeANDROID depending on the implementation.

fun setOnInputFrameProcessedListener(
    listener: OnInputFrameProcessedListener!
): Unit

Sets the OnInputFrameProcessedListener.

fun setOnInputSurfaceReadyListener(listener: Runnable!): Unit

Sets a listener that's called when the input surface is ready to use.

fun setOutputSurfaceInfo(outputSurfaceInfo: SurfaceInfo?): Unit

Sets the output surface and supporting information. When output frames are rendered and not dropped, they will be rendered to this output SurfaceInfo.

The new output SurfaceInfo is applied from the next output frame rendered onwards. If the output SurfaceInfo is null, the VideoFrameProcessor will stop rendering pending frames and resume rendering once a non-null SurfaceInfo is set.

If the dimensions given in SurfaceInfo do not match the output size after applying the final effect the frames are resized before rendering to the surface and letter/pillar-boxing is applied.

The caller is responsible for tracking the lifecycle of the surface including calling this method with a new surface if it is destroyed. When this method returns, the previous output surface is no longer being used and can safely be released by the caller.

fun signalEndOfInput(): Unit

Informs the VideoFrameProcessor that no further input frames should be accepted.