DefaultEncoderFactory

Kotlin |Java

@UnstableApi
public final class DefaultEncoderFactory implements Codec.EncoderFactory

A default implementation of Codec.EncoderFactory.

Summary

Nested types
`public final class DefaultEncoderFactory.Builder` A builder for `DefaultEncoderFactory` instances.

Public methods
`boolean`	`audioNeedsEncoding()` Returns whether the audio needs to be encoded because of encoder specific configuration.
`DefaultEncoderFactory.Builder`	`buildUpon()` Returns a `Builder` initialized with the values of this instance.
`DefaultCodec`	`createForAudioEncoding( Format format, @Nullable LogSessionId logSessionId )` Returns a `Codec` for audio encoding.
`DefaultCodec`	`createForVideoEncoding( Format format, @Nullable LogSessionId logSessionId )` Returns a `DefaultCodec` for video encoding.
`boolean`	`isVideoFormatSupported(Format requestedFormat)` Returns whether the requested video `Format` is supported by the encoder factory.
`boolean`	`videoNeedsEncoding()` Returns whether the video needs to be encoded because of encoder specific configuration.

public boolean audioNeedsEncoding()

Returns whether the audio needs to be encoded because of encoder specific configuration.

public DefaultEncoderFactory.Builder buildUpon()

Returns a Builder initialized with the values of this instance.

public DefaultCodec createForAudioEncoding(
    Format format,
    @Nullable LogSessionId logSessionId
)

Returns a Codec for audio encoding.

The caller should ensure the MIME type is supported on the device before calling this method.

Parameters
`Format format`	The `Format` (of the output data) used to determine the underlying encoder and its configuration values. `sampleMimeType`, `sampleRate`, `channelCount` and `bitrate` are set to those of the desired output video format.
`@Nullable LogSessionId logSessionId`	The optional `LogSessionId` of the `android.media.metrics.EditingSession`.

Returns
`DefaultCodec`	A `Codec` for encoding audio to the requested `MIME type`.

Throws
`androidx.media3.transformer.ExportException`	If no suitable `Codec` can be created.

public DefaultCodec createForVideoEncoding(
    Format format,
    @Nullable LogSessionId logSessionId
)

Returns a DefaultCodec for video encoding.

Use setRequestedVideoEncoderSettings with bitrate set to request for a specific encoding bitrate. Bitrate settings in Format are ignored when bitrate is set.

Throws
`androidx.media3.transformer.ExportException`

public boolean isVideoFormatSupported(Format requestedFormat)

Returns whether the requested video Format is supported by the encoder factory.

This is an experimental API and is currently being used for FrameWriter specifically.

public boolean videoNeedsEncoding()

Returns whether the video needs to be encoded because of encoder specific configuration.