elastictranscoder/aws.sdk.kotlin.services.elastictranscoder.model/JobOutput/Builder

Builder

Properties

The album art to be associated with the output file, if any.

var appliedColorSpaceConversion: String?

If Elastic Transcoder used a preset with a ColorSpaceConversionMode to transcode the output file, the AppliedColorSpaceConversion parameter shows the conversion used. If no ColorSpaceConversionMode was defined in the preset, this parameter is not be included in the job response.

captions

var captions: Captions?

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

composition

var ~~composition~~: List<Clip>?

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

duration

var duration: Long?

Duration of the output file, in seconds.

durationMillis

var durationMillis: Long?

Duration of the output file, in milliseconds.

encryption

var encryption: Encryption?

The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket.

fileSize

var fileSize: Long?

File size of the output file, in bytes.

frameRate

var frameRate: String?

Frame rate of the output file, in frames per second.

height

var height: Int?

Height of the output file, in pixels.

var id: String?

A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.

key

var key: String?

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID.

presetId

var presetId: String?

The value of the Id object for the preset that you want to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. To use a preset that you created, specify the preset ID that Elastic Transcoder returned in the response when you created the preset. You can also use the Elastic Transcoder system presets, which you can get with ListPresets.

rotate

var rotate: String?

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values:

segmentDuration

var segmentDuration: String?

(Outputs in Fragmented MP4 or MPEG-TS format only.

status

var status: String?

The status of one output in a job. If you specified only one output for the job, Outputs:Status is always the same as Job:Status. If you specified more than one output:

statusDetail

var statusDetail: String?

Information that further explains Status.

thumbnailEncryption

var thumbnailEncryption: Encryption?

The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.

thumbnailPattern

var thumbnailPattern: String?

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.

watermarks

var watermarks: List<JobWatermark>?

Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in Preset for the current output.

width

var width: Int?

Specifies the width of the output file in pixels.

Functions

albumArt

fun albumArt(block: JobAlbumArt.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.elastictranscoder.model.JobAlbumArt inside the given block

captions

fun captions(block: Captions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.elastictranscoder.model.Captions inside the given block

encryption

fun encryption(block: Encryption.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.elastictranscoder.model.Encryption inside the given block

thumbnailEncryption

fun thumbnailEncryption(block: Encryption.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.elastictranscoder.model.Encryption inside the given block