AWS SDK for .NET Documentation
CreateJobOutput Class
AmazonAmazon.ElasticTranscoder.ModelCreateJobOutput Did this page help you?   Yes   No    Tell us about it...
The
CopyC#
CreateJobOutput
structure.
Declaration Syntax
C#
public class CreateJobOutput
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
CreateJobOutput()()()()
Initializes a new instance of the CreateJobOutput class

AlbumArt
Gets and sets the property AlbumArt.

Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.


Captions
Gets and sets the property Captions.

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:

    CopyC#
    CEA-608 (EIA-608
    , first non-empty channel only),
    CopyC#
    CEA-708 (EIA-708
    , first non-empty channel only), and
    CopyC#
    mov-text

    Valid outputs include:

    CopyC#
    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:

    CopyC#
    dfxp
    (first div element only),
    CopyC#
    ebu-tt
    ,
    CopyC#
    scc
    ,
    CopyC#
    smpt
    ,
    CopyC#
    srt
    ,
    CopyC#
    ttml
    (first div element only), and
    CopyC#
    webvtt

    Valid outputs include:

    CopyC#
    dfxp
    (first div element only),
    CopyC#
    scc
    ,
    CopyC#
    srt
    , and
    CopyC#
    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

CopyC#
Captions
to null. To pass through existing captions unchanged, set the
CopyC#
MergePolicy
to
CopyC#
MergeRetain
, and pass in a null
CopyC#
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.


Composition
Gets and sets the property Composition.

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Key
Gets and sets the property Key.

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the

CopyC#
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.


PresetId
Gets and sets the property PresetId.

The

CopyC#
Id
of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.


Rotate
Gets and sets the property Rotate.

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:

CopyC#
auto
,
CopyC#
0
,
CopyC#
90
,
CopyC#
180
,
CopyC#
270
. The value
CopyC#
auto
generally works only if the file that you're transcoding contains rotation metadata.


SegmentDuration
Gets and sets the property SegmentDuration.

If you specify a preset in

CopyC#
PresetId
for which the value of
CopyC#
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.


ThumbnailPattern
Gets and sets the property ThumbnailPattern.

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:

  • CopyC#
    {count}
    (Required): If you want to create thumbnails, you must include
    CopyC#
    {count}
    in the
    CopyC#
    ThumbnailPattern
    object. Wherever you specify
    CopyC#
    {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
    CopyC#
    {resolution}
    but you omit
    CopyC#
    {count}
    , Elastic Transcoder returns a validation error and does not create the job.
  • Literal values (Optional): You can specify literal values anywhere in the

    CopyC#
    ThumbnailPattern
    object. For example, you can include them as a file name prefix or as a delimiter between
    CopyC#
    {resolution}
    and
    CopyC#
    {count}
    .

  • CopyC#
    {resolution}
    (Optional): If you want Elastic Transcoder to include the resolution in the file name, include
    CopyC#
    {resolution}
    in the
    CopyC#
    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

CopyC#
PresetID
value of
CopyC#
CreateJobOutput
. Elastic Transcoder also appends the applicable file name extension.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Watermarks
Gets and sets the property Watermarks.

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 for the current output.


WithAlbumArt(JobAlbumArt) Obsolete.
Sets the AlbumArt property

WithCaptions(Captions) Obsolete.
Sets the Captions property

WithComposition(array<Clip>[]()[][]) Obsolete.
Sets the Composition property

WithComposition(IEnumerable<(Of <<'(Clip>)>>)) Obsolete.
Sets the Composition property

WithKey(String) Obsolete.
Sets the Key property

WithPresetId(String) Obsolete.
Sets the PresetId property

WithRotate(String) Obsolete.
Sets the Rotate property

WithSegmentDuration(String) Obsolete.
Sets the SegmentDuration property

WithThumbnailPattern(String) Obsolete.
Sets the ThumbnailPattern property

WithWatermarks(array<JobWatermark>[]()[][]) Obsolete.
Sets the Watermarks property

WithWatermarks(IEnumerable<(Of <<'(JobWatermark>)>>)) Obsolete.
Sets the Watermarks property

Inheritance Hierarchy
Object
CreateJobOutput

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)