@UnstableApi
interface VideoGraph

Known direct subclasses
MultipleInputVideoGraph

A VideoGraph that handles multiple input streams.

PreviewingVideoGraph

A VideoGraph specific to previewing.

SingleInputVideoGraph

A VideoGraph that handles one input stream.

Known indirect subclasses
PreviewingSingleInputVideoGraph

A Previewing specific implementation of .


Represents a graph for processing raw video frames.

Summary

Nested types

Listener for video frame processing events.

Public functions

VideoFrameProcessor!
getProcessor(inputIndex: Int)

Returns the VideoFrameProcessor that handles the processing for an input registered via registerInput.

Boolean

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

Unit

Initialize the VideoGraph.

Unit
registerInput(inputIndex: @IntRange(from = 0) Int)

Registers a new input to the VideoGraph.

Unit

Releases the associated resources.

Unit
setOutputSurfaceInfo(outputSurfaceInfo: SurfaceInfo?)

Sets the output surface and supporting information.

Public functions

getProcessor

fun getProcessor(inputIndex: Int): VideoFrameProcessor!

Returns the VideoFrameProcessor that handles the processing for an input registered via registerInput. If the inputIndex is not registered before, this method will throw an IllegalStateException.

hasProducedFrameWithTimestampZero

fun hasProducedFrameWithTimestampZero(): Boolean

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

initialize

fun initialize(): Unit

Initialize the VideoGraph.

This method must be called before calling other methods.

If the method throws, the caller must call release.

registerInput

fun registerInput(inputIndex: @IntRange(from = 0) Int): Unit

Registers a new input to the VideoGraph.

A underlying processing VideoFrameProcessor is created every time this method is called.

All inputs must be registered before rendering frames to the underlying VideoFrameProcessor.

If the method throws, the caller must call release.

Parameters
inputIndex: @IntRange(from = 0) Int

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

release

fun release(): Unit

Releases the associated resources.

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

setOutputSurfaceInfo

fun setOutputSurfaceInfo(outputSurfaceInfo: SurfaceInfo?): Unit

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.