AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class 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.

Class Ac3Settings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AC3.

Class AiffSettings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF.

Class AncillarySourceSettings

Settings for ancillary captions source.

Class AudioCodecSettings

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 you choose for Audio codec (Codec). For each codec enum you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings

Class AudioDescription

Description of audio output

Class AudioNormalizationSettings

Advanced audio normalization settings.

Class AudioSelector

Selector for Audio

Class AudioSelectorGroup

Group of Audio Selectors

Class AvailBlanking

Settings for Avail Blanking

Class BadRequestException

MediaConvert exception

Class BurninDestinationSettings

Burn-In Destination Settings.

Class CancelJobRequest

Container for the parameters to the CancelJob operation. Permanently remove a job from a queue. Once you have canceled a job, you can't start it again. You can't delete a running job.

Class CancelJobResponse

This is the response object from the CancelJob operation.

Class CaptionDescription

Description of Caption output

Class CaptionDescriptionPreset

Caption Description for preset

Class CaptionDestinationSettings

Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.

Class CaptionSelector

Set up captions in your outputs by first selecting them from your input here.

Class CaptionSourceSettings

Source settings (SourceSettings) contains the group of settings for captions in the input.

Class ChannelMapping

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).

Class CmafEncryptionSettings

Settings for CMAF encryption

Class CmafGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output.

Class ColorCorrector

Settings for color correction.

Class ConflictException

MediaConvert exception

Class ContainerSettings

Container specific settings.

Class CreateJobRequest

Container for the parameters to the CreateJob operation. Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Class CreateJobResponse

This is the response object from the CreateJob operation.

Class CreateJobTemplateRequest

Container for the parameters to the CreateJobTemplate operation. Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Class CreateJobTemplateResponse

This is the response object from the CreateJobTemplate operation.

Class CreatePresetRequest

Container for the parameters to the CreatePreset operation. Create a new preset. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Class CreatePresetResponse

This is the response object from the CreatePreset operation.

Class CreateQueueRequest

Container for the parameters to the CreateQueue operation. Create a new transcoding queue. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Class CreateQueueResponse

This is the response object from the CreateQueue operation.

Class DashIsoEncryptionSettings

Specifies DRM settings for DASH outputs.

Class DashIsoGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASH_ISO_GROUP_SETTINGS.

Class Deinterlacer

Settings for deinterlacer

Class DeleteJobTemplateRequest

Container for the parameters to the DeleteJobTemplate operation. Permanently delete a job template you have created.

Class DeleteJobTemplateResponse

This is the response object from the DeleteJobTemplate operation.

Class DeletePresetRequest

Container for the parameters to the DeletePreset operation. Permanently delete a preset you have created.

Class DeletePresetResponse

This is the response object from the DeletePreset operation.

Class DeleteQueueRequest

Container for the parameters to the DeleteQueue operation. Permanently delete a queue you have created.

Class DeleteQueueResponse

This is the response object from the DeleteQueue operation.

Class DescribeEndpointsRequest

Container for the parameters to the DescribeEndpoints operation. Send an request with an empty body to the regional API endpoint to get your account API endpoint.

Class DescribeEndpointsResponse

This is the response object from the DescribeEndpoints operation.

Class DvbNitSettings

Inserts DVB Network Information Table (NIT) at the specified table repetition interval.

Class DvbSdtSettings

Inserts DVB Service Description Table (NIT) at the specified table repetition interval.

Class DvbSubDestinationSettings

DVB-Sub Destination Settings

Class DvbSubSourceSettings

DVB Sub Source Settings

Class DvbTdtSettings

Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.

Class Eac3Settings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3.

Class EmbeddedSourceSettings

Settings for embedded captions Source

Class Endpoint

Describes account specific API endpoint

Class F4vSettings

Settings for F4v container

Class FileGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to FILE_GROUP_SETTINGS.

Class FileSourceSettings

Settings for File-based Captions in Source

Class ForbiddenException

MediaConvert exception

Class FrameCaptureSettings

Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.

Class GetJobRequest

Container for the parameters to the GetJob operation. Retrieve the JSON for a specific completed transcoding job.

Class GetJobResponse

This is the response object from the GetJob operation.

Class GetJobTemplateRequest

Container for the parameters to the GetJobTemplate operation. Retrieve the JSON for a specific job template.

Class GetJobTemplateResponse

This is the response object from the GetJobTemplate operation.

Class GetPresetRequest

Container for the parameters to the GetPreset operation. Retrieve the JSON for a specific preset.

Class GetPresetResponse

This is the response object from the GetPreset operation.

Class GetQueueRequest

Container for the parameters to the GetQueue operation. Retrieve the JSON for a specific queue.

Class GetQueueResponse

This is the response object from the GetQueue operation.

Class H264QvbrSettings

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.

Class H264Settings

Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264.

Class H265QvbrSettings

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.

Class H265Settings

Settings for H265 codec

Class Hdr10Metadata

Use the HDR master display (Hdr10Metadata) settings to correct HDR metadata or to provide missing metadata. These values vary depending on the input video and must be provided by a color grader. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that these settings are not color correction. Note that if you are creating HDR outputs inside of an HLS CMAF package, to comply with the Apple specification, you must use the HVC1 for H.265 setting.

Class HlsCaptionLanguageMapping

Caption Language Mapping

Class HlsEncryptionSettings

Settings for HLS encryption

Class HlsGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS.

Class HlsSettings

Settings for HLS output groups

Class 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).

Class ImageInserter

Enable the Image inserter (ImageInserter) feature to include a graphic overlay on your video. Enable or disable this feature for each output individually. This setting is disabled by default.

Class Input

Specifies media input

Class InputClipping

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.

Class InputTemplate

Specified video input in a template.

Class InsertableImage

Settings for Insertable Image

Class InternalServerErrorException

MediaConvert exception

Class 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

Class JobSettings

JobSettings contains all the transcode settings for a job.

Class JobTemplate

A job template is a pre-made set of encoding instructions that you can use to quickly create a job.

Class JobTemplateSettings

JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.

Class ListJobsRequest

Container for the parameters to the ListJobs operation. Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.

Class ListJobsResponse

This is the response object from the ListJobs operation.

Class ListJobTemplatesRequest

Container for the parameters to the ListJobTemplates operation. Retrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array

Class ListJobTemplatesResponse

This is the response object from the ListJobTemplates operation.

Class ListPresetsRequest

Container for the parameters to the ListPresets operation. Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array.

Class ListPresetsResponse

This is the response object from the ListPresets operation.

Class ListQueuesRequest

Container for the parameters to the ListQueues operation. Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array.

Class ListQueuesResponse

This is the response object from the ListQueues operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Retrieve the tags for a MediaConvert resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class M2tsSettings

Settings for M2TS Container.

Class M3u8Settings

Settings for TS segments in HLS

Class MovSettings

Settings for MOV Container.

Class Mp2Settings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2.

Class Mp4Settings

Settings for MP4 Container

Class Mpeg2Settings

Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value MPEG2.

Class MsSmoothEncryptionSettings

If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider.

Class MsSmoothGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to MS_SMOOTH_GROUP_SETTINGS.

Class NielsenConfiguration

Settings for Nielsen Configuration

Class NoiseReducer

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).

Class NoiseReducerFilterSettings

Settings for a noise reducer filter

Class NoiseReducerSpatialFilterSettings

Noise reducer filter settings for spatial filter.

Class NotFoundException

MediaConvert exception

Class Output

An output object describes the settings for a single output file or stream in an output group.

Class OutputChannelMapping

OutputChannel mapping settings.

Class OutputDetail

Details regarding output

Class OutputGroup

Group of outputs

Class OutputGroupDetail

Contains details about the output groups specified in the job settings.

Class OutputGroupSettings

Output Group settings, including type

Class OutputSettings

Specific settings for this type of output.

Class Preset

A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.

Class PresetSettings

Settings for preset

Class ProresSettings

Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES.

Class Queue

MediaConvert jobs are submitted to a queue. Unless specified otherwise jobs are submitted to a built-in default queue. User can create additional queues to separate the jobs of different categories or priority.

Class Rectangle

Use Rectangle to identify a specific area of the video frame.

Class RemixSettings

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.

Class ResourceTags

The Amazon Resource Name (ARN) and tags for an AWS Elemental MediaConvert resource.

Class SccDestinationSettings

Settings for SCC caption output.

Class SpekeKeyProvider

Settings for use with a SPEKE key provider

Class StaticKeyProvider

Settings for use with a SPEKE key provider.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Tag a MediaConvert queue, preset, or job template. For information about these resource types, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Class TagResourceResponse

This is the response object from the TagResource operation.

Class TeletextDestinationSettings

Settings for Teletext caption output

Class TeletextSourceSettings

Settings specific to Teletext caption sources, including Page number.

Class TimecodeBurnin

Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified prefix into the output.

Class TimecodeConfig

These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.

Class TimedMetadataInsertion

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.

Class Timing

Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.

Class TooManyRequestsException

MediaConvert exception

Class TtmlDestinationSettings

Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough).

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Untag a MediaConvert queue, preset, or job template. For information about these resource types, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateJobTemplateRequest

Container for the parameters to the UpdateJobTemplate operation. Modify one of your existing job templates.

Class UpdateJobTemplateResponse

This is the response object from the UpdateJobTemplate operation.

Class UpdatePresetRequest

Container for the parameters to the UpdatePreset operation. Modify one of your existing presets.

Class UpdatePresetResponse

This is the response object from the UpdatePreset operation.

Class UpdateQueueRequest

Container for the parameters to the UpdateQueue operation. Modify one of your existing queues.

Class UpdateQueueResponse

This is the response object from the UpdateQueue operation.

Class VideoCodecSettings

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 you choose for Video codec (Codec). For each codec enum you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * FRAME_CAPTURE, FrameCaptureSettings

Class VideoDescription

Settings for video outputs

Class VideoDetail

Contains details about the output's video stream

Class VideoPreprocessor

Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.

Class VideoSelector

Selector for video.

Class WavSettings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV.