Expand description
Structs§
- 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
Artworkto null, or set theMerge Policyto "Replace" and use an emptyArtworkarray.To pass through existing artwork unchanged, set the
Merge Policyto "Prepend", "Append", or "Fallback", and use an emptyArtworkarray.- Audio
Codec Options Options associated with your audio codec.
- Audio
Parameters Parameters required for transcoding audio.
- Cancel
JobRequest The
CancelJobRequeststructure.- Cancel
JobResponse The response body contains a JSON object. If the job is successfully canceled, the value of
Successistrue.- Caption
Format The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error.
- Caption
Source A source file for the input sidecar captions used during the transcoding process.
- Captions
The captions to be created, if any.
- Clip
Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.
- Create
JobOutput The
CreateJobOutputstructure.- Create
JobPlaylist Information about the master playlist.
- Create
JobRequest The
CreateJobRequeststructure.- Create
JobResponse The CreateJobResponse structure.
- Create
Pipeline Request The
CreatePipelineRequeststructure.- Create
Pipeline Response When you create a pipeline, Elastic Transcoder returns the values that you specified in the request.
- Create
Preset Request The
CreatePresetRequeststructure.- Create
Preset Response The
CreatePresetResponsestructure.- Delete
Pipeline Request The
DeletePipelineRequeststructure.- Delete
Pipeline Response The
DeletePipelineResponsestructure.- Delete
Preset Request The
DeletePresetRequeststructure.- Delete
Preset Response The
DeletePresetResponsestructure.- Detected
Properties The detected properties of the input file. Elastic Transcoder identifies these values from the input file.
- Encryption
The encryption settings, if any, that are used for decrypting your input files or encrypting your output files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file, otherwise you must specify the mode you want Elastic Transcoder to use to encrypt your output files.
- EtsClient
- A client for the Amazon Elastic Transcoder API.
- HlsContent
Protection The HLS content protection settings, if any, that you want Elastic Transcoder to apply to your output files.
- Input
Captions The captions to be created, if any.
- Job
A section of the response body that provides information about the job that is created.
- JobAlbum
Art 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
Outputobject lists information about the first output. This duplicates the information that is listed for the first output in theOutputsobject.- 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.
- List
Jobs ByPipeline Request The
ListJobsByPipelineRequeststructure.- List
Jobs ByPipeline Response The
ListJobsByPipelineResponsestructure.- List
Jobs ByStatus Request The
ListJobsByStatusRequeststructure.- List
Jobs ByStatus Response The
ListJobsByStatusResponsestructure.- List
Pipelines Request The
ListPipelineRequeststructure.- List
Pipelines Response A list of the pipelines associated with the current AWS account.
- List
Presets Request The
ListPresetsRequeststructure.- List
Presets Response The
ListPresetsResponsestructure.- 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
Permissionstructure.- Pipeline
The pipeline (queue) that is used to manage jobs.
- Pipeline
Output Config The
PipelineOutputConfigstructure.- Play
Ready Drm The PlayReady DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
PlayReady DRM encrypts your media files using
aes-ctrencryption.If you use DRM for an
HLSv3playlist, your outputs must have a master playlist.- Playlist
Use Only for Fragmented MP4 or MPEG-TS Outputs. If you specify a preset for which the value of Container is
fmp4(Fragmented MP4) orts(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 per output format. 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.
- Preset
Watermark 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.
- Read
JobRequest The
ReadJobRequeststructure.- Read
JobResponse The
ReadJobResponsestructure.- Read
Pipeline Request The
ReadPipelineRequeststructure.- Read
Pipeline Response The
ReadPipelineResponsestructure.- Read
Preset Request The
ReadPresetRequeststructure.- Read
Preset Response The
ReadPresetResponsestructure.- Test
Role Request The
TestRoleRequeststructure.- Test
Role Response The
TestRoleResponsestructure.- Thumbnails
Thumbnails for videos.
- Time
Span Settings that determine when a clip begins and how long it lasts.
- Timing
Details about the timing of a job.
- Update
Pipeline Notifications Request The
UpdatePipelineNotificationsRequeststructure.- Update
Pipeline Notifications Response The
UpdatePipelineNotificationsResponsestructure.- Update
Pipeline Request The
UpdatePipelineRequeststructure.- Update
Pipeline Response When you update a pipeline, Elastic Transcoder returns the values that you specified in the request.
- Update
Pipeline Status Request The
UpdatePipelineStatusRequeststructure.- Update
Pipeline Status Response When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request.
- Video
Parameters The
VideoParametersstructure.- Warning
Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.
Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.
Enums§
- Cancel
JobError - Errors returned by CancelJob
- Create
JobError - Errors returned by CreateJob
- Create
Pipeline Error - Errors returned by CreatePipeline
- Create
Preset Error - Errors returned by CreatePreset
- Delete
Pipeline Error - Errors returned by DeletePipeline
- Delete
Preset Error - Errors returned by DeletePreset
- List
Jobs ByPipeline Error - Errors returned by ListJobsByPipeline
- List
Jobs ByStatus Error - Errors returned by ListJobsByStatus
- List
Pipelines Error - Errors returned by ListPipelines
- List
Presets Error - Errors returned by ListPresets
- Read
JobError - Errors returned by ReadJob
- Read
Pipeline Error - Errors returned by ReadPipeline
- Read
Preset Error - Errors returned by ReadPreset
- Test
Role Error - Errors returned by TestRole
- Update
Pipeline Error - Errors returned by UpdatePipeline
- Update
Pipeline Notifications Error - Errors returned by UpdatePipelineNotifications
- Update
Pipeline Status Error - Errors returned by UpdatePipelineStatus
Traits§
- Ets
- Trait representing the capabilities of the Amazon Elastic Transcoder API. Amazon Elastic Transcoder clients implement this trait.