Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Amazon Elastic Transcoder can respond with.

Structs

Artwork

The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20.

To remove artwork or leave the artwork empty, you can either set Artwork to null, or set the Merge Policy to "Replace" and use an empty Artwork array.

To pass through existing artwork unchanged, set the Merge Policy to "Prepend", "Append", or "Fallback", and use an empty Artwork array.

AudioCodecOptions

Options associated with your audio codec.

AudioParameters

Parameters required for transcoding audio.

CaptionFormat

The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error.

CaptionSource

A source file for the input sidecar captions used during the transcoding process.

Captions

The captions to be created, if any.

ClipDeprecated

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

CreateJobOutput

The CreateJobOutput structure.

CreateJobPlaylist

Information about the master playlist.

DetectedProperties

The detected properties of the input file. Elastic Transcoder identifies these values from the input file.

Encryption

The encryption settings, if any, that are used for decrypting your input files or encrypting your output files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file, otherwise you must specify the mode you want Elastic Transcoder to use to encrypt your output files.

HlsContentProtection

The HLS content protection settings, if any, that you want Elastic Transcoder to apply to your output files.

InputCaptions

The captions to be created, if any.

Job

A section of the response body that provides information about the job that is created.

JobAlbumArt

The .jpg or .png file associated with an audio file.

JobInput

Information about the file that you're transcoding.

JobOutput

Outputs recommended instead.

If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.

JobWatermark

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.

Notifications

The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

Permission

The Permission structure.

Pipeline

The pipeline (queue) that is used to manage jobs.

PipelineOutputConfig

The PipelineOutputConfig structure.

PlayReadyDrm

The PlayReady DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

PlayReady DRM encrypts your media files using aes-ctr encryption.

If you use DRM for an HLSv3 playlist, your outputs must have a master playlist.

Playlist

Use Only for Fragmented MP4 or MPEG-TS Outputs. If you specify a preset for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create. We recommend that you create only one master playlist per output format. The maximum number of master playlists in a job is 30.

Preset

Presets are templates that contain most of the settings for transcoding media files from one format to another. Elastic Transcoder includes some default presets for common formats, for example, several iPod and iPhone versions. You can also create your own presets for formats that aren't included among the default presets. You specify which preset you want to use when you create a job.

PresetWatermark

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.

When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.

Thumbnails

Thumbnails for videos.

TimeSpan

Settings that determine when a clip begins and how long it lasts.

Timing

Details about the timing of a job.

VideoParameters

The VideoParameters structure.

Warning

Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.

Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.