AWS Elemental MediaConvert
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.
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AC3.
Accelerated transcoding can significantly speed up jobs with long, visually complex content.
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF.
Settings for ancillary captions source.
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
Description of audio output
Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.
Selector for Audio
Group of Audio Selectors
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.
Required when you set Codec, under VideoDescription>CodecSettings to the value AV1.
Settings for Avail Blanking
Burn-In Destination Settings.
Description of Caption output
Caption Description for preset
Specific settings required by destination type. Note that burnindestinationsettings are not available if the source of the caption data is Embedded or Teletext.
Set up captions in your outputs by first selecting them from your input here.
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.
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 (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).
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.
Settings for CMAF encryption
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.
Settings for MP4 segments in CMAF
Settings for color correction.
Container specific settings.
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.
Specifies DRM settings for DASH outputs.
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASHISOGROUP_SETTINGS.
Settings for deinterlacer
Settings associated with the destination. Will vary based on the type of destination
Settings for Dolby Vision
Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the MaxCLL and MaxFALL values in your input with new values.
Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
Inserts DVB Service Description Table (NIT) at the specified table repetition interval.
DVB-Sub Destination Settings
DVB Sub Source Settings
Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3_ATMOS.
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3.
Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number.
Settings for embedded captions Source
Describes an account-specific API endpoint.
ESAM ManifestConfirmConditionNotification defined by OC-SP-ESAM-API-I03-131025.
Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.
ESAM SignalProcessingNotification data defined by OC-SP-ESAM-API-I03-131025.
Settings for F4v container
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to FILEGROUPSETTINGS.
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.
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.
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.
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264.
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.
Settings for H265 codec
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.
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.
Caption Language Mapping
Settings for HLS encryption
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLSGROUPSETTINGS.
Settings for HLS output groups
Optional. Configuration for a destination queue to which the job can hop once a customer-defined minimum wait time has passed.
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).
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.
Settings specific to IMSC caption outputs.
Specifies media input
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.
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.
Specified video input in a template.
Settings that specify how your still graphic overlay appears.
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
Provides messages from the service about jobs that you have already successfully submitted.
JobSettings contains all the transcode settings for a job.
A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.
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).
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.
Settings for TS segments in HLS
A client for the MediaConvert API.
Overlay motion graphics on top of your video at the time that you specify.
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.
Specify the offset between the upper-left corner of the video frame and the top left corner of the overlay.
Settings for MOV Container.
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2.
Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3.
Settings for MP4 container. You can create audio-only AAC outputs with this container.
Settings for MP4 segments in DASH
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value MPEG2.
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.
If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider.
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to MSSMOOTHGROUP_SETTINGS.
For forensic video watermarking, MediaConvert supports Nagra NexGuard File Marker watermarking. MediaConvert supports both PreRelease Content (NGPR/G2) and OTT Streaming workflows.
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.
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).
Settings for a noise reducer filter
Noise reducer filter settings for spatial filter.
Noise reducer filter settings for temporal filter.
Required when you set Codec, under AudioDescriptions>CodecSettings, to the value OPUS.
An output object describes the settings for a single output file or stream in an output group.
OutputChannel mapping settings.
Details regarding output
Group of outputs
Contains details about the output groups specified in the job settings.
Output Group settings, including type
Specific settings for this type of output.
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.
A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.
Settings for preset
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES.
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.
Description of the source and destination queues between which the job has moved, along with the timestamp of the move
Use Rectangle to identify a specific area of the video frame.
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.
Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
The Amazon Resource Name (ARN) and tags for an AWS Elemental MediaConvert resource.
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.
Settings associated with S3 destination
Settings for how your job outputs are encrypted as they are uploaded to Amazon S3.
Settings for SCC caption output.
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.
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.
Use these settings to set up encryption with a static key provider.
Settings for Teletext caption output
Settings specific to Teletext caption sources, including Page number.
Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified prefix into the output.
These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.
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.
Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
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.
Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough).
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
Settings for video outputs
Contains details about the output's video stream
Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.
Selector for video.
Required when you set Codec, under AudioDescriptions>CodecSettings, to the value Vorbis.
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VP8.
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VP9.
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV.
Errors returned by AssociateCertificate
Errors returned by CancelJob
Errors returned by CreateJob
Errors returned by CreateJobTemplate
Errors returned by CreatePreset
Errors returned by CreateQueue
Errors returned by DeleteJobTemplate
Errors returned by DeletePreset
Errors returned by DeleteQueue
Errors returned by DescribeEndpoints
Errors returned by DisassociateCertificate
Errors returned by GetJob
Errors returned by GetJobTemplate
Errors returned by GetPreset
Errors returned by GetQueue
Errors returned by ListJobTemplates
Errors returned by ListJobs
Errors returned by ListPresets
Errors returned by ListQueues
Errors returned by ListTagsForResource
Errors returned by TagResource
Errors returned by UntagResource
Errors returned by UpdateJobTemplate
Errors returned by UpdatePreset
Errors returned by UpdateQueue
Trait representing the capabilities of the MediaConvert API. MediaConvert clients implement this trait.