AWS SDK for .NET Documentation
Amazon.ElasticTranscoder.Model Namespace
AmazonAmazon.ElasticTranscoder.Model Did this page help you?   Yes   No    Tell us about it...
 
Declaration Syntax
C#
namespace Amazon.ElasticTranscoder.Model
Types
All TypesClasses
IconTypeDescription
AccessDeniedException
ElasticTranscoder exception

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

To remove artwork or leave the artwork empty, you can either set

CopyC#
Artwork
to null, or set the
CopyC#
Merge Policy
to "Replace" and use an empty
CopyC#
Artwork
array.

To pass through existing artwork unchanged, set the

CopyC#
Merge Policy
to "Prepend", "Append", or "Fallback", and use an empty
CopyC#
Artwork
array.


AudioCodecOptions
Options associated with your audio codec.

AudioParameters
Parameters required for transcoding audio.

CancelJobRequest
Container for the parameters to the CancelJob operation. The CancelJob operation cancels an unfinished job.
Note:
You can only cancel a job that has a status of
CopyC#
Submitted
. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline.

CancelJobResponse
Returns information about the CancelJobResult response and response metadata.

CancelJobResult
The response body contains a JSON object. If the job is successfully canceled, the value of
CopyC#
Success
is
CopyC#
true
.

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

Captions
The captions to be created, if any.

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

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

CreateJobOutput
The
CopyC#
CreateJobOutput
structure.

CreateJobPlaylist
Information about the master playlist.

CreateJobRequest
Container for the parameters to the CreateJob operation. When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created.

If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console).


CreateJobResponse
Returns information about the CreateJobResult response and response metadata.

CreateJobResult
The CreateJobResponse structure.

CreatePipelineRequest
Container for the parameters to the CreatePipeline operation. The CreatePipeline operation creates a pipeline with settings that you specify.

CreatePipelineResponse
Returns information about the CreatePipelineResult response and response metadata.

CreatePipelineResult
When you create a pipeline, Elastic Transcoder returns the values that you specified in the request.

CreatePresetRequest
Container for the parameters to the CreatePreset operation. The CreatePreset operation creates a preset with settings that you specify. Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (
CopyC#
ValidationException
) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces.

Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services.


CreatePresetResponse
Returns information about the CreatePresetResult response and response metadata.

CreatePresetResult
The
CopyC#
CreatePresetResponse
structure.

DeletePipelineRequest
Container for the parameters to the DeletePipeline operation. The DeletePipeline operation removes a pipeline.

You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use,

CopyC#
DeletePipeline
returns an error.


DeletePipelineResponse
Returns information about the DeletePipelineResult response and response metadata.

DeletePipelineResult
The
CopyC#
DeletePipelineResponse
structure.

DeletePresetRequest
Container for the parameters to the DeletePreset operation. The DeletePreset operation removes a preset that you've added in an AWS region.
Note:

You can't delete the default presets that are included with Elastic Transcoder.


DeletePresetResponse
Returns information about the DeletePresetResult response and response metadata.

DeletePresetResult
The
CopyC#
DeletePresetResponse
structure.

IncompatibleVersionException
ElasticTranscoder exception

InternalServiceException
ElasticTranscoder exception

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

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

JobInput
Information about the file that you're transcoding.

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

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

LimitExceededException
ElasticTranscoder exception

ListJobsByPipelineRequest
Container for the parameters to the ListJobsByPipeline operation. The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.

Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria.


ListJobsByPipelineResponse
Returns information about the ListJobsByPipelineResult response and response metadata.

ListJobsByPipelineResult
The
CopyC#
ListJobsByPipelineResponse
structure.

ListJobsByStatusRequest
Container for the parameters to the ListJobsByStatus operation. The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.

ListJobsByStatusResponse
Returns information about the ListJobsByStatusResult response and response metadata.

ListJobsByStatusResult
The
CopyC#
ListJobsByStatusResponse
structure.

ListPipelinesRequest
Container for the parameters to the ListPipelines operation. The ListPipelines operation gets a list of the pipelines associated with the current AWS account.

ListPipelinesResponse
Returns information about the ListPipelinesResult response and response metadata.

ListPipelinesResult
A list of the pipelines associated with the current AWS account.

ListPresetsRequest
Container for the parameters to the ListPresets operation. The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region.

ListPresetsResponse
Returns information about the ListPresetsResult response and response metadata.

ListPresetsResult
The
CopyC#
ListPresetsResponse
structure.

Notifications
The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

Permission
The
CopyC#
Permission
structure.

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

PipelineOutputConfig
The
CopyC#
PipelineOutputConfig
structure.

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

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

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

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

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


ReadJobRequest
Container for the parameters to the ReadJob operation. The ReadJob operation returns detailed information about a job.

ReadJobResponse
Returns information about the ReadJobResult response and response metadata.

ReadJobResult
The
CopyC#
ReadJobResponse
structure.

ReadPipelineRequest
Container for the parameters to the ReadPipeline operation. The ReadPipeline operation gets detailed information about a pipeline.

ReadPipelineResponse
Returns information about the ReadPipelineResult response and response metadata.

ReadPipelineResult
The
CopyC#
ReadPipelineResponse
structure.

ReadPresetRequest
Container for the parameters to the ReadPreset operation. The ReadPreset operation gets detailed information about a preset.

ReadPresetResponse
Returns information about the ReadPresetResult response and response metadata.

ReadPresetResult
The
CopyC#
ReadPresetResponse
structure.

ResourceInUseException
ElasticTranscoder exception

ResourceNotFoundException
ElasticTranscoder exception

TestRoleRequest
Container for the parameters to the TestRole operation. The TestRole operation tests the IAM role used to create the pipeline.

The

CopyC#
TestRole
action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify.


TestRoleResponse
Returns information about the TestRoleResult response and response metadata.

TestRoleResult
The
CopyC#
TestRoleResponse
structure.

Thumbnails
Thumbnails for videos.

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

UpdatePipelineNotificationsRequest
Container for the parameters to the UpdatePipelineNotifications operation. With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.

When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.


UpdatePipelineNotificationsResponse
Returns information about the UpdatePipelineNotificationsResult response and response metadata.

UpdatePipelineNotificationsResult
The
CopyC#
UpdatePipelineNotificationsResponse
structure.

UpdatePipelineRequest
Container for the parameters to the UpdatePipeline operation. Use the
CopyC#
UpdatePipeline
operation to update settings for a pipeline. When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.

UpdatePipelineResponse
Returns information about the UpdatePipelineResult response and response metadata.

UpdatePipelineResult
When you update a pipeline, Elastic Transcoder returns the values that you specified in the request.

UpdatePipelineStatusRequest
Container for the parameters to the UpdatePipelineStatus operation. The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.

Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.


UpdatePipelineStatusResponse
Returns information about the UpdatePipelineStatusResult response and response metadata.

UpdatePipelineStatusResult
When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request.

ValidationException
ElasticTranscoder exception

VideoParameters
The
CopyC#
VideoParameters
structure.