commonMain.aws.sdk.kotlin.services.mediaconvert.model.FrameCaptureSettings.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mediaconvert Show documentation
The AWS SDK for Kotlin client for MediaConvert
There is a newer version: 1.3.99
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.mediaconvert.model



/**
 * Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.
 */
public class FrameCaptureSettings private constructor(builder: Builder) {
    /**
     * Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
     */
    public val framerateDenominator: kotlin.Int = builder.framerateDenominator
    /**
     * Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.
     */
    public val framerateNumerator: kotlin.Int = builder.framerateNumerator
    /**
     * Maximum number of captures (encoded jpg output files).
     */
    public val maxCaptures: kotlin.Int = builder.maxCaptures
    /**
     * JPEG Quality - a higher value equals higher quality.
     */
    public val quality: kotlin.Int = builder.quality

    public companion object {
        public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.mediaconvert.model.FrameCaptureSettings = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("FrameCaptureSettings(")
        append("framerateDenominator=$framerateDenominator,")
        append("framerateNumerator=$framerateNumerator,")
        append("maxCaptures=$maxCaptures,")
        append("quality=$quality")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = framerateDenominator
        result = 31 * result + (framerateNumerator)
        result = 31 * result + (maxCaptures)
        result = 31 * result + (quality)
        return result
    }

    override fun equals(other: kotlin.Any?): kotlin.Boolean {
        if (this === other) return true
        if (other == null || this::class != other::class) return false

        other as FrameCaptureSettings

        if (framerateDenominator != other.framerateDenominator) return false
        if (framerateNumerator != other.framerateNumerator) return false
        if (maxCaptures != other.maxCaptures) return false
        if (quality != other.quality) return false

        return true
    }

    public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.mediaconvert.model.FrameCaptureSettings = Builder(this).apply(block).build()

    public class Builder {
        /**
         * Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
         */
        public var framerateDenominator: kotlin.Int = 0
        /**
         * Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.
         */
        public var framerateNumerator: kotlin.Int = 0
        /**
         * Maximum number of captures (encoded jpg output files).
         */
        public var maxCaptures: kotlin.Int = 0
        /**
         * JPEG Quality - a higher value equals higher quality.
         */
        public var quality: kotlin.Int = 0

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.mediaconvert.model.FrameCaptureSettings) : this() {
            this.framerateDenominator = x.framerateDenominator
            this.framerateNumerator = x.framerateNumerator
            this.maxCaptures = x.maxCaptures
            this.quality = x.quality
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.mediaconvert.model.FrameCaptureSettings = FrameCaptureSettings(this)
    }
}