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
Channel Tagging Settings When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually. For example, you would tag the tracks that contain your left, right, and center audio with Left (L), Right (R), and Center (C), respectively. When you don't specify a value, MediaConvert labels your track as Center (C) by default. To use audio layout tagging, your output must be in a QuickTime (.mov) container; your audio codec must be AAC, WAV, or AIFF; and you must set up your audio track to have only one channel.
- Audio
Codec Settings Settings related to audio encoding. The settings in this group vary depending on the value that you choose for your audio codec.
- Audio
Description Settings related to one audio tab on the MediaConvert console. In your job JSON, an instance of AudioDescription is equivalent to one audio tab in the console. Usually, one audio tab corresponds to one output audio track. Depending on how you set up your input audio selectors and whether you use audio selector groups, one audio tab can correspond to a group of output audio tracks.
- Audio
Normalization Settings Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.
- Audio
Selector Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use multiple Audio selectors per input.
- Audio
Selector Group Use audio selector groups to combine multiple sidecar audio inputs so that you can assign them to a single output audio tab (AudioDescription). Note that, if you're working with embedded audio, it's simpler to assign multiple input tracks into a single audio selector rather than use an audio selector group.
- Automated
AbrSettings Use automated ABR to have MediaConvert set up the renditions in your ABR package for you automatically, based on characteristics of your input video. This feature optimizes video quality while minimizing the overall size of your ABR package.
- Automated
Encoding Settings Use automated encoding to have MediaConvert choose your encoding settings for you, based on characteristics of your input video.
- 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 Use ad avail blanking settings to specify your output content during SCTE-35 triggered ad avails. You can blank your video or overlay it with an image. MediaConvert also removes any audio and embedded captions during the ad avail. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ad-avail-blanking.html.
- AvcIntra
Settings Required when you choose AVC-Intra for your output video codec. For more information about the AVC-Intra settings, see the relevant specification. For detailed information about SD and HD in AVC-Intra, see https://ieeexplore.ieee.org/document/7290936. For information about 4K/2K in AVC-Intra, see https://pro-av.panasonic.net/en/avc-ultra/AVC-ULTRAoverview.pdf.
- AvcIntra
UhdSettings Optional when you set AVC-Intra class (avcIntraClass) to Class 4K/2K (CLASS4K2K). When you set AVC-Intra class to a different value, this object isn't allowed.
- Burnin
Destination Settings Settings related to burn-in captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.
- Cancel
JobRequest - Cancel
JobResponse - Caption
Description This object holds groups of settings related to captions for one output. For each output that has captions, include one instance of CaptionDescriptions.
- Caption
Description Preset Caption Description for preset
- Caption
Destination Settings Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.
- Caption
Selector Use captions selectors to specify the captions data from your input that you use in your outputs. You can use up to 20 captions selectors per input.
- 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, 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.
- 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 Settings related to your CMAF output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to CMAFGROUPSETTINGS.
- Cmfc
Settings These settings relate to the fragmented MP4 container for the segments in your CMAF outputs.
- 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 Settings related to your DASH output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job specification, include this object and any required children when you set Type, under 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 With AWS Elemental MediaConvert, you can create profile 5 Dolby Vision outputs from MXF and IMF sources that contain mastering information as frame-interleaved Dolby Vision metadata.
- 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 Use these settings to insert a DVB Network Information Table (NIT) in the transport stream of this output. When you work directly in your JSON job specification, include this object only when your job has a transport stream output and the container settings contain the object M2tsSettings.
- DvbSdt
Settings Use these settings to insert a DVB Service Description Table (SDT) in the transport stream of this output. When you work directly in your JSON job specification, include this object only when your job has a transport stream output and the container settings contain the object M2tsSettings.
- DvbSub
Destination Settings Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to DVB_SUB.
- DvbSub
Source Settings DVB Sub Source Settings
- DvbTdt
Settings Use these settings to insert a DVB Time and Date Table (TDT) in the transport stream of this output. When you work directly in your JSON job specification, include this object only when your job has a transport stream output and the container settings contain the object M2tsSettings.
- 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 related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDEDPLUSSCTE20, or SCTE20PLUSEMBEDDED.
- 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 Settings related to your File output group. MediaConvert uses this group of settings to generate a single standalone file, rather than a streaming package. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to FILEGROUPSETTINGS.
- File
Source Settings If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, 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.
- Hdr10
Plus Setting for HDR10+ metadata insertion
- 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 Settings related to your HLS output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to HLSGROUPSETTINGS.
- HlsRendition
Group Settings Settings specific to audio sources in an HLS alternate rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique audio track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the properties provided, the job fails. If no properties in hlsRenditionGroupSettings are specified, the default audio track within the video segment is chosen. If there is no audio within video segment, the alternative audio with DEFAULT=YES is chosen instead.
- 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 Use the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input or output individually. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/graphic-overlay.html. This setting is disabled by default.
- Imsc
Destination Settings Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.
- Input
Use inputs to define the source files used in your transcoding job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/specify-input-settings.html. You can use multiple video inputs to do input stitching. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/assembling-multiple-inputs-and-input-clips.html
- Input
Clipping To transcode only portions of your input, include one input clip for each part of your input that you want in your output. All input clips that you specify will be included in every output of the job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/assembling-multiple-inputs-and-input-clips.html.
- 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 These settings apply to a specific graphic overlay. You can include multiple overlays in your job.
- Job
Each job converts an input file into an output file or files. For more information, see the User Guide at https://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.
- Kantar
Watermark Settings Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.
- 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 These settings relate to the MPEG-2 transport stream (MPEG2-TS) container for the MPEG2-TS segments in your HLS outputs.
- Media
Convert Client - A client for the MediaConvert API.
- Motion
Image Inserter Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html.
- 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
These settings relate to your QuickTime MOV output 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
These settings relate to your MP4 output container. You can create audio only outputs with this container. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/supported-codecs-containers-audio-only.html#output-codecs-and-containers-supported-for-audio-only.
- MpdSettings
These settings relate to the fragmented MP4 container for the segments in your DASH outputs.
- 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 Settings related to your Microsoft Smooth Streaming output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to MSSMOOTHGROUP_SETTINGS.
- MxfSettings
These settings relate to your MXF output container.
- MxfXavc
Profile Settings Specify the XAVC profile settings for MXF outputs when you set your MXF profile to XAVC.
- 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.
- Nielsen
NonLinear Watermark Settings Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]
- 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
Each output in your job is a collection of settings that describes how you want MediaConvert to encode a single output file or stream. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/create-outputs.html.
- 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 related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.
- 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 related to teletext captions. Set up teletext captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TELETEXT.
- Teletext
Source Settings Settings specific to Teletext caption sources, including Page number.
- Timecode
Burnin Settings for burning 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 any HLS outputs. 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 related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML.
- Untag
Resource Request - Untag
Resource Response - Update
JobTemplate Request - Update
JobTemplate Response - Update
Preset Request - Update
Preset Response - Update
Queue Request - Update
Queue Response - Vc3Settings
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VC3
- 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. * AV1, Av1Settings * AVCINTRA, AvcIntraSettings * FRAMECAPTURE, FrameCaptureSettings * H264, H264Settings * H265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings
- Video
Description Settings related to video encoding of your output. The specific video settings depend on the video codec that you choose. When you work directly in your JSON job specification, include one instance of Video description (VideoDescription) per output.
- 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 Input video selectors contain the video settings for the input. Each of your inputs can have up to one video selector.
- 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.
- Webvtt
Destination Settings WEBVTT Destination Settings
- Webvtt
HlsSource Settings Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.
- Xavc4k
Intra CbgProfile Settings Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC4KINTRA_CBG.
- Xavc4k
Intra VbrProfile Settings Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC4KINTRA_VBR.
- Xavc4k
Profile Settings Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_4K.
- Xavc
HdIntra CbgProfile Settings Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVCHDINTRA_CBG.
- Xavc
HdProfile Settings Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_HD.
- Xavc
Settings Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value XAVC.
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.