String inputKey
PipelineId
; the
InputBucket
object in that pipeline identifies the
bucket. If the file name includes a prefix, for example,
cooking/pie.jpg
, include the prefix in the key. If the
file isn't in the specified bucket, Elastic Transcoder returns an
error.
Constraints:
Length: 1 - 255
Pattern: (^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)
String maxWidth
auto
, Elastic Transcoder uses 600 as the default value.
If you specify a numeric value, enter an even integer between 32 and
4096, inclusive.
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
String maxHeight
auto
, Elastic Transcoder uses 600 as the default value.
If you specify a numeric value, enter an even integer between 32 and
3072, inclusive.
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
String sizingPolicy
Fit:
Elastic Transcoder scales
the output art so it matches the value that you specified in either
MaxWidth
or MaxHeight
without exceeding the
other value.Fill:
Elastic Transcoder scales the
output art so it matches the value that you specified in either
MaxWidth
or MaxHeight
and matches or exceeds
the other value. Elastic Transcoder centers the output art and then
crops it in the dimension (if any) that exceeds the maximum value.
Stretch:
Elastic Transcoder stretches the
output art to match the values that you specified for
MaxWidth
and MaxHeight
. If the relative
proportions of the input art and the output art are different, the
output art will be distorted.Keep:
Elastic
Transcoder does not scale the output art. If either dimension of the
input art exceeds the values that you specified for
MaxWidth
and MaxHeight
, Elastic Transcoder
crops the output art.ShrinkToFit:
Elastic
Transcoder scales the output art down so that its dimensions match the
values that you specified for at least one of MaxWidth
and MaxHeight
without exceeding either value. If you
specify this option, Elastic Transcoder does not scale the art
up.ShrinkToFill
Elastic Transcoder scales the
output art down so that its dimensions match the values that you
specified for at least one of MaxWidth
and
MaxHeight
without dropping below either value. If you
specify this option, Elastic Transcoder does not scale the art
up.
Constraints:
Pattern: (^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)
String paddingPolicy
PaddingPolicy
to Pad
, Elastic
Transcoder may add white bars to the top and bottom and/or left and
right sides of the output album art to make the total size of the
output art match the values that you specified for
MaxWidth
and MaxHeight
.
Constraints:
Pattern: (^Pad$)|(^NoPad$)
String albumArtFormat
.jpg
and .png
.
Constraints:
Pattern: (^jpg$)|(^png$)
String profile
Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:
auto
: If you specify auto
, Elastic
Transcoder will select the profile based on the bit rate selected for
the output file.AAC-LC
: The most common AAC
profile. Use for bitrates larger than 64 kbps.HE-AAC
: Not supported on some older players and
devices. Use for bitrates between 40 and 80 kbps.HE-AACv2
: Not supported on some players and devices.
Use for bitrates less than 48 kbps.If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets to use AAC-LC. You can change the value as required.
Constraints:
Pattern: (^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)
String codec
aac
, mp3
, and vorbis
.
Constraints:
Pattern: (^AAC$)|(^vorbis$)|(^mp3$)
String sampleRate
auto
, 22050
,
32000
, 44100
, 48000
,
96000
If you specify auto
, Elastic
Transcoder automatically detects the sample rate.
Constraints:
Pattern: (^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)
String bitRate
Constraints:
Pattern: ^\d{1,3}$
String channels
auto
, 0
, 1
, 2
If you specify auto
, Elastic Transcoder automatically
detects the number of channels in the input file.
Constraints:
Pattern: (^auto$)|(^0$)|(^1$)|(^2$)
AudioCodecOptions codecOptions
AAC
for Audio:Codec
, this
is the AAC
compression profile to use. Valid values
include: auto
, AAC-LC
,
HE-AAC
, HE-AACv2
If you specify
auto
, Elastic Transcoder chooses a profile based on the
bit rate of the output file.
String id
To get a list of
the jobs (including their jobId
) that have a status of
Submitted
, use the ListJobsByStatus API action.
Constraints:
Pattern: ^\d{13}-\w{6}$
String format
Valid Embedded Caption Formats:
For MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. There are no container restrictions on sidecar captions. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Constraints:
Pattern: (^mov-text$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)
String pattern
{language}
, where: {language}
is a literal value that Elastic Transcoder
replaces with the two- or three-letter code for the language of the
caption in the output file names.If you don't include
{language}
in the file name pattern, Elastic Transcoder
automatically appends "{language}
" to the value that you
specify for the description. In addition, Elastic Transcoder
automatically appends the count to the end of the segment files.
For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
Constraints:
Pattern: (^$)|(^.*\{language\}.*$)
String mergePolicy
MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded
and sidecar captions into outputs. If captions for a language are
embedded in the input file and also appear in a sidecar file, Elastic
Transcoder uses the embedded captions and ignores the sidecar captions
for that language. If
Override: Elastic Transcoder transcodes only
the sidecar captions that you specify in
CaptionSources
.
MergePolicy
cannot be null.
Constraints:
Pattern: (^MergeOverride$)|(^MergeRetain$)|(^Override$)
ListWithAutoConstructFlag<T> captionSources
CaptionSources
blank.
Constraints:
Length: 0 - 20
ListWithAutoConstructFlag<T> captionFormats
Constraints:
Length: 0 - 4
String key
Constraints:
Length: 1 - 255
String language
2-character ISO 639-1 code
3-character ISO 639-2 code
For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
Constraints:
Length: 1 - 255
String timeOffset
TimeOffset
tells Elastic
Transcoder how much of the video to encode before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
Constraints:
Pattern: (^[+-]?\d{1,5}(\.\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\.\d{0,3})?$)
String label
Constraints:
Length: 1 - 40
TimeSpan timeSpan
String key
OutputBucket
object in the pipeline that is specified by
the pipeline ID. If a file with the specified name already exists in
the output bucket, the job fails.
Constraints:
Length: 1 - 255
String thumbnailPattern
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count}
(Required): If you want to
create thumbnails, you must include {count}
in the
ThumbnailPattern
object. Wherever you specify
{count}
, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The
number indicates where a given thumbnail appears in the sequence of
thumbnails for a transcoded file. {resolution}
but you omit
{count}
, Elastic Transcoder returns a validation error
and does not create the job.
Literal
values (Optional): You can specify literal values anywhere in the
ThumbnailPattern
object. For example, you can include
them as a file name prefix or as a delimiter between
{resolution}
and {count}
.
{resolution}
(Optional): If you want Elastic
Transcoder to include the resolution in the file name, include
{resolution}
in the ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder
automatically saves the files in the format (.jpg or .png) that
appears in the preset that you specified in the PresetID
value of CreateJobOutput
. Elastic Transcoder also appends
the applicable file name extension.
Constraints:
Pattern: (^$)|(^.*\{count\}.*$)
String rotate
auto
, 0
, 90
,
180
, 270
. The value auto
generally works only if the file that you're transcoding contains
rotation metadata.
Constraints:
Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)
String presetId
Id
of the preset to use for this job. The preset
determines the audio, video, and thumbnail settings that Elastic
Transcoder uses for transcoding.
Constraints:
Pattern: ^\d{13}-\w{6}$
String segmentDuration
PresetId
for which the value
of Container
is ts (MPEG-TS), SegmentDuration is the
duration of each .ts file in seconds. The range of valid values is 1
to 60 seconds.
Constraints:
Pattern: ^\d{1,5}(\.\d{0,5})?$
ListWithAutoConstructFlag<T> watermarks
JobAlbumArt albumArt
ListWithAutoConstructFlag<T> composition
Captions captions
Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include: CEA-608
(EIA-608
, first non-empty channel only), CEA-708
(EIA-708
, first non-empty channel only), and
mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include:
dfxp
(first div element only), ebu-tt
,
scc
, smpt
, srt
,
ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only),
scc
, srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or
leave the captions empty, set Captions
to null. To pass
through existing captions unchanged, set the MergePolicy
to MergeRetain
, and pass in a null
CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
String name
Name
objects must be
unique. Elastic Transcoder automatically appends .m3u8 to the file
name. If you include .m3u8 in Name
, it will appear twice
in the file name.
Constraints:
Length: 1 - 255
String format
Constraints:
Pattern: (^HLSv3$)
ListWithAutoConstructFlag<T> outputKeys
Outputs:Key
object. If you
include more than one output in a playlist, the value of
SegmentDuration
for all of the outputs must be the same.
Constraints:
Length: 0 - 30
String pipelineId
Id
of the pipeline that you want Elastic Transcoder
to use for transcoding. The pipeline determines several settings,
including the Amazon S3 bucket from which Elastic Transcoder gets the
files to transcode and the bucket into which Elastic Transcoder puts
the transcoded files.
Constraints:
Pattern: ^\d{13}-\w{6}$
JobInput input
CreateJobOutput output
CreateJobOutput
structure.ListWithAutoConstructFlag<T> outputs
Outputs
syntax instead of the Output
syntax.
Constraints:
Length: 0 - 30
String outputKeyPrefix
Constraints:
Length: 1 - 255
ListWithAutoConstructFlag<T> playlists
PresetId
for which the value
of Container
is 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.
Constraints:
Length: 0 - 30
Job job
String name
Constraints: Maximum 40 characters.
Constraints:
Length: 1 - 40
String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String outputBucket
Specify this value when all of the following are true:
OutputBucket
, it grants full control over the files only
to the AWS account that owns the role that is specified by
Role
.If you want to save transcoded files and
playlists in one bucket and thumbnails in another bucket, specify
which users can access the transcoded files or the permissions the
users have, or change the Amazon S3 storage class, omit
OutputBucket
and specify values for
ContentConfig
and ThumbnailConfig
instead.
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
Notifications notifications
PipelineOutputConfig contentConfig
ContentConfig
object specifies information
about the Amazon S3 bucket in which you want Elastic Transcoder to
save transcoded files and playlists: which bucket to use, which users
you want to have access to the files, the type of access you want
users to have, and the storage class that you want to assign to the
files. If you specify values for ContentConfig
, you
must also specify values for ThumbnailConfig
.
If you
specify values for ContentConfig
and
ThumbnailConfig
, omit the OutputBucket
object.
Grantee
object: Grantee
object is either the canonical user ID for an
AWS account or an origin access identity for an Amazon CloudFront
distribution. For more information about canonical user IDs, see
Access Control List (ACL) Overview in the Amazon Simple Storage
Service Developer Guide. For more information about using CloudFront
origin access identities to require that users use CloudFront URLs
instead of Amazon S3 URLs, see Using an Origin Access Identity to
Restrict Access to Your Amazon S3 Content. Grantee
object is the
registered email address of an AWS account.Grantee
object is one of the following
predefined Amazon S3 groups: AllUsers
,
AuthenticatedUsers
, or LogDelivery
.Grantee
. Permissions are
granted on the files that Elastic Transcoder adds to the bucket,
including playlists and video files. Valid values include: READ
: The grantee can read the objects and metadata
for objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for
objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP
: The grantee can write the ACL for the
objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,
READ_ACP
, and WRITE_ACP
permissions for the
objects that Elastic Transcoder adds to the Amazon S3 bucket.Standard
or ReducedRedundancy
, that you want
Elastic Transcoder to assign to the video files and playlists that it
stores in your Amazon S3 bucket.PipelineOutputConfig thumbnailConfig
ThumbnailConfig
object specifies several values,
including the Amazon S3 bucket in which you want Elastic Transcoder to
save thumbnail files, which users you want to have access to the
files, the type of access you want users to have, and the storage
class that you want to assign to the files. If you specify values
for ContentConfig
, you must also specify values for
ThumbnailConfig
even if you don't want to create
thumbnails.
If you specify values for ContentConfig
and ThumbnailConfig
, omit the OutputBucket
object.
Permissions
object
specifies which users and/or predefined Amazon S3 groups you want to
have access to thumbnail files, and the type of access you want them
to have. You can grant permissions to a maximum of 30 users and/or
predefined Amazon S3 groups.Grantee
object is
either the canonical user ID for an AWS account or an origin access
identity for an Amazon CloudFront distribution. Grantee
object is the
registered email address of an AWS account. Grantee
object is one of the following
predefined Amazon S3 groups: AllUsers
,
AuthenticatedUsers
, or LogDelivery
.Grantee
. Permissions are granted on
the thumbnail files that Elastic Transcoder adds to the bucket. Valid
values include: READ
: The grantee can read the
thumbnails and metadata for objects that Elastic Transcoder adds to
the Amazon S3 bucket.READ_ACP
: The grantee can
read the object ACL for thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket. WRITE_ACP
: The grantee can
write the ACL for the thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket.FULL_CONTROL
: The grantee has
READ
, READ_ACP
, and WRITE_ACP
permissions for the thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket. Standard
or
ReducedRedundancy
, that you want Elastic Transcoder to
assign to the thumbnails that it stores in your Amazon S3 bucket.Pipeline pipeline
String name
Constraints:
Length: 1 - 40
String description
Constraints:
Length: 0 - 255
String container
mp3
, mp4
, ogg
, ts
,
and webm
.
Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)
VideoParameters video
AudioParameters audio
Thumbnails thumbnails
Preset preset
String warning
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String arn
String pipelineId
Id
of the pipeline that you want Elastic Transcoder
to use for transcoding. The pipeline determines several settings,
including the Amazon S3 bucket from which Elastic Transcoder gets the
files to transcode and the bucket into which Elastic Transcoder puts
the transcoded files.
Constraints:
Pattern: ^\d{13}-\w{6}$
JobInput input
JobOutput output
ListWithAutoConstructFlag<T> outputs
Outputs
syntax for all jobs, even when you want Elastic
Transcoder to transcode a file into only one format. Do not use both
the Outputs
and Output
syntaxes in the same
request. You can create a maximum of 30 outputs per job. If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
String outputKeyPrefix
OutputKeyPrefix
.
Constraints:
Length: 1 - 255
ListWithAutoConstructFlag<T> playlists
PresetId
for which the value of
Container
is 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.
String status
Submitted
,
Progressing
, Complete
,
Canceled
, or Error
.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
String mergePolicy
Replace:
The specified album art will replace any
existing album art.Prepend:
The specified album
art will be placed in front of any existing album art.Append:
The specified album art will be placed after
any existing album art.Fallback:
If the
original input file contains artwork, Elastic Transcoder will use that
artwork for the output. If the original input does not contain
artwork, Elastic Transcoder will use the specified album art
file.
Constraints:
Pattern: (^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)
ListWithAutoConstructFlag<T> artwork
.jpg
and .png
String key
InputBucket
object in that pipeline tells Elastic
Transcoder which Amazon S3 bucket to get the file from. If the file
name includes a prefix, such as cooking/lasagna.mpg
,
include the prefix in the key. If the file isn't in the specified
bucket, Elastic Transcoder returns an error.
Constraints:
Length: 1 - 255
String frameRate
auto
. If you want to specify the frame rate for the input
file, enter one of the following values: 10
,
15
, 23.97
, 24
, 25
,
29.97
, 30
, 60
If you specify
a value other than auto
, Elastic Transcoder disables
automatic detection of the frame rate.
Constraints:
Pattern: (^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)
String resolution
auto
, which causes Elastic Transcoder
to automatically detect the resolution of the input file.
Constraints:
Pattern: (^auto$)|(^\d{1,5}x\d{1,5}$)
String aspectRatio
auto
. If you want to specify the aspect ratio for the
output file, enter one of the following values: 1:1
,
4:3
, 3:2
, 16:9
If you
specify a value other than auto
, Elastic Transcoder
disables automatic detection of the aspect ratio.
Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
String interlaced
auto
. If you want to specify whether the input file is
interlaced, enter one of the following values: true
,
false
If you specify a value other than
auto
, Elastic Transcoder disables automatic detection of
interlacing.
Constraints:
Pattern: (^auto$)|(^true$)|(^false$)
String container
auto
. If you want to specify the container type for the
input file, enter one of the following values: 3gp
,
aac
, asf
, avi
,
divx
, flv
, m4a
,
mkv
, mov
, mp3
,
mp4
, mpeg
, mpeg-ps
,
mpeg-ts
, mxf
, ogg
,
vob
, wav
, webm
Constraints:
Pattern: (^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)
String id
String key
OutputBucket
object in the pipeline that is specified by
the pipeline ID.
Constraints:
Length: 1 - 255
String thumbnailPattern
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count}
(Required): If you want to
create thumbnails, you must include {count}
in the
ThumbnailPattern
object. Wherever you specify
{count}
, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The
number indicates where a given thumbnail appears in the sequence of
thumbnails for a transcoded file. {resolution}
but you omit
{count}
, Elastic Transcoder returns a validation error
and does not create the job.
Literal
values (Optional): You can specify literal values anywhere in the
ThumbnailPattern
object. For example, you can include
them as a file name prefix or as a delimiter between
{resolution}
and {count}
.
{resolution}
(Optional): If you want Elastic
Transcoder to include the resolution in the file name, include
{resolution}
in the ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder
automatically saves the files in the format (.jpg or .png) that
appears in the preset that you specified in the PresetID
value of CreateJobOutput
. Elastic Transcoder also appends
the applicable file name extension.
Constraints:
Pattern: (^$)|(^.*\{count\}.*$)
String rotate
auto
, 0
, 90
,
180
, 270
The value auto
generally works only if the file that you're transcoding contains
rotation metadata.
Constraints:
Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)
String presetId
Id
object for the preset that you want
to use for this job. The preset determines the audio, video, and
thumbnail settings that Elastic Transcoder uses for transcoding. To
use a preset that you created, specify the preset ID that Elastic
Transcoder returned in the response when you created the preset. You
can also use the Elastic Transcoder system presets, which you can get
with ListPresets
.
Constraints:
Pattern: ^\d{13}-\w{6}$
String segmentDuration
PresetId
for which the value of
Container
is ts
(MPEG-TS),
SegmentDuration
is the maximum duration of each .ts file
in seconds. The range of valid values is 1 to 60 seconds. If the
duration of the video is not evenly divisible by
SegmentDuration
, the duration of the last segment is the
remainder of total length/SegmentDuration. Elastic Transcoder creates
an output-specific playlist for each output that you specify in
OutputKeys. To add an output to the master playlist for this job,
include it in OutputKeys
.
Constraints:
Pattern: ^\d{1,5}(\.\d{0,5})?$
String status
Outputs:Status
is always the same as
Job:Status
. If you specified more than one output: Job:Status
and Outputs:Status
for all of
the outputs is Submitted until Elastic Transcoder starts to process
the first output.Outputs:Status
for that output and
Job:Status
both change to Progressing. For each output,
the value of Outputs:Status
remains Submitted until
Elastic Transcoder starts to process the output.Job:Status
changes to Complete only if
Outputs:Status
for all of the outputs is
Complete
. If Outputs:Status
for one or more
outputs is Error
, the terminal status for
Job:Status
is also Error
.Status
is one of the following:
Submitted
, Progressing
,
Complete
, Canceled
, or Error
.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
String statusDetail
Status
.
Constraints:
Length: 0 - 255
Long duration
Integer width
Integer height
ListWithAutoConstructFlag<T> watermarks
Preset
for the
current output. Watermarks are added to the output video in the sequence in which you list them in the job output???the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
JobAlbumArt albumArt
ListWithAutoConstructFlag<T> composition
Captions captions
Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include: CEA-608
(EIA-608
, first non-empty channel only), CEA-708
(EIA-708
, first non-empty channel only), and
mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include:
dfxp
(first div element only), ebu-tt
,
scc
, smpt
, srt
,
ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only),
scc
, srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or
leave the captions empty, set Captions
to null. To pass
through existing captions unchanged, set the MergePolicy
to MergeRetain
, and pass in a null
CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
String presetWatermarkId
Constraints:
Length: 1 - 40
String inputKey
Pipeline
; the Input Bucket
object in that
pipeline identifies the bucket. If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
Constraints:
Length: 1 - 255
Pattern: (^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)
String pipelineId
Constraints:
Pattern: ^\d{13}-\w{6}$
String ascending
true
. To list jobs in reverse
chronological order, enter false
.
Constraints:
Pattern: (^true$)|(^false$)
String pageToken
pageToken
in subsequent GET
requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
ListWithAutoConstructFlag<T> jobs
Job
objects that are in the specified
pipeline.String nextPageToken
NextPageToken
is null
.
Constraints:
Pattern: ^\d{13}-\w{6}$
String status
Submitted
, Progressing
,
Complete
, Canceled
, or Error
.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
String ascending
true
. To list jobs in reverse
chronological order, enter false
.
Constraints:
Pattern: (^true$)|(^false$)
String pageToken
pageToken
in subsequent GET
requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
ListWithAutoConstructFlag<T> jobs
Job
objects that have the specified status.String nextPageToken
NextPageToken
is null
.
Constraints:
Pattern: ^\d{13}-\w{6}$
String ascending
true
. To list pipelines in
reverse chronological order, enter false
.
Constraints:
Pattern: (^true$)|(^false$)
String pageToken
pageToken
in subsequent GET
requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
ListWithAutoConstructFlag<T> pipelines
Pipeline
objects.String nextPageToken
NextPageToken
is null
.
Constraints:
Pattern: ^\d{13}-\w{6}$
String ascending
true
. To list presets in reverse
chronological order, enter false
.
Constraints:
Pattern: (^true$)|(^false$)
String pageToken
pageToken
in subsequent GET
requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
ListWithAutoConstructFlag<T> presets
Preset
objects.String nextPageToken
NextPageToken
is null
.
Constraints:
Pattern: ^\d{13}-\w{6}$
String progressing
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
String completed
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
String warning
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
String error
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
String granteeType
Canonical
: Either the canonical user ID for an AWS
account or an origin access identity for an Amazon CloudFront
distribution. Email
: The
registered email address of an AWS account.Group
: One of the following predefined Amazon S3
groups: AllUsers
, AuthenticatedUsers
, or
LogDelivery
.
Constraints:
Pattern: (^Canonical$)|(^Email$)|(^Group$)
String grantee
Constraints:
Length: 1 - 255
ListWithAutoConstructFlag<T> access
READ
: The grantee
can read the thumbnails and metadata for thumbnails that Elastic
Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and
WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds
to the Amazon S3 bucket.
Constraints:
Length: 0 - 30
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String arn
String name
Constraints: Maximum 40 characters
Constraints:
Length: 1 - 40
String status
Active
: The
pipeline is processing jobs.Paused
: The
pipeline is not currently processing jobs.
Constraints:
Pattern: (^Active$)|(^Paused$)
String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String outputBucket
ContentConfig
and
ThumbnailConfig
.
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
Notifications notifications
PipelineOutputConfig contentConfig
ContentConfig
and ThumbnailConfig
, or
you specify OutputBucket
. Grantee
object: Canonical
: Either the canonical user ID for an AWS
account or an origin access identity for an Amazon CloudFront
distribution.Email
: The registered email
address of an AWS account.Group
: One of the
following predefined Amazon S3 groups: AllUsers
,
AuthenticatedUsers
, or LogDelivery
.Grantee
: The AWS user or group that you
want to have access to transcoded files and playlists.Access
: The permission that you want to give to the
AWS user that is listed in Grantee
. Valid values include:
READ
: The grantee can read the objects and
metadata for objects that Elastic Transcoder adds to the Amazon S3
bucket.READ_ACP
: The grantee can read the
object ACL for objects that Elastic Transcoder adds to the Amazon S3
bucket.WRITE_ACP
: The grantee can write the ACL
for the objects that Elastic Transcoder adds to the Amazon S3
bucket.FULL_CONTROL
: The grantee has
READ
, READ_ACP
, and WRITE_ACP
permissions for the objects that Elastic Transcoder adds to the Amazon
S3 bucket.PipelineOutputConfig thumbnailConfig
ContentConfig
and ThumbnailConfig
, or you
specify OutputBucket
. Bucket
: The
Amazon S3 bucket in which you want Elastic Transcoder to save
thumbnail files. Permissions
: A list of the
users and/or predefined Amazon S3 groups you want to have access to
thumbnail files, and the type of access that you want them to have.
Canonical
: Either the canonical user ID
for an AWS account or an origin access identity for an Amazon
CloudFront distribution. Email
: The registered email address of an AWS
account.Group
: One of the following predefined
Amazon S3 groups: AllUsers
,
AuthenticatedUsers
, or LogDelivery
.Grantee
: The AWS user or group that you
want to have access to thumbnail files.READ
: The grantee
can read the thumbnails and metadata for thumbnails that Elastic
Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and
WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds
to the Amazon S3 bucket.StorageClass
: The Amazon S3 storage class,
Standard
or ReducedRedundancy
, that you want
Elastic Transcoder to assign to the thumbnails that it stores in your
Amazon S3 bucket.String bucket
ContentConfig
and ThumbnailConfig
instead.
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String storageClass
Standard
or
ReducedRedundancy
, that you want Elastic Transcoder to
assign to the video files and playlists that it stores in your Amazon
S3 bucket.
Constraints:
Pattern: (^ReducedRedundancy$)|(^Standard$)
ListWithAutoConstructFlag<T> permissions
Permissions
object specifies which users
and/or predefined Amazon S3 groups you want to have access to
transcoded files and playlists, and the type of access you want them
to have. You can grant permissions to a maximum of 30 users and/or
predefined Amazon S3 groups. If you include
Permissions
, Elastic Transcoder grants only the
permissions that you specify. It does not grant full permissions to
the owner of the role specified by Role
. If you want that
user to have full control, you must explicitly grant full control to
the user.
If you omit Permissions
, Elastic Transcoder
grants full control over the transcoded files and playlists to the
owner of the role specified by Role
, and grants no other
permissions to any other user or group.
Constraints:
Length: 0 - 30
String name
Name
objects must be
unique. Note: Elastic Transcoder automatically appends .m3u8 to
the file name. If you include .m3u8 in Name
, it will
appear twice in the file name.
Constraints:
Length: 1 - 255
String format
HLSv3
.
Constraints:
Pattern: (^HLSv3$)
ListWithAutoConstructFlag<T> outputKeys
SegmentDuration
for all of the outputs must be the same.
Constraints:
Length: 0 - 30
String status
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
String statusDetail
Constraints:
Length: 0 - 255
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String arn
String name
Constraints:
Length: 1 - 40
String description
Constraints:
Length: 0 - 255
String container
mp3
, mp4
, ogg
, ts
,
and webm
.
Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)
AudioParameters audio
VideoParameters video
Thumbnails thumbnails
String type
System
) or a preset that you have defined
(Custom
).
Constraints:
Pattern: (^System$)|(^Custom$)
String id
Id
can be up to 40 characters long.
Constraints:
Length: 1 - 40
String maxWidth
MaxWidth
.Target
to specify whether you want Elastic
Transcoder to include the black bars that are added by Elastic
Transcoder, if any, in the calculation.MaxWidth
.
Constraints:
Pattern: (^\d{1,3}(\.\d{0,5})?%$)|(^\d{1,4}?px$)
String maxHeight
MaxHeight
.Target
to specify whether you want Elastic
Transcoder to include the black bars that are added by Elastic
Transcoder, if any, in the calculation.MaxHeight
.
Constraints:
Pattern: (^\d{1,3}(\.\d{0,5})?%$)|(^\d{1,4}?px$)
String sizingPolicy
MaxWidth
or
MaxHeight
without exceeding the other value.MaxWidth
and
MaxHeight
. If the relative proportions of the watermark
and the values of MaxWidth
and MaxHeight
are
different, the watermark will be distorted.MaxWidth
and MaxHeight
without
exceeding either value. If you specify this option, Elastic Transcoder
does not scale the watermark up.
Constraints:
Pattern: (^Fit$)|(^Stretch$)|(^ShrinkToFit$)
String horizontalAlign
HorizontalOffset
:
Constraints:
Pattern: (^Left$)|(^Right$)|(^Center$)
String horizontalOffset
HorizontalAlign
and 5px for
HorizontalOffset
, the left side of the watermark appears
5 pixels from the left border of the output video.
HorizontalOffset
is only valid when the value of
HorizontalAlign
is Left
or
Right
. If you specify an offset that causes the watermark
to extend beyond the left or right border and Elastic Transcoder has
not added black bars, the watermark is cropped. If Elastic Transcoder
has added black bars, the watermark extends into the black bars. If
the watermark extends beyond the black bars, it is cropped.
Use the
value of Target
to specify whether you want to include
the black bars that are added by Elastic Transcoder, if any, in the
offset calculation.
Constraints:
Pattern: (^\d{1,3}(\.\d{0,5})?%$)|(^\d{1,4}?px$)
String verticalAlign
VerticalOffset
:
Constraints:
Pattern: (^Top$)|(^Bottom$)|(^Center$)
String verticalOffset
VerticalOffset
The amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign:
MaxHeight
.Top
for VerticalAlign
and 5px
for VerticalOffset
, the top of the watermark appears 5
pixels from the top border of the output video.
VerticalOffset
is only valid when the value of
VerticalAlign is Top or Bottom.
If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.
Use the value of Target
to specify whether
you want Elastic Transcoder to include the black bars that are added
by Elastic Transcoder, if any, in the offset calculation.
Constraints:
Pattern: (^\d{1,3}(\.\d{0,5})?%$)|(^\d{1,4}?px$)
String opacity
Opacity
is float. Elastic Transcoder supports transparent .png graphics. If
you use a transparent .png, the transparent portion of the video
appears as if you had specified a value of 0 for Opacity
.
The .jpg file format doesn't support transparency.
Constraints:
Pattern: ^\d{1,3}(\.\d{0,20})?$
String target
HorizontalOffset
,
VerticalOffset
, MaxWidth
, and
MaxHeight
: HorizontalOffset
and VerticalOffset
values
are calculated based on the borders of the video excluding black bars
added by Elastic Transcoder, if any. In addition,
MaxWidth
and MaxHeight
, if specified as a
percentage, are calculated based on the borders of the video excluding
black bars added by Elastic Transcoder, if any.HorizontalOffset
and VerticalOffset
values
are calculated based on the borders of the video including black bars
added by Elastic Transcoder, if any.MaxWidth
and MaxHeight
, if specified as a
percentage, are calculated based on the borders of the video including
black bars added by Elastic Transcoder, if any.
Constraints:
Pattern: (^Content$)|(^Frame$)
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Job job
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Pipeline pipeline
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Preset preset
String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String outputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
ListWithAutoConstructFlag<T> topics
Constraints:
Length: 0 - 30
String success
true
;
otherwise, the value is false
.
Constraints:
Pattern: (^true$)|(^false$)
ListWithAutoConstructFlag<T> messages
Success
element contains false
, this
value is an array of one or more error messages that were generated
during the test process.String format
jpg
and png
. You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
Constraints:
Pattern: (^jpg$)|(^png$)
String interval
Constraints:
Pattern: ^\d{1,5}$
String resolution
To better control resolution and aspect ratio of
thumbnails, we recommend that you use the values
MaxWidth
, MaxHeight
,
SizingPolicy
, and PaddingPolicy
instead of
Resolution
and AspectRatio
. The two groups
of settings are mutually exclusive. Do not use them together.
The width and height of thumbnail files in pixels.
Specify a value in the format width
x
height
where both values are even integers. The
values cannot exceed the width and height that you specified in the
Video:Resolution
object.
Constraints:
Pattern: ^\d{1,5}x\d{1,5}$
String aspectRatio
To better control resolution and aspect ratio of
thumbnails, we recommend that you use the values
MaxWidth
, MaxHeight
,
SizingPolicy
, and PaddingPolicy
instead of
Resolution
and AspectRatio
. The two groups
of settings are mutually exclusive. Do not use them together.
The aspect ratio of thumbnails. Valid values include:
auto
, 1:1
, 4:3
,
3:2
, 16:9
If you specify
auto
, Elastic Transcoder tries to preserve the aspect
ratio of the video in the output file.
Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
String maxWidth
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
String maxHeight
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
String sizingPolicy
Fit
: Elastic Transcoder scales thumbnails so
they match the value that you specified in thumbnail MaxWidth or
MaxHeight settings without exceeding the other value. Fill
: Elastic Transcoder scales thumbnails so they
match the value that you specified in thumbnail MaxWidth
or MaxHeight
settings and matches or exceeds the other
value. Elastic Transcoder centers the image in thumbnails and then
crops in the dimension (if any) that exceeds the maximum value.Stretch
: Elastic Transcoder stretches thumbnails to
match the values that you specified for thumbnail
MaxWidth
and MaxHeight
settings. If the
relative proportions of the input video and thumbnails are different,
the thumbnails will be distorted.Keep
: Elastic
Transcoder does not scale thumbnails. If either dimension of the input
video exceeds the values that you specified for thumbnail
MaxWidth
and MaxHeight
settings, Elastic
Transcoder crops the thumbnails.ShrinkToFit
:
Elastic Transcoder scales thumbnails down so that their dimensions
match the values that you specified for at least one of thumbnail
MaxWidth
and MaxHeight
without exceeding
either value. If you specify this option, Elastic Transcoder does not
scale thumbnails up.ShrinkToFill
: Elastic
Transcoder scales thumbnails down so that their dimensions match the
values that you specified for at least one of MaxWidth
and MaxHeight
without dropping below either value. If you
specify this option, Elastic Transcoder does not scale thumbnails
up.
Constraints:
Pattern: (^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)
String paddingPolicy
PaddingPolicy
to Pad
, Elastic
Transcoder may add black bars to the top and bottom and/or left and
right sides of thumbnails to make the total size of the thumbnails
match the values that you specified for thumbnail
MaxWidth
and MaxHeight
settings.
Constraints:
Pattern: (^Pad$)|(^NoPad$)
String startTime
Constraints:
Pattern: (^\d{1,5}(\.\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\.\d{0,3})?$)
String duration
If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message.
Constraints:
Pattern: (^\d{1,5}(\.\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\.\d{0,3})?$)
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Notifications notifications
Pipeline pipeline
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String name
Constraints: Maximum 40 characters
Constraints:
Length: 1 - 40
String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
Notifications notifications
PipelineOutputConfig contentConfig
ContentConfig
object specifies information
about the Amazon S3 bucket in which you want Elastic Transcoder to
save transcoded files and playlists: which bucket to use, which users
you want to have access to the files, the type of access you want
users to have, and the storage class that you want to assign to the
files. If you specify values for ContentConfig
, you
must also specify values for ThumbnailConfig
.
If you
specify values for ContentConfig
and
ThumbnailConfig
, omit the OutputBucket
object.
Grantee
object: Grantee
object is either the canonical user ID for an
AWS account or an origin access identity for an Amazon CloudFront
distribution. For more information about canonical user IDs, see
Access Control List (ACL) Overview in the Amazon Simple Storage
Service Developer Guide. For more information about using CloudFront
origin access identities to require that users use CloudFront URLs
instead of Amazon S3 URLs, see Using an Origin Access Identity to
Restrict Access to Your Amazon S3 Content. Grantee
object is the
registered email address of an AWS account.Grantee
object is one of the following
predefined Amazon S3 groups: AllUsers
,
AuthenticatedUsers
, or LogDelivery
.Grantee
. Permissions are
granted on the files that Elastic Transcoder adds to the bucket,
including playlists and video files. Valid values include: READ
: The grantee can read the objects and metadata
for objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for
objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP
: The grantee can write the ACL for the
objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,
READ_ACP
, and WRITE_ACP
permissions for the
objects that Elastic Transcoder adds to the Amazon S3 bucket.Standard
or ReducedRedundancy
, that you want
Elastic Transcoder to assign to the video files and playlists that it
stores in your Amazon S3 bucket.PipelineOutputConfig thumbnailConfig
ThumbnailConfig
object specifies several values,
including the Amazon S3 bucket in which you want Elastic Transcoder to
save thumbnail files, which users you want to have access to the
files, the type of access you want users to have, and the storage
class that you want to assign to the files. If you specify values
for ContentConfig
, you must also specify values for
ThumbnailConfig
even if you don't want to create
thumbnails.
If you specify values for ContentConfig
and ThumbnailConfig
, omit the OutputBucket
object.
Permissions
object
specifies which users and/or predefined Amazon S3 groups you want to
have access to thumbnail files, and the type of access you want them
to have. You can grant permissions to a maximum of 30 users and/or
predefined Amazon S3 groups.Grantee
object is
either the canonical user ID for an AWS account or an origin access
identity for an Amazon CloudFront distribution. Grantee
object is the
registered email address of an AWS account. Grantee
object is one of the following
predefined Amazon S3 groups: AllUsers
,
AuthenticatedUsers
, or LogDelivery
.Grantee
. Permissions are granted on
the thumbnail files that Elastic Transcoder adds to the bucket. Valid
values include: READ
: The grantee can read the
thumbnails and metadata for objects that Elastic Transcoder adds to
the Amazon S3 bucket.READ_ACP
: The grantee can
read the object ACL for thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket. WRITE_ACP
: The grantee can
write the ACL for the thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket.FULL_CONTROL
: The grantee has
READ
, READ_ACP
, and WRITE_ACP
permissions for the thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket. Standard
or
ReducedRedundancy
, that you want Elastic Transcoder to
assign to the thumbnails that it stores in your Amazon S3 bucket.Pipeline pipeline
Pipeline pipeline
String codec
H.264
and vp8
. You can only specify
vp8
when the container type is webm
.
Constraints:
Pattern: (^H\.264$)|(^vp8$)
Map<K,V> codecOptions
The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:
baseline
: The profile most commonly used for
videoconferencing and for mobile applications.main
: The profile used for standard-definition
digital TV broadcasts.high
: The profile used
for high-definition digital TV broadcasts and for Blu-ray discs.Level (H.264 Only)
The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:
1
, 1b
, 1.1
,
1.2
, 1.3
, 2
, 2.1
,
2.2
, 3
, 3.1
, 3.2
,
4
, 4.1
MaxReferenceFrames (H.264 Only)
Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:
Min(Floor(Maximum decoded picture buffer in macroblocks *
256 / (Width in pixels * Height in pixels)), 16)
where
Width in pixels and Height in pixels represent either
MaxWidth and MaxHeight, or Resolution. Maximum decoded picture
buffer in macroblocks depends on the value of the
Level
object. See the list below. (A macroblock is a
block of pixels measuring 16x16.)
MaxBitRate
The maximum number
of bits per second in a video buffer; the size of the buffer is
specified by BufferSize
. Specify a value between 16 and
62,500. You can reduce the bandwidth required to stream a video by
reducing the maximum bit rate, but this also reduces the quality of
the video.
BufferSize
The maximum number of bits in any
x seconds of the output video. This window is commonly 10 seconds, the
standard segment duration when you're using MPEG-TS for the container
type of the output video. Specify an integer greater than 0. If you
specify MaxBitRate
and omit BufferSize
,
Elastic Transcoder sets BufferSize
to 10 times the value
of MaxBitRate
.
Constraints:
Length: 0 - 30
String keyframesMaxDist
Constraints:
Pattern: ^\d{1,6}$
String fixedGOP
FixedGOP
. Valid values
are true
and false
: true
: Elastic Transcoder uses the value of
KeyframesMaxDist
for the distance between key frames (the
number of frames in a group of pictures, or GOP).false
: The distance between key frames can vary.
Constraints:
Pattern: (^true$)|(^false$)
String bitRate
Level
and Profile
. If you specify
auto
, Elastic Transcoder uses the detected bit rate of
the input source. If you specify a value other than auto
,
we recommend that you specify a value less than or equal to the
maximum H.264-compliant value listed for your level and profile: Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)
Constraints:
Pattern: (^\d{2,5}$)|(^auto$)
String frameRate
auto
, 10
,
15
, 23.97
, 24
, 25
,
29.97
, 30
, 60
If you specify
auto
, Elastic Transcoder uses the detected frame rate of
the input source. If you specify a frame rate, we recommend that you
perform the following calculation:
Frame rate = maximum
recommended decoding speed in luma samples/second / (width in pixels *
height in pixels)
where:
The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):
Constraints:
Pattern: (^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)
String maxFrameRate
auto
for FrameRate
, Elastic
Transcoder uses the frame rate of the input video for the frame rate
of the output video. Specify the maximum frame rate that you want
Elastic Transcoder to use when the frame rate of the input video is
greater than the desired maximum frame rate of the output video. Valid
values include: 10
, 15
, 23.97
,
24
, 25
, 29.97
, 30
,
60
.
Constraints:
Pattern: (^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)
String resolution
To better control resolution and aspect ratio of output
videos, we recommend that you use the values MaxWidth
,
MaxHeight
, SizingPolicy
,
PaddingPolicy
, and DisplayAspectRatio
instead of Resolution
and AspectRatio
. The
two groups of settings are mutually exclusive. Do not use them
together.
The width and height of the video in the
output file, in pixels. Valid values are auto
and
width x height:
auto
: Elastic
Transcoder attempts to preserve the width and height of the input
file, subject to the following rules.width x
height
: The width and height of the output video in
pixels.Note the following about specifying the width and height:
Constraints:
Pattern: (^auto$)|(^\d{1,5}x\d{1,5}$)
String aspectRatio
To better control resolution and aspect ratio of output
videos, we recommend that you use the values MaxWidth
,
MaxHeight
, SizingPolicy
,
PaddingPolicy
, and DisplayAspectRatio
instead of Resolution
and AspectRatio
. The
two groups of settings are mutually exclusive. Do not use them
together.
The display aspect ratio of the video in the output file. Valid values include:
auto
,
1:1
, 4:3
, 3:2
,
16:9
If you specify auto
, Elastic
Transcoder tries to preserve the aspect ratio of the input file.
If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.
Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
String maxWidth
auto
, Elastic Transcoder uses 1920 (Full HD) as the
default value. If you specify a numeric value, enter an even integer
between 128 and 4096.
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
String maxHeight
auto
, Elastic Transcoder uses 1080 (Full HD) as the
default value. If you specify a numeric value, enter an even integer
between 96 and 3072.
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
String displayAspectRatio
Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
String sizingPolicy
Fit
: Elastic Transcoder scales the
output video so it matches the value that you specified in either
MaxWidth
or MaxHeight
without exceeding the
other value.Fill
: Elastic Transcoder scales the
output video so it matches the value that you specified in either
MaxWidth
or MaxHeight
and matches or exceeds
the other value. Elastic Transcoder centers the output video and then
crops it in the dimension (if any) that exceeds the maximum
value.Stretch
: Elastic Transcoder stretches the
output video to match the values that you specified for
MaxWidth
and MaxHeight
. If the relative
proportions of the input video and the output video are different, the
output video will be distorted.Keep
: Elastic
Transcoder does not scale the output video. If either dimension of the
input video exceeds the values that you specified for
MaxWidth
and MaxHeight
, Elastic Transcoder
crops the output video.ShrinkToFit
: Elastic
Transcoder scales the output video down so that its dimensions match
the values that you specified for at least one of
MaxWidth
and MaxHeight
without exceeding
either value. If you specify this option, Elastic Transcoder does not
scale the video up.ShrinkToFill
: Elastic
Transcoder scales the output video down so that its dimensions match
the values that you specified for at least one of
MaxWidth
and MaxHeight
without dropping
below either value. If you specify this option, Elastic Transcoder
does not scale the video up.
Constraints:
Pattern: (^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)
String paddingPolicy
PaddingPolicy
to Pad
, Elastic
Transcoder may add black bars to the top and bottom and/or left and
right sides of the output video to make the total size of the output
video match the values that you specified for MaxWidth
and MaxHeight
.
Constraints:
Pattern: (^Pad$)|(^NoPad$)
ListWithAutoConstructFlag<T> watermarks
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.
Copyright © 2014. All rights reserved.