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

Go to download
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

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



/**
 * Use Manual audio remixing to adjust audio levels for each audio channel in each output of your job. With audio remixing, you can output more or fewer audio channels than your input audio source provides.
 */
public class RemixSettings private constructor(builder: Builder) {
    /**
     * Optionally specify the channel in your input that contains your audio description audio signal. MediaConvert mixes your audio signal across all output channels, while reducing their volume according to your data stream. When you specify an audio description audio channel, you must also specify an audio description data channel. For more information about audio description signals, see the BBC WHP 198 and 051 white papers.
     */
    public val audioDescriptionAudioChannel: kotlin.Int? = builder.audioDescriptionAudioChannel
    /**
     * Optionally specify the channel in your input that contains your audio description data stream. MediaConvert mixes your audio signal across all output channels, while reducing their volume according to your data stream. When you specify an audio description data channel, you must also specify an audio description audio channel. For more information about audio description signals, see the BBC WHP 198 and 051 white papers.
     */
    public val audioDescriptionDataChannel: kotlin.Int? = builder.audioDescriptionDataChannel
    /**
     * Channel mapping contains the group of fields that hold the remixing value for each channel, in dB. Specify remix values to indicate how much of the content from your input audio channel you want in your output audio channels. Each instance of the InputChannels or InputChannelsFineTune array specifies these values for one output channel. Use one instance of this array for each output channel. In the console, each array corresponds to a column in the graphical depiction of the mapping matrix. The rows of the graphical matrix correspond to input channels. Valid values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel (no attenuation or amplification). Use InputChannels or InputChannelsFineTune to specify your remix values. Don't use both.
     */
    public val channelMapping: aws.sdk.kotlin.services.mediaconvert.model.ChannelMapping? = builder.channelMapping
    /**
     * Specify the number of audio channels from your input that you want to use in your output. With remixing, you might combine or split the data in these channels, so the number of channels in your final output might be different. If you are doing both input channel mapping and output channel mapping, the number of output channels in your input mapping must be the same as the number of input channels in your output mapping.
     */
    public val channelsIn: kotlin.Int? = builder.channelsIn
    /**
     * Specify the number of channels in this output after remixing. Valid values: 1, 2, 4, 6, 8... 64. (1 and even numbers to 64.) If you are doing both input channel mapping and output channel mapping, the number of output channels in your input mapping must be the same as the number of input channels in your output mapping.
     */
    public val channelsOut: kotlin.Int? = builder.channelsOut

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

    override fun toString(): kotlin.String = buildString {
        append("RemixSettings(")
        append("audioDescriptionAudioChannel=$audioDescriptionAudioChannel,")
        append("audioDescriptionDataChannel=$audioDescriptionDataChannel,")
        append("channelMapping=$channelMapping,")
        append("channelsIn=$channelsIn,")
        append("channelsOut=$channelsOut")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = audioDescriptionAudioChannel ?: 0
        result = 31 * result + (audioDescriptionDataChannel ?: 0)
        result = 31 * result + (channelMapping?.hashCode() ?: 0)
        result = 31 * result + (channelsIn ?: 0)
        result = 31 * result + (channelsOut ?: 0)
        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 RemixSettings

        if (audioDescriptionAudioChannel != other.audioDescriptionAudioChannel) return false
        if (audioDescriptionDataChannel != other.audioDescriptionDataChannel) return false
        if (channelMapping != other.channelMapping) return false
        if (channelsIn != other.channelsIn) return false
        if (channelsOut != other.channelsOut) return false

        return true
    }

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

    public class Builder {
        /**
         * Optionally specify the channel in your input that contains your audio description audio signal. MediaConvert mixes your audio signal across all output channels, while reducing their volume according to your data stream. When you specify an audio description audio channel, you must also specify an audio description data channel. For more information about audio description signals, see the BBC WHP 198 and 051 white papers.
         */
        public var audioDescriptionAudioChannel: kotlin.Int? = null
        /**
         * Optionally specify the channel in your input that contains your audio description data stream. MediaConvert mixes your audio signal across all output channels, while reducing their volume according to your data stream. When you specify an audio description data channel, you must also specify an audio description audio channel. For more information about audio description signals, see the BBC WHP 198 and 051 white papers.
         */
        public var audioDescriptionDataChannel: kotlin.Int? = null
        /**
         * Channel mapping contains the group of fields that hold the remixing value for each channel, in dB. Specify remix values to indicate how much of the content from your input audio channel you want in your output audio channels. Each instance of the InputChannels or InputChannelsFineTune array specifies these values for one output channel. Use one instance of this array for each output channel. In the console, each array corresponds to a column in the graphical depiction of the mapping matrix. The rows of the graphical matrix correspond to input channels. Valid values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel (no attenuation or amplification). Use InputChannels or InputChannelsFineTune to specify your remix values. Don't use both.
         */
        public var channelMapping: aws.sdk.kotlin.services.mediaconvert.model.ChannelMapping? = null
        /**
         * Specify the number of audio channels from your input that you want to use in your output. With remixing, you might combine or split the data in these channels, so the number of channels in your final output might be different. If you are doing both input channel mapping and output channel mapping, the number of output channels in your input mapping must be the same as the number of input channels in your output mapping.
         */
        public var channelsIn: kotlin.Int? = null
        /**
         * Specify the number of channels in this output after remixing. Valid values: 1, 2, 4, 6, 8... 64. (1 and even numbers to 64.) If you are doing both input channel mapping and output channel mapping, the number of output channels in your input mapping must be the same as the number of input channels in your output mapping.
         */
        public var channelsOut: kotlin.Int? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.mediaconvert.model.RemixSettings) : this() {
            this.audioDescriptionAudioChannel = x.audioDescriptionAudioChannel
            this.audioDescriptionDataChannel = x.audioDescriptionDataChannel
            this.channelMapping = x.channelMapping
            this.channelsIn = x.channelsIn
            this.channelsOut = x.channelsOut
        }

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

        /**
         * construct an [aws.sdk.kotlin.services.mediaconvert.model.ChannelMapping] inside the given [block]
         */
        public fun channelMapping(block: aws.sdk.kotlin.services.mediaconvert.model.ChannelMapping.Builder.() -> kotlin.Unit) {
            this.channelMapping = aws.sdk.kotlin.services.mediaconvert.model.ChannelMapping.invoke(block)
        }

        internal fun correctErrors(): Builder {
            return this
        }
    }
}