AWS SDK for C++AWS SDK for C++ Version 1.11.617 |
#include <JobOutput.h>
Outputs recommended instead.
If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output
object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs
object.
Definition at line 40 of file JobOutput.h.
Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in 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 covers the first one, the third one covers the second, and the fourth one covers the third.
Definition at line 308 of file JobOutput.h.
The album art to be associated with the output file, if any.
Definition at line 316 of file JobOutput.h.
If Elastic Transcoder used a preset with a ColorSpaceConversionMode
to transcode the output file, the AppliedColorSpaceConversion
parameter shows the conversion used. If no ColorSpaceConversionMode
was defined in the preset, this parameter is not be included in the job response.
Definition at line 389 of file JobOutput.h.
You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of 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.
Definition at line 358 of file JobOutput.h.
Duration of the output file, in seconds.
Definition at line 231 of file JobOutput.h.
Duration of the output file, in milliseconds.
Definition at line 283 of file JobOutput.h.
The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket.
Definition at line 373 of file JobOutput.h.
File size of the output file, in bytes.
Definition at line 273 of file JobOutput.h.
Frame rate of the output file, in frames per second.
Definition at line 261 of file JobOutput.h.
The album art to be associated with the output file, if any.
Definition at line 315 of file JobOutput.h.
If Elastic Transcoder used a preset with a ColorSpaceConversionMode
to transcode the output file, the AppliedColorSpaceConversion
parameter shows the conversion used. If no ColorSpaceConversionMode
was defined in the preset, this parameter is not be included in the job response.
Definition at line 388 of file JobOutput.h.
You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of 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.
Definition at line 357 of file JobOutput.h.
Duration of the output file, in seconds.
Definition at line 230 of file JobOutput.h.
Duration of the output file, in milliseconds.
Definition at line 282 of file JobOutput.h.
The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket.
Definition at line 372 of file JobOutput.h.
File size of the output file, in bytes.
Definition at line 272 of file JobOutput.h.
Frame rate of the output file, in frames per second.
Definition at line 260 of file JobOutput.h.
Height of the output file, in pixels.
Definition at line 250 of file JobOutput.h.
A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.
Definition at line 54 of file JobOutput.h.
The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket
object in the pipeline that is specified by the pipeline ID.
Definition at line 68 of file JobOutput.h.
The value of the 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
.
Definition at line 150 of file JobOutput.h.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values:
auto
, 0
, 90
, 180
, 270
The value auto
generally works only if the file that you're transcoding contains rotation metadata.
Definition at line 133 of file JobOutput.h.
(Outputs in Fragmented MP4 or MPEG-TS format only.
If you specify a preset in PresetId
for which the value of Container
is fmp4
(Fragmented MP4) or ts
(MPEG-TS), SegmentDuration
is the target maximum duration of each segment in seconds. For HLSv3
format playlists, each media segment is stored in a separate .ts
file. For HLSv4
, MPEG-DASH
, and Smooth
playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration
, though individual segments might be shorter or longer.
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 HLS
output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys
of the associated playlist.
Definition at line 177 of file JobOutput.h.
The status of one output in a job. If you specified only one output for the job, 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.
When 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 remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
When all of the outputs reach a terminal status, 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
.
The value of Status
is one of the following: Submitted
, Progressing
, Complete
, Canceled
, or Error
.
Definition at line 206 of file JobOutput.h.
Information that further explains Status
.
Definition at line 218 of file JobOutput.h.
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
Definition at line 117 of file JobOutput.h.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
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.
If you specify a literal value and/or {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.
Definition at line 104 of file JobOutput.h.
Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in 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 covers the first one, the third one covers the second, and the fourth one covers the third.
Definition at line 301 of file JobOutput.h.
Specifies the width of the output file in pixels.
Definition at line 240 of file JobOutput.h.
Height of the output file, in pixels.
Definition at line 251 of file JobOutput.h.
A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.
Definition at line 55 of file JobOutput.h.
The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket
object in the pipeline that is specified by the pipeline ID.
Definition at line 69 of file JobOutput.h.
The value of the 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
.
Definition at line 151 of file JobOutput.h.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values:
auto
, 0
, 90
, 180
, 270
The value auto
generally works only if the file that you're transcoding contains rotation metadata.
Definition at line 134 of file JobOutput.h.
(Outputs in Fragmented MP4 or MPEG-TS format only.
If you specify a preset in PresetId
for which the value of Container
is fmp4
(Fragmented MP4) or ts
(MPEG-TS), SegmentDuration
is the target maximum duration of each segment in seconds. For HLSv3
format playlists, each media segment is stored in a separate .ts
file. For HLSv4
, MPEG-DASH
, and Smooth
playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration
, though individual segments might be shorter or longer.
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 HLS
output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys
of the associated playlist.
Definition at line 178 of file JobOutput.h.
The album art to be associated with the output file, if any.
Definition at line 318 of file JobOutput.h.
If Elastic Transcoder used a preset with a ColorSpaceConversionMode
to transcode the output file, the AppliedColorSpaceConversion
parameter shows the conversion used. If no ColorSpaceConversionMode
was defined in the preset, this parameter is not be included in the job response.
Definition at line 391 of file JobOutput.h.
You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of 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.
Definition at line 360 of file JobOutput.h.
Duration of the output file, in seconds.
Definition at line 232 of file JobOutput.h.
Duration of the output file, in milliseconds.
Definition at line 284 of file JobOutput.h.
The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket.
Definition at line 375 of file JobOutput.h.
File size of the output file, in bytes.
Definition at line 274 of file JobOutput.h.
Frame rate of the output file, in frames per second.
Definition at line 263 of file JobOutput.h.
Height of the output file, in pixels.
Definition at line 252 of file JobOutput.h.
A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.
Definition at line 57 of file JobOutput.h.
The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket
object in the pipeline that is specified by the pipeline ID.
Definition at line 71 of file JobOutput.h.
The value of the 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
.
Definition at line 153 of file JobOutput.h.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values:
auto
, 0
, 90
, 180
, 270
The value auto
generally works only if the file that you're transcoding contains rotation metadata.
Definition at line 136 of file JobOutput.h.
(Outputs in Fragmented MP4 or MPEG-TS format only.
If you specify a preset in PresetId
for which the value of Container
is fmp4
(Fragmented MP4) or ts
(MPEG-TS), SegmentDuration
is the target maximum duration of each segment in seconds. For HLSv3
format playlists, each media segment is stored in a separate .ts
file. For HLSv4
, MPEG-DASH
, and Smooth
playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration
, though individual segments might be shorter or longer.
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 HLS
output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys
of the associated playlist.
Definition at line 180 of file JobOutput.h.
The status of one output in a job. If you specified only one output for the job, 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.
When 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 remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
When all of the outputs reach a terminal status, 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
.
The value of Status
is one of the following: Submitted
, Progressing
, Complete
, Canceled
, or Error
.
Definition at line 209 of file JobOutput.h.
Information that further explains Status
.
Definition at line 221 of file JobOutput.h.
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
Definition at line 120 of file JobOutput.h.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
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.
If you specify a literal value and/or {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.
Definition at line 107 of file JobOutput.h.
Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in 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 covers the first one, the third one covers the second, and the fourth one covers the third.
Definition at line 304 of file JobOutput.h.
Specifies the width of the output file in pixels.
Definition at line 242 of file JobOutput.h.
Information that further explains Status
.
Definition at line 219 of file JobOutput.h.
The status of one output in a job. If you specified only one output for the job, 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.
When 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 remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
When all of the outputs reach a terminal status, 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
.
The value of Status
is one of the following: Submitted
, Progressing
, Complete
, Canceled
, or Error
.
Definition at line 207 of file JobOutput.h.
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
Definition at line 118 of file JobOutput.h.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
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.
If you specify a literal value and/or {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.
Definition at line 105 of file JobOutput.h.
Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in 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 covers the first one, the third one covers the second, and the fourth one covers the third.
Definition at line 302 of file JobOutput.h.
Specifies the width of the output file in pixels.
Definition at line 241 of file JobOutput.h.
The album art to be associated with the output file, if any.
Definition at line 320 of file JobOutput.h.
If Elastic Transcoder used a preset with a ColorSpaceConversionMode
to transcode the output file, the AppliedColorSpaceConversion
parameter shows the conversion used. If no ColorSpaceConversionMode
was defined in the preset, this parameter is not be included in the job response.
Definition at line 393 of file JobOutput.h.
You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of 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.
Definition at line 362 of file JobOutput.h.
Duration of the output file, in seconds.
Definition at line 233 of file JobOutput.h.
Duration of the output file, in milliseconds.
Definition at line 285 of file JobOutput.h.
The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket.
Definition at line 377 of file JobOutput.h.
File size of the output file, in bytes.
Definition at line 275 of file JobOutput.h.
Frame rate of the output file, in frames per second.
Definition at line 265 of file JobOutput.h.
Height of the output file, in pixels.
Definition at line 253 of file JobOutput.h.
A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.
Definition at line 59 of file JobOutput.h.
The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket
object in the pipeline that is specified by the pipeline ID.
Definition at line 73 of file JobOutput.h.
The value of the 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
.
Definition at line 155 of file JobOutput.h.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values:
auto
, 0
, 90
, 180
, 270
The value auto
generally works only if the file that you're transcoding contains rotation metadata.
Definition at line 138 of file JobOutput.h.
(Outputs in Fragmented MP4 or MPEG-TS format only.
If you specify a preset in PresetId
for which the value of Container
is fmp4
(Fragmented MP4) or ts
(MPEG-TS), SegmentDuration
is the target maximum duration of each segment in seconds. For HLSv3
format playlists, each media segment is stored in a separate .ts
file. For HLSv4
, MPEG-DASH
, and Smooth
playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration
, though individual segments might be shorter or longer.
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 HLS
output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys
of the associated playlist.
Definition at line 182 of file JobOutput.h.
The status of one output in a job. If you specified only one output for the job, 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.
When 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 remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
When all of the outputs reach a terminal status, 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
.
The value of Status
is one of the following: Submitted
, Progressing
, Complete
, Canceled
, or Error
.
Definition at line 211 of file JobOutput.h.
Information that further explains Status
.
Definition at line 223 of file JobOutput.h.
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
Definition at line 122 of file JobOutput.h.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
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.
If you specify a literal value and/or {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.
Definition at line 109 of file JobOutput.h.
Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in 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 covers the first one, the third one covers the second, and the fourth one covers the third.
Definition at line 306 of file JobOutput.h.
Specifies the width of the output file in pixels.
Definition at line 243 of file JobOutput.h.