VideoEncoderSettings

Artifact: androidx.media3:media3-transformer

View Source

---

Kotlin |Java

@UnstableApi
class VideoEncoderSettings

---

Represents the video encoder settings.

Summary

Nested types
@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = TYPE_USE) @IntDef(value = ) annotation VideoEncoderSettings.BitrateMode The allowed values for bitrateMode.
class VideoEncoderSettings.Builder Builds VideoEncoderSettings instances.

Constants
const VideoEncoderSettings!	DEFAULT A default VideoEncoderSettings.
const Float	DEFAULT_I_FRAME_INTERVAL_SECONDS = 1.0f The default I-frame interval in seconds.
const Int	NO_VALUE = -1 A value for various fields to indicate that the field's value is unknown or not applicable.
const Int	RATE_UNSET = -2 A value for setEncoderPerformanceParameters to disable setting performance parameters.

Public functions
VideoEncoderSettings.Builder!	buildUpon() Returns a VideoEncoderSettings.Builder initialized with the values of this instance.
Boolean	equals(o: Any?)
Int	hashCode()

Public properties
Int	bitrate The encoding bitrate in bits per second.
Int	@VideoEncoderSettings.BitrateMode bitrateMode One of BitrateMode.
Boolean	enableHighQualityTargeting Whether the encoder should automatically set the bitrate to target a high quality encoding.
Float	iFrameIntervalSeconds The encoding I-Frame interval in seconds.
Int	level The encoding level.
Int	operatingRate The encoder operating rate in frames per second.
Int	priority The encoder priority.
Int	profile The encoding profile.

Constants

DEFAULT

const val DEFAULT: VideoEncoderSettings!

A default VideoEncoderSettings.

DEFAULT_I_FRAME_INTERVAL_SECONDS

const val DEFAULT_I_FRAME_INTERVAL_SECONDS = 1.0f: Float

The default I-frame interval in seconds.

NO_VALUE

const val NO_VALUE = -1: Int

A value for various fields to indicate that the field's value is unknown or not applicable.

RATE_UNSET

const val RATE_UNSET = -2: Int

A value for setEncoderPerformanceParameters to disable setting performance parameters.

Public functions

buildUpon

fun buildUpon(): VideoEncoderSettings.Builder!

Returns a VideoEncoderSettings.Builder initialized with the values of this instance.

equals

fun equals(o: Any?): Boolean

hashCode

fun hashCode(): Int

Public properties

bitrate

val bitrate: Int

The encoding bitrate in bits per second.

bitrateMode

@VideoEncoderSettings.BitrateMode
val bitrateMode: Int

One of BitrateMode.

enableHighQualityTargeting

val enableHighQualityTargeting: Boolean

Whether the encoder should automatically set the bitrate to target a high quality encoding.

iFrameIntervalSeconds

val iFrameIntervalSeconds: Float

The encoding I-Frame interval in seconds.

level

val level: Int

The encoding level.

operatingRate

val operatingRate: Int

The encoder operating rate in frames per second.

priority

val priority: Int

The encoder priority.

profile

val profile: Int

The encoding profile.