ExportResult.Builder


class ExportResult.Builder


A builder for ExportResult instances.

Summary

Public constructors

Creates a builder.

Public functions

ExportResult.Builder!

Adds processed inputs to the ProcessedInput list.

ExportResult!

Builds an ExportResult instance.

Unit

Resets all the fields to their default values.

ExportResult.Builder!

Sets the name of the audio encoder used.

ExportResult.Builder!

Sets the average audio bitrate.

ExportResult.Builder!

Sets the average video bitrate.

ExportResult.Builder!

Sets the channel count.

ExportResult.Builder!

Sets the ColorInfo.

ExportResult.Builder!

Sets the duration of the output in milliseconds.

ExportResult.Builder!

Sets the ExportException that caused the export to fail.

ExportResult.Builder!

Sets the file size in bytes.

ExportResult.Builder!

Sets the height.

ExportResult.Builder!

Sets OptimizationResult to indicate an optimization as been successful, or has failed and normal export proceeded instead.

ExportResult.Builder!

Sets the sample rate.

ExportResult.Builder!

Sets the name of the video encoder used.

ExportResult.Builder!

Sets the number of video frames.

ExportResult.Builder!

Sets the width.

Public constructors

Builder

Builder()

Creates a builder.

Public functions

addProcessedInputs

@CanIgnoreReturnValue
fun addProcessedInputs(
    processedInputs: (Mutable)List<ExportResult.ProcessedInput!>!
): ExportResult.Builder!

Adds processed inputs to the ProcessedInput list.

build

fun build(): ExportResult!

Builds an ExportResult instance.

reset

fun reset(): Unit

Resets all the fields to their default values.

setAudioEncoderName

@CanIgnoreReturnValue
fun setAudioEncoderName(audioEncoderName: String?): ExportResult.Builder!

Sets the name of the audio encoder used.

setAverageAudioBitrate

@CanIgnoreReturnValue
fun setAverageAudioBitrate(averageAudioBitrate: Int): ExportResult.Builder!

Sets the average audio bitrate.

Must be positive or RATE_UNSET_INT.

setAverageVideoBitrate

@CanIgnoreReturnValue
fun setAverageVideoBitrate(averageVideoBitrate: Int): ExportResult.Builder!

Sets the average video bitrate.

Must be positive or RATE_UNSET_INT.

setChannelCount

@CanIgnoreReturnValue
fun setChannelCount(channelCount: Int): ExportResult.Builder!

Sets the channel count.

Must be positive or LENGTH_UNSET.

setColorInfo

@CanIgnoreReturnValue
fun setColorInfo(colorInfo: ColorInfo?): ExportResult.Builder!

Sets the ColorInfo.

setDurationMs

@CanIgnoreReturnValue
fun setDurationMs(durationMs: Long): ExportResult.Builder!

Sets the duration of the output in milliseconds.

Must be positive or TIME_UNSET.

setExportException

@CanIgnoreReturnValue
fun setExportException(exportException: ExportException?): ExportResult.Builder!

Sets the ExportException that caused the export to fail.

setFileSizeBytes

@CanIgnoreReturnValue
fun setFileSizeBytes(fileSizeBytes: Long): ExportResult.Builder!

Sets the file size in bytes.

Must be positive or LENGTH_UNSET.

setHeight

@CanIgnoreReturnValue
fun setHeight(height: Int): ExportResult.Builder!

Sets the height.

Must be positive or LENGTH_UNSET.

setOptimizationResult

@CanIgnoreReturnValue
fun setOptimizationResult(optimizationResult: Int): ExportResult.Builder!

Sets OptimizationResult to indicate an optimization as been successful, or has failed and normal export proceeded instead.

The default value is OPTIMIZATION_NONE.

Parameters
optimizationResult: Int

The OptimizationResult.

Returns
ExportResult.Builder!

This Builder.

setSampleRate

@CanIgnoreReturnValue
fun setSampleRate(sampleRate: Int): ExportResult.Builder!

Sets the sample rate.

Must be positive or RATE_UNSET_INT.

setVideoEncoderName

@CanIgnoreReturnValue
fun setVideoEncoderName(videoEncoderName: String?): ExportResult.Builder!

Sets the name of the video encoder used.

setVideoFrameCount

@CanIgnoreReturnValue
fun setVideoFrameCount(videoFrameCount: Int): ExportResult.Builder!

Sets the number of video frames.

Must be positive or 0.

setWidth

@CanIgnoreReturnValue
fun setWidth(width: Int): ExportResult.Builder!

Sets the width.

Must be positive or LENGTH_UNSET.