CodecDbEncoderDataset


@ExperimentalApi
class CodecDbEncoderDataset


A loaded dataset of CodecDB data that can be queried for expected quality or optimal settings.

Obtain instances via CodecDbDatasetLoader.

Summary

Public functions

VideoEncoderConfiguration?

Returns the optimal VideoEncoderConfiguration that satisfies the provided VideoEncoderConstraints based on the loaded CodecDB dataset (or its fallback provider), or null if no suitable configuration is found.

Double
predictQualityFor(videoEncoderConfiguration: VideoEncoderConfiguration!)

Attempts to predict the expected quality of the provided VideoEncoderConfiguration.

Public functions

findOptimalConfiguration

fun findOptimalConfiguration(constraints: VideoEncoderConstraints!): VideoEncoderConfiguration?

Returns the optimal VideoEncoderConfiguration that satisfies the provided VideoEncoderConstraints based on the loaded CodecDB dataset (or its fallback provider), or null if no suitable configuration is found.

Callers can obtain VideoEncoderConstraints for common encoding use cases from VideoEncoderConstraintsPresets (such as forEditing, forHqCameraRecording, or forRealTimeCommunication).

Parameters
constraints: VideoEncoderConstraints!

The encoding constraints to optimize around.

predictQualityFor

fun predictQualityFor(videoEncoderConfiguration: VideoEncoderConfiguration!): Double

Attempts to predict the expected quality of the provided VideoEncoderConfiguration.

The predicted quality is on a [0, 100] scale, representing the Video Multi-method Assessment Fusion (VMAF) score. If no configuration in this dataset matches, the quality fallback provider is queried instead. Returns NaN if neither can predict a quality.

Parameters
videoEncoderConfiguration: VideoEncoderConfiguration!

The configuration to predict quality for.

Returns
Double

The predicted VMAF quality score, or NaN if unavailable.

Throws
java.lang.IllegalArgumentException

If the resolution or bitrate of videoEncoderConfiguration is NO_VALUE.