kiteffmpeg/io.github.yuroyami.kiteffmpeg.dsl/AudioFormat

AudioFormat

data class AudioFormat(val sampleFormat: SampleFormat? = null, val sampleRate: Int? = null, val channelLayout: String? = null) : FilterStep

Pins the sample format, the rate or the channel layout that the next stage receives.

Constructors

AudioFormat

constructor(sampleFormat: SampleFormat? = null, sampleRate: Int? = null, channelLayout: String? = null)

Properties

channelLayout

val channelLayout: String?

filterName

open override val filterName: String

The FFmpeg filter name, for capability checks. Null for Raw, whose content is opaque.

sampleFormat

val sampleFormat: SampleFormat?

The sample format to pin, typed. It was a raw String while SampleFormat already existed, which is the one place in this DSL where a caller could spell a format FFmpeg would reject and only find out at parse time. Still escaped on the way out: a value class holds whatever it was constructed with.

sampleRate

val sampleRate: Int?

Functions

compile

open override fun compile(): String

The compiled name=args fragment, exactly as it joins the description string.