VideoFrameAggregationParameters.Builder


class VideoFrameAggregationParameters.Builder


A builder for VideoFrameAggregationParameters instances.

Summary

Public constructors

Creates a new instance.

Public functions

VideoFrameAggregationParameters!

Builds a VideoFrameAggregationParameters instance.

VideoFrameAggregationParameters.Builder!

Sets the target frame rate for aggregating video frames.

Public constructors

Builder

Builder()

Creates a new instance.

Public functions

setFrameRate

@CanIgnoreReturnValue
fun setFrameRate(frameRate: Rational?): VideoFrameAggregationParameters.Builder!

Sets the target frame rate for aggregating video frames.

If set, the aggregation process will drop or reuse frames (with appropriate retiming) to match this rate. This allows the pipeline to guarantee a single, constant frame rate before frames enter the processing layer. For example, if the target frame rate is 30 FPS, a 24 FPS video will have some frames reused, and a 60 FPS video will have some frames dropped to meet the target.

If null, the aggregation follows the primary sequence's physical timestamps. The default is null.

Parameters
frameRate: Rational?

The target frame rate, in frames per second. Must be strictly positive or null.

Throws
java.lang.IllegalArgumentException

If frameRate is not strictly positive and not null.