@UnstableApi
public interface VideoGraph

Known direct subclasses
MultipleInputVideoGraph

A VideoGraph that handles multiple input streams.

SingleInputVideoGraph

A VideoGraph that handles one input stream.


Represents a graph for processing raw video frames.

Summary

Nested types

public interface VideoGraph.Factory

A factory for VideoGraph instances.

public interface VideoGraph.Listener

Listener for video frame processing events.

Public methods

abstract void

Flushes the inputs of the VideoGraph.

abstract Surface
getInputSurface(int inputIndex)

Returns the input Surface at inputIndex.

abstract int
getPendingInputFrameCount(int inputIndex)

Returns the number of pending input frames at inputIndex that has not been processed yet.

abstract boolean

Returns whether the VideoGraph has produced a frame with zero presentation timestamp.

abstract void

Initialize the VideoGraph.

abstract boolean
queueInputBitmap(
    int inputIndex,
    Bitmap inputBitmap,
    TimestampIterator timestampIterator
)

Queues the input Bitmap at inputIndex.

abstract boolean
queueInputTexture(
    int inputIndex,
    int textureId,
    long presentationTimeUs
)

Queues the input texture at inputIndex.

abstract void

Updates an available frame with the modified effects.

abstract void
registerInput(@IntRange(from = 0) int inputIndex)

Registers a new input to the VideoGraph.

abstract boolean
registerInputFrame(int inputIndex)

Registers a new input frame at inputIndex.

abstract void
registerInputStream(
    int inputIndex,
    @VideoFrameProcessor.InputType int inputType,
    Format format,
    List<Effect> effects,
    long offsetToAddUs
)

Informs the graph that a new input stream will be queued to the graph input corresponding to inputIndex.

abstract void

Releases the associated resources.

abstract void
renderOutputFrame(long renderTimeNs)

Renders the output frame from the VideoGraph.

abstract void
setOnInputFrameProcessedListener(
    int inputIndex,
    OnInputFrameProcessedListener listener
)

Sets the OnInputFrameProcessedListener at inputIndex.

abstract void
setOnInputSurfaceReadyListener(int inputIndex, Runnable listener)

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

abstract void

Sets the output surface and supporting information.

abstract void
signalEndOfInput(int inputIndex)

Informs that no further inputs should be accepted at inputIndex.

Public methods

flush

abstract void flush()

Flushes the inputs of the VideoGraph.

See also
flush

getInputSurface

abstract Surface getInputSurface(int inputIndex)

Returns the input Surface at inputIndex.

getPendingInputFrameCount

abstract int getPendingInputFrameCount(int inputIndex)

Returns the number of pending input frames at inputIndex that has not been processed yet.

hasProducedFrameWithTimestampZero

abstract boolean hasProducedFrameWithTimestampZero()

Returns whether the VideoGraph has produced a frame with zero presentation timestamp.

initialize

abstract void initialize()

Initialize the VideoGraph.

This method must be called before calling other methods.

If the method throws, the caller must call release.

queueInputBitmap

abstract boolean queueInputBitmap(
    int inputIndex,
    Bitmap inputBitmap,
    TimestampIterator timestampIterator
)

Queues the input Bitmap at inputIndex.

See also
queueInputBitmap

queueInputTexture

abstract boolean queueInputTexture(
    int inputIndex,
    int textureId,
    long presentationTimeUs
)

Queues the input texture at inputIndex.

redraw

abstract void redraw()

Updates an available frame with the modified effects.

registerInput

abstract void registerInput(@IntRange(from = 0) int inputIndex)

Registers a new input to the VideoGraph.

All inputs must be registered before rendering frames by calling registerInputFrame, queueInputBitmap or queueInputTexture.

If the method throws, the caller must call release.

Parameters
@IntRange(from = 0) int inputIndex

The index of the input which could be used to order the inputs. The index must start from 0.

registerInputFrame

abstract boolean registerInputFrame(int inputIndex)

Registers a new input frame at inputIndex.

registerInputStream

abstract void registerInputStream(
    int inputIndex,
    @VideoFrameProcessor.InputType int inputType,
    Format format,
    List<Effect> effects,
    long offsetToAddUs
)

Informs the graph that a new input stream will be queued to the graph input corresponding to inputIndex.

After registering the first input stream, this method must only be called for the same index 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 input stream corresponding to the same inputIndex has been fully registered internally.

Parameters
int inputIndex

The index of the input for which a new input stream should be registered. This index must start from 0.

@VideoFrameProcessor.InputType int inputType

The InputType of the new input stream.

Format format

The Format of the new input stream. The colorInfo, the width, the height and the pixelWidthHeightRatio must be set.

List<Effect> effects

The list of effects to apply to the new input stream.

long offsetToAddUs

The offset that must be added to the frame presentation timestamps, in microseconds. This offset is not part of the input timestamps. It is added to the frame timestamps before processing, and is retained in the output timestamps.

release

abstract void release()

Releases the associated resources.

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

renderOutputFrame

abstract void renderOutputFrame(long renderTimeNs)

Renders the output frame from the VideoGraph.

This method must be called only for frames that have become available, calling the method renders the frame that becomes available the earliest but not yet rendered.

setOnInputFrameProcessedListener

abstract void setOnInputFrameProcessedListener(
    int inputIndex,
    OnInputFrameProcessedListener listener
)

Sets the OnInputFrameProcessedListener at inputIndex.

setOnInputSurfaceReadyListener

abstract void setOnInputSurfaceReadyListener(int inputIndex, Runnable listener)

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

setOutputSurfaceInfo

abstract void setOutputSurfaceInfo(@Nullable SurfaceInfo outputSurfaceInfo)

Sets the output surface and supporting information.

The new output SurfaceInfo is applied from the next output frame rendered onwards. If the output SurfaceInfo is null, the VideoGraph 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.

signalEndOfInput

abstract void signalEndOfInput(int inputIndex)

Informs that no further inputs should be accepted at inputIndex.

See also
signalEndOfInput