filmstrip-core/dev.jordond.filmstrip.capability/VideoEncoderCapability

VideoEncoderCapability

class VideoEncoderCapability(val codec: VideoCodec, val encoderName: String?, val maxSize: Size, val maxFrameRate: Int?, val maxBitrate: Bitrate?, val isHardwareAccelerated: Boolean?, val sizeAlignment: Int)(source)

One video encoder the device offers.

Constructors

constructor(codec: VideoCodec, encoderName: String?, maxSize: Size, maxFrameRate: Int?, maxBitrate: Bitrate?, isHardwareAccelerated: Boolean?, sizeAlignment: Int)

Properties

codec

val codec: VideoCodec

The codec this encoder writes.

encoderName

val encoderName: String?

What the backend calls this encoder, or null when the backend does not name one: media3, AVFoundation and the browser hand a codec to the platform and let it choose, so there is no name filmstrip could report that it also invokes.

isHardwareAccelerated

val isHardwareAccelerated: Boolean?

False for a software encoder, true for a hardware one, or null when the platform will not say which it is.

maxBitrate

val maxBitrate: Bitrate?

The highest bitrate it accepts, or null when it does not say.

maxFrameRate

val maxFrameRate: Int?

The highest frame rate it accepts, or null when it does not say.

maxSize

val maxSize: Size

The largest frame it accepts.

sizeAlignment

val sizeAlignment: Int

The alignment each dimension must have, typically 2 and sometimes 16. Filmstrip rounds a frame to this and reports the rounding among the export's adjustments.

Functions

accepts

fun accepts(size: Size): Boolean

Checks a frame size against this encoder's limits.