Expand description
AWS Elemental MediaConvert
If you’re using the service, you’re probably looking for MediaConvertClient and MediaConvert.
Structs§
- AacSettings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AAC. The service accepts one of two mutually exclusive groups of AAC settings--VBR and CBR. To select one of these modes, set the value of Bitrate control mode (rateControlMode) to "VBR" or "CBR". In VBR mode, you control the audio quality with the setting VBR quality (vbrQuality). In CBR mode, you use the setting Bitrate (bitrate). Defaults and valid values depend on the rate control mode.
- Ac3Settings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AC3.
- Acceleration
Settings Accelerated transcoding can significantly speed up jobs with long, visually complex content.
- Aiff
Settings Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF.
- Ancillary
Source Settings Settings for ancillary captions source.
- Associate
Certificate Request - Associate
Certificate Response - Audio
Codec Settings Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value that you choose for Audio codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * MP3, Mp3Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings * VORBIS, VorbisSettings * OPUS, OpusSettings
- Audio
Description Description of audio output
- Audio
Normalization Settings Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.
- Audio
Selector Selector for Audio
- Audio
Selector Group Group of Audio Selectors
- Av1Qvbr
Settings Settings for quality-defined variable bitrate encoding with the AV1 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.
- Av1Settings
Required when you set Codec, under VideoDescription>CodecSettings to the value AV1.
- Avail
Blanking Settings for Avail Blanking
- Burnin
Destination Settings Burn-In Destination Settings.
- Cancel
JobRequest - Cancel
JobResponse - Caption
Description Description of Caption output
- Caption
Description Preset Caption Description for preset
- Caption
Destination Settings Specific settings required by destination type. Note that burnindestinationsettings are not available if the source of the caption data is Embedded or Teletext.
- Caption
Selector Set up captions in your outputs by first selecting them from your input here.
- Caption
Source Framerate Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps.
- Caption
Source Settings If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
- Channel
Mapping Channel mapping (ChannelMapping) contains the group of fields that hold the remixing value for each channel. Units are in dB. Acceptable 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).
- Cmaf
Additional Manifest Specify the details for each pair of HLS and DASH additional manifests that you want the service to generate for this CMAF output group. Each pair of manifests can reference a different subset of outputs in the group.
- Cmaf
Encryption Settings Settings for CMAF encryption
- Cmaf
Group Settings Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAFGROUPSETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output.
- Cmfc
Settings Settings for MP4 segments in CMAF
- Color
Corrector Settings for color correction.
- Container
Settings Container specific settings.
- Create
JobRequest - Create
JobResponse - Create
JobTemplate Request - Create
JobTemplate Response - Create
Preset Request - Create
Preset Response - Create
Queue Request - Create
Queue Response - Dash
Additional Manifest Specify the details for each additional DASH manifest that you want the service to generate for this output group. Each manifest can reference a different subset of outputs in the group.
- Dash
IsoEncryption Settings Specifies DRM settings for DASH outputs.
- Dash
IsoGroup Settings Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASHISOGROUP_SETTINGS.
- Deinterlacer
Settings for deinterlacer
- Delete
JobTemplate Request - Delete
JobTemplate Response - Delete
Preset Request - Delete
Preset Response - Delete
Queue Request - Delete
Queue Response - Describe
Endpoints Request DescribeEndpointsRequest
- Describe
Endpoints Response - Destination
Settings Settings associated with the destination. Will vary based on the type of destination
- Disassociate
Certificate Request - Disassociate
Certificate Response - Dolby
Vision Settings for Dolby Vision
- Dolby
Vision Level6 Metadata Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the MaxCLL and MaxFALL values in your input with new values.
- DvbNit
Settings Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
- DvbSdt
Settings Inserts DVB Service Description Table (NIT) at the specified table repetition interval.
- DvbSub
Destination Settings DVB-Sub Destination Settings
- DvbSub
Source Settings DVB Sub Source Settings
- DvbTdt
Settings Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
- Eac3
Atmos Settings Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3_ATMOS.
- Eac3
Settings Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3.
- Embedded
Destination Settings Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number.
- Embedded
Source Settings Settings for embedded captions Source
- Endpoint
Describes an account-specific API endpoint.
- Esam
Manifest Confirm Condition Notification ESAM ManifestConfirmConditionNotification defined by OC-SP-ESAM-API-I03-131025.
- Esam
Settings Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.
- Esam
Signal Processing Notification ESAM SignalProcessingNotification data defined by OC-SP-ESAM-API-I03-131025.
- F4vSettings
Settings for F4v container
- File
Group Settings Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to FILEGROUPSETTINGS.
- File
Source Settings If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
- Frame
Capture Settings Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.
- GetJob
Request - GetJob
Response - GetJob
Template Request - GetJob
Template Response - GetPreset
Request - GetPreset
Response - GetQueue
Request - GetQueue
Response - H264
Qvbr Settings Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.
- H264
Settings Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264.
- H265
Qvbr Settings Settings for quality-defined variable bitrate encoding with the H.265 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.
- H265
Settings Settings for H265 codec
- Hdr10
Metadata Use these settings to specify static color calibration metadata, as defined by SMPTE ST 2086. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator.
- HlsAdditional
Manifest Specify the details for each additional HLS manifest that you want the service to generate for this output group. Each manifest can reference a different subset of outputs in the group.
- HlsCaption
Language Mapping Caption Language Mapping
- HlsEncryption
Settings Settings for HLS encryption
- HlsGroup
Settings Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLSGROUPSETTINGS.
- HlsSettings
Settings for HLS output groups
- HopDestination
Optional. Configuration for a destination queue to which the job can hop once a customer-defined minimum wait time has passed.
- Id3Insertion
To insert ID3 tags in your output, specify two values. Use ID3 tag (Id3) to specify the base 64 encoded string and use Timecode (TimeCode) to specify the time when the tag should be inserted. To insert multiple ID3 tags in your output, create multiple instances of ID3 insertion (Id3Insertion).
- Image
Inserter Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input or output individually. This setting is disabled by default.
- Imsc
Destination Settings Settings specific to IMSC caption outputs.
- Input
Specifies media input
- Input
Clipping To transcode only portions of your input (clips), include one Input clipping (one instance of InputClipping in the JSON job file) for each input clip. All input clips you specify will be included in every output of the job.
- Input
Decryption Settings Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content.
- Input
Template Specified video input in a template.
- Insertable
Image Settings that specify how your still graphic overlay appears.
- Job
Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
- JobMessages
Provides messages from the service about jobs that you have already successfully submitted.
- JobSettings
JobSettings contains all the transcode settings for a job.
- JobTemplate
A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
- JobTemplate
Settings JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.
- List
JobTemplates Request - List
JobTemplates Response - List
Jobs Request - List
Jobs Response - List
Presets Request - List
Presets Response - List
Queues Request - List
Queues Response - List
Tags ForResource Request - List
Tags ForResource Response - M2ts
Scte35 Esam Settings for SCTE-35 signals from ESAM. Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).
- M2ts
Settings MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset.
- M3u8
Settings Settings for TS segments in HLS
- Media
Convert Client - A client for the MediaConvert API.
- Motion
Image Inserter Overlay motion graphics on top of your video at the time that you specify.
- Motion
Image Insertion Framerate For motion overlays that don't have a built-in frame rate, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. The overlay frame rate doesn't need to match the frame rate of the underlying video.
- Motion
Image Insertion Offset Specify the offset between the upper-left corner of the video frame and the top left corner of the overlay.
- MovSettings
Settings for MOV Container.
- Mp2Settings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2.
- Mp3Settings
Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3.
- Mp4Settings
Settings for MP4 container. You can create audio-only AAC outputs with this container.
- MpdSettings
Settings for MP4 segments in DASH
- Mpeg2
Settings Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value MPEG2.
- MsSmooth
Additional Manifest Specify the details for each additional Microsoft Smooth Streaming manifest that you want the service to generate for this output group. Each manifest can reference a different subset of outputs in the group.
- MsSmooth
Encryption Settings If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider.
- MsSmooth
Group Settings Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to MSSMOOTHGROUP_SETTINGS.
- MxfSettings
MXF settings
- NexGuard
File Marker Settings For forensic video watermarking, MediaConvert supports Nagra NexGuard File Marker watermarking. MediaConvert supports both PreRelease Content (NGPR/G2) and OTT Streaming workflows.
- Nielsen
Configuration Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.
- Noise
Reducer Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting is disabled by default. When you enable Noise reducer (NoiseReducer), you must also select a value for Noise reducer filter (NoiseReducerFilter).
- Noise
Reducer Filter Settings Settings for a noise reducer filter
- Noise
Reducer Spatial Filter Settings Noise reducer filter settings for spatial filter.
- Noise
Reducer Temporal Filter Settings Noise reducer filter settings for temporal filter.
- Opus
Settings Required when you set Codec, under AudioDescriptions>CodecSettings, to the value OPUS.
- Output
An output object describes the settings for a single output file or stream in an output group.
- Output
Channel Mapping OutputChannel mapping settings.
- Output
Detail Details regarding output
- Output
Group Group of outputs
- Output
Group Detail Contains details about the output groups specified in the job settings.
- Output
Group Settings Output Group settings, including type
- Output
Settings Specific settings for this type of output.
- Partner
Watermarking If you work with a third party video watermarking partner, use the group of settings that correspond with your watermarking partner to include watermarks in your output.
- Preset
A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.
- Preset
Settings Settings for preset
- Prores
Settings Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES.
- Queue
You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.
- Queue
Transition Description of the source and destination queues between which the job has moved, along with the timestamp of the move
- Rectangle
Use Rectangle to identify a specific area of the video frame.
- Remix
Settings Use Manual audio remixing (RemixSettings) 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.
- Reservation
Plan Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
- Reservation
Plan Settings Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
- Resource
Tags The Amazon Resource Name (ARN) and tags for an AWS Elemental MediaConvert resource.
- S3Destination
Access Control Optional. Have MediaConvert automatically apply Amazon S3 access control for the outputs in this output group. When you don't use this setting, S3 automatically applies the default access control list PRIVATE.
- S3Destination
Settings Settings associated with S3 destination
- S3Encryption
Settings Settings for how your job outputs are encrypted as they are uploaded to Amazon S3.
- SccDestination
Settings Settings for SCC caption output.
- Speke
KeyProvider If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead.
- Speke
KeyProvider Cmaf If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is HLS, DASH, or Microsoft Smooth, use the SpekeKeyProvider settings instead.
- Static
KeyProvider Use these settings to set up encryption with a static key provider.
- TagResource
Request - TagResource
Response - Teletext
Destination Settings Settings for Teletext caption output
- Teletext
Source Settings Settings specific to Teletext caption sources, including Page number.
- Timecode
Burnin Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified prefix into the output.
- Timecode
Config These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.
- Timed
Metadata Insertion Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.
- Timing
Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
- Track
Source Settings Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.
- Ttml
Destination Settings Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough).
- Untag
Resource Request - Untag
Resource Response - Update
JobTemplate Request - Update
JobTemplate Response - Update
Preset Request - Update
Preset Response - Update
Queue Request - Update
Queue Response - Video
Codec Settings Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * FRAMECAPTURE, FrameCaptureSettings * AV1, Av1Settings * H264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VP8, Vp8Settings * VP9, Vp9Settings
- Video
Description Settings for video outputs
- Video
Detail Contains details about the output's video stream
- Video
Preprocessor Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.
- Video
Selector Selector for video.
- Vorbis
Settings Required when you set Codec, under AudioDescriptions>CodecSettings, to the value Vorbis.
- Vp8Settings
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VP8.
- Vp9Settings
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VP9.
- WavSettings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV.
Enums§
- Associate
Certificate Error - Errors returned by AssociateCertificate
- Cancel
JobError - Errors returned by CancelJob
- Create
JobError - Errors returned by CreateJob
- Create
JobTemplate Error - Errors returned by CreateJobTemplate
- Create
Preset Error - Errors returned by CreatePreset
- Create
Queue Error - Errors returned by CreateQueue
- Delete
JobTemplate Error - Errors returned by DeleteJobTemplate
- Delete
Preset Error - Errors returned by DeletePreset
- Delete
Queue Error - Errors returned by DeleteQueue
- Describe
Endpoints Error - Errors returned by DescribeEndpoints
- Disassociate
Certificate Error - Errors returned by DisassociateCertificate
- GetJob
Error - Errors returned by GetJob
- GetJob
Template Error - Errors returned by GetJobTemplate
- GetPreset
Error - Errors returned by GetPreset
- GetQueue
Error - Errors returned by GetQueue
- List
JobTemplates Error - Errors returned by ListJobTemplates
- List
Jobs Error - Errors returned by ListJobs
- List
Presets Error - Errors returned by ListPresets
- List
Queues Error - Errors returned by ListQueues
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
JobTemplate Error - Errors returned by UpdateJobTemplate
- Update
Preset Error - Errors returned by UpdatePreset
- Update
Queue Error - Errors returned by UpdateQueue
Traits§
- Media
Convert - Trait representing the capabilities of the MediaConvert API. MediaConvert clients implement this trait.