Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.AWS.ElasticTranscoder
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- Artwork
- AudioCodecOptions
- AudioParameters
- CaptionFormat
- CaptionSource
- Captions
- Clip
- CreateJobOutput
- CreateJobPlaylist
- DetectedProperties
- Encryption
- HlsContentProtection
- InputCaptions
- Job'
- JobAlbumArt
- JobInput
- JobOutput
- JobWatermark
- Notifications
- Permission
- Pipeline
- PipelineOutputConfig
- PlayReadyDrm
- Playlist
- Preset
- PresetWatermark
- Thumbnails
- TimeSpan
- Timing
- VideoParameters
- Warning
Description
AWS Elastic Transcoder Service
The AWS Elastic Transcoder Service.
Synopsis
- elasticTranscoder :: Service
- _IncompatibleVersionException :: AsError a => Getting (First ServiceError) a ServiceError
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- jobComplete :: Wait ReadJob
- module Network.AWS.ElasticTranscoder.DeletePreset
- module Network.AWS.ElasticTranscoder.UpdatePipelineStatus
- module Network.AWS.ElasticTranscoder.ListJobsByPipeline
- module Network.AWS.ElasticTranscoder.UpdatePipeline
- module Network.AWS.ElasticTranscoder.DeletePipeline
- module Network.AWS.ElasticTranscoder.CreateJob
- module Network.AWS.ElasticTranscoder.ListPipelines
- module Network.AWS.ElasticTranscoder.CreatePreset
- module Network.AWS.ElasticTranscoder.ListPresets
- module Network.AWS.ElasticTranscoder.ReadPreset
- module Network.AWS.ElasticTranscoder.ReadJob
- module Network.AWS.ElasticTranscoder.UpdatePipelineNotifications
- module Network.AWS.ElasticTranscoder.ReadPipeline
- module Network.AWS.ElasticTranscoder.CreatePipeline
- module Network.AWS.ElasticTranscoder.ListJobsByStatus
- module Network.AWS.ElasticTranscoder.CancelJob
- data Artwork
- artwork :: Artwork
- aSizingPolicy :: Lens' Artwork (Maybe Text)
- aAlbumArtFormat :: Lens' Artwork (Maybe Text)
- aMaxHeight :: Lens' Artwork (Maybe Text)
- aInputKey :: Lens' Artwork (Maybe Text)
- aPaddingPolicy :: Lens' Artwork (Maybe Text)
- aEncryption :: Lens' Artwork (Maybe Encryption)
- aMaxWidth :: Lens' Artwork (Maybe Text)
- data AudioCodecOptions
- audioCodecOptions :: AudioCodecOptions
- acoSigned :: Lens' AudioCodecOptions (Maybe Text)
- acoBitDepth :: Lens' AudioCodecOptions (Maybe Text)
- acoProfile :: Lens' AudioCodecOptions (Maybe Text)
- acoBitOrder :: Lens' AudioCodecOptions (Maybe Text)
- data AudioParameters
- audioParameters :: AudioParameters
- apChannels :: Lens' AudioParameters (Maybe Text)
- apCodec :: Lens' AudioParameters (Maybe Text)
- apAudioPackingMode :: Lens' AudioParameters (Maybe Text)
- apSampleRate :: Lens' AudioParameters (Maybe Text)
- apBitRate :: Lens' AudioParameters (Maybe Text)
- apCodecOptions :: Lens' AudioParameters (Maybe AudioCodecOptions)
- data CaptionFormat
- captionFormat :: CaptionFormat
- cfPattern :: Lens' CaptionFormat (Maybe Text)
- cfFormat :: Lens' CaptionFormat (Maybe Text)
- cfEncryption :: Lens' CaptionFormat (Maybe Encryption)
- data CaptionSource
- captionSource :: CaptionSource
- csTimeOffset :: Lens' CaptionSource (Maybe Text)
- csEncryption :: Lens' CaptionSource (Maybe Encryption)
- csKey :: Lens' CaptionSource (Maybe Text)
- csLanguage :: Lens' CaptionSource (Maybe Text)
- csLabel :: Lens' CaptionSource (Maybe Text)
- data Captions
- captions :: Captions
- cMergePolicy :: Lens' Captions (Maybe Text)
- cCaptionSources :: Lens' Captions [CaptionSource]
- cCaptionFormats :: Lens' Captions [CaptionFormat]
- data Clip
- clip :: Clip
- cTimeSpan :: Lens' Clip (Maybe TimeSpan)
- data CreateJobOutput
- createJobOutput :: CreateJobOutput
- cjoThumbnailPattern :: Lens' CreateJobOutput (Maybe Text)
- cjoCaptions :: Lens' CreateJobOutput (Maybe Captions)
- cjoPresetId :: Lens' CreateJobOutput (Maybe Text)
- cjoComposition :: Lens' CreateJobOutput [Clip]
- cjoAlbumArt :: Lens' CreateJobOutput (Maybe JobAlbumArt)
- cjoWatermarks :: Lens' CreateJobOutput [JobWatermark]
- cjoEncryption :: Lens' CreateJobOutput (Maybe Encryption)
- cjoKey :: Lens' CreateJobOutput (Maybe Text)
- cjoSegmentDuration :: Lens' CreateJobOutput (Maybe Text)
- cjoThumbnailEncryption :: Lens' CreateJobOutput (Maybe Encryption)
- cjoRotate :: Lens' CreateJobOutput (Maybe Text)
- data CreateJobPlaylist
- createJobPlaylist :: CreateJobPlaylist
- cjpPlayReadyDrm :: Lens' CreateJobPlaylist (Maybe PlayReadyDrm)
- cjpFormat :: Lens' CreateJobPlaylist (Maybe Text)
- cjpOutputKeys :: Lens' CreateJobPlaylist [Text]
- cjpName :: Lens' CreateJobPlaylist (Maybe Text)
- cjpHlsContentProtection :: Lens' CreateJobPlaylist (Maybe HlsContentProtection)
- data DetectedProperties
- detectedProperties :: DetectedProperties
- dpHeight :: Lens' DetectedProperties (Maybe Int)
- dpFrameRate :: Lens' DetectedProperties (Maybe Text)
- dpFileSize :: Lens' DetectedProperties (Maybe Integer)
- dpWidth :: Lens' DetectedProperties (Maybe Int)
- dpDurationMillis :: Lens' DetectedProperties (Maybe Integer)
- data Encryption
- encryption :: Encryption
- eMode :: Lens' Encryption (Maybe Text)
- eKeyMD5 :: Lens' Encryption (Maybe Text)
- eKey :: Lens' Encryption (Maybe Text)
- eInitializationVector :: Lens' Encryption (Maybe Text)
- data HlsContentProtection
- hlsContentProtection :: HlsContentProtection
- hcpKeyMD5 :: Lens' HlsContentProtection (Maybe Text)
- hcpKeyStoragePolicy :: Lens' HlsContentProtection (Maybe Text)
- hcpKey :: Lens' HlsContentProtection (Maybe Text)
- hcpMethod :: Lens' HlsContentProtection (Maybe Text)
- hcpInitializationVector :: Lens' HlsContentProtection (Maybe Text)
- hcpLicenseAcquisitionURL :: Lens' HlsContentProtection (Maybe Text)
- data InputCaptions
- inputCaptions :: InputCaptions
- icMergePolicy :: Lens' InputCaptions (Maybe Text)
- icCaptionSources :: Lens' InputCaptions [CaptionSource]
- data Job'
- job' :: Job'
- jStatus :: Lens' Job' (Maybe Text)
- jPipelineId :: Lens' Job' (Maybe Text)
- jARN :: Lens' Job' (Maybe Text)
- jInputs :: Lens' Job' [JobInput]
- jInput :: Lens' Job' (Maybe JobInput)
- jUserMetadata :: Lens' Job' (HashMap Text Text)
- jOutputs :: Lens' Job' [JobOutput]
- jOutput :: Lens' Job' (Maybe JobOutput)
- jId :: Lens' Job' (Maybe Text)
- jPlaylists :: Lens' Job' [Playlist]
- jOutputKeyPrefix :: Lens' Job' (Maybe Text)
- jTiming :: Lens' Job' (Maybe Timing)
- data JobAlbumArt
- jobAlbumArt :: JobAlbumArt
- jaaMergePolicy :: Lens' JobAlbumArt (Maybe Text)
- jaaArtwork :: Lens' JobAlbumArt [Artwork]
- data JobInput
- jobInput :: JobInput
- jiFrameRate :: Lens' JobInput (Maybe Text)
- jiResolution :: Lens' JobInput (Maybe Text)
- jiAspectRatio :: Lens' JobInput (Maybe Text)
- jiTimeSpan :: Lens' JobInput (Maybe TimeSpan)
- jiEncryption :: Lens' JobInput (Maybe Encryption)
- jiKey :: Lens' JobInput (Maybe Text)
- jiDetectedProperties :: Lens' JobInput (Maybe DetectedProperties)
- jiContainer :: Lens' JobInput (Maybe Text)
- jiInterlaced :: Lens' JobInput (Maybe Text)
- jiInputCaptions :: Lens' JobInput (Maybe InputCaptions)
- data JobOutput
- jobOutput :: JobOutput
- joAppliedColorSpaceConversion :: Lens' JobOutput (Maybe Text)
- joThumbnailPattern :: Lens' JobOutput (Maybe Text)
- joStatus :: Lens' JobOutput (Maybe Text)
- joHeight :: Lens' JobOutput (Maybe Int)
- joFrameRate :: Lens' JobOutput (Maybe Text)
- joCaptions :: Lens' JobOutput (Maybe Captions)
- joPresetId :: Lens' JobOutput (Maybe Text)
- joComposition :: Lens' JobOutput [Clip]
- joAlbumArt :: Lens' JobOutput (Maybe JobAlbumArt)
- joFileSize :: Lens' JobOutput (Maybe Integer)
- joWatermarks :: Lens' JobOutput [JobWatermark]
- joWidth :: Lens' JobOutput (Maybe Int)
- joEncryption :: Lens' JobOutput (Maybe Encryption)
- joKey :: Lens' JobOutput (Maybe Text)
- joStatusDetail :: Lens' JobOutput (Maybe Text)
- joId :: Lens' JobOutput (Maybe Text)
- joSegmentDuration :: Lens' JobOutput (Maybe Text)
- joDurationMillis :: Lens' JobOutput (Maybe Integer)
- joThumbnailEncryption :: Lens' JobOutput (Maybe Encryption)
- joDuration :: Lens' JobOutput (Maybe Integer)
- joRotate :: Lens' JobOutput (Maybe Text)
- data JobWatermark
- jobWatermark :: JobWatermark
- jwPresetWatermarkId :: Lens' JobWatermark (Maybe Text)
- jwInputKey :: Lens' JobWatermark (Maybe Text)
- jwEncryption :: Lens' JobWatermark (Maybe Encryption)
- data Notifications
- notifications :: Notifications
- nError :: Lens' Notifications (Maybe Text)
- nWarning :: Lens' Notifications (Maybe Text)
- nProgressing :: Lens' Notifications (Maybe Text)
- nCompleted :: Lens' Notifications (Maybe Text)
- data Permission
- permission :: Permission
- pAccess :: Lens' Permission [Text]
- pGranteeType :: Lens' Permission (Maybe Text)
- pGrantee :: Lens' Permission (Maybe Text)
- data Pipeline
- pipeline :: Pipeline
- pipStatus :: Lens' Pipeline (Maybe Text)
- pipARN :: Lens' Pipeline (Maybe Text)
- pipInputBucket :: Lens' Pipeline (Maybe Text)
- pipContentConfig :: Lens' Pipeline (Maybe PipelineOutputConfig)
- pipOutputBucket :: Lens' Pipeline (Maybe Text)
- pipRole :: Lens' Pipeline (Maybe Text)
- pipName :: Lens' Pipeline (Maybe Text)
- pipAWSKMSKeyARN :: Lens' Pipeline (Maybe Text)
- pipId :: Lens' Pipeline (Maybe Text)
- pipNotifications :: Lens' Pipeline (Maybe Notifications)
- pipThumbnailConfig :: Lens' Pipeline (Maybe PipelineOutputConfig)
- data PipelineOutputConfig
- pipelineOutputConfig :: PipelineOutputConfig
- pocBucket :: Lens' PipelineOutputConfig (Maybe Text)
- pocStorageClass :: Lens' PipelineOutputConfig (Maybe Text)
- pocPermissions :: Lens' PipelineOutputConfig [Permission]
- data PlayReadyDrm
- playReadyDrm :: PlayReadyDrm
- prdKeyId :: Lens' PlayReadyDrm (Maybe Text)
- prdFormat :: Lens' PlayReadyDrm (Maybe Text)
- prdKeyMD5 :: Lens' PlayReadyDrm (Maybe Text)
- prdKey :: Lens' PlayReadyDrm (Maybe Text)
- prdInitializationVector :: Lens' PlayReadyDrm (Maybe Text)
- prdLicenseAcquisitionURL :: Lens' PlayReadyDrm (Maybe Text)
- data Playlist
- playlist :: Playlist
- pStatus :: Lens' Playlist (Maybe Text)
- pPlayReadyDrm :: Lens' Playlist (Maybe PlayReadyDrm)
- pFormat :: Lens' Playlist (Maybe Text)
- pOutputKeys :: Lens' Playlist [Text]
- pName :: Lens' Playlist (Maybe Text)
- pStatusDetail :: Lens' Playlist (Maybe Text)
- pHlsContentProtection :: Lens' Playlist (Maybe HlsContentProtection)
- data Preset
- preset :: Preset
- preARN :: Lens' Preset (Maybe Text)
- preVideo :: Lens' Preset (Maybe VideoParameters)
- preThumbnails :: Lens' Preset (Maybe Thumbnails)
- preName :: Lens' Preset (Maybe Text)
- preContainer :: Lens' Preset (Maybe Text)
- preId :: Lens' Preset (Maybe Text)
- preType :: Lens' Preset (Maybe Text)
- preDescription :: Lens' Preset (Maybe Text)
- preAudio :: Lens' Preset (Maybe AudioParameters)
- data PresetWatermark
- presetWatermark :: PresetWatermark
- pwVerticalAlign :: Lens' PresetWatermark (Maybe Text)
- pwSizingPolicy :: Lens' PresetWatermark (Maybe Text)
- pwHorizontalOffset :: Lens' PresetWatermark (Maybe Text)
- pwMaxHeight :: Lens' PresetWatermark (Maybe Text)
- pwOpacity :: Lens' PresetWatermark (Maybe Text)
- pwVerticalOffset :: Lens' PresetWatermark (Maybe Text)
- pwMaxWidth :: Lens' PresetWatermark (Maybe Text)
- pwId :: Lens' PresetWatermark (Maybe Text)
- pwHorizontalAlign :: Lens' PresetWatermark (Maybe Text)
- pwTarget :: Lens' PresetWatermark (Maybe Text)
- data Thumbnails
- thumbnails :: Thumbnails
- tSizingPolicy :: Lens' Thumbnails (Maybe Text)
- tFormat :: Lens' Thumbnails (Maybe Text)
- tMaxHeight :: Lens' Thumbnails (Maybe Text)
- tResolution :: Lens' Thumbnails (Maybe Text)
- tAspectRatio :: Lens' Thumbnails (Maybe Text)
- tPaddingPolicy :: Lens' Thumbnails (Maybe Text)
- tInterval :: Lens' Thumbnails (Maybe Text)
- tMaxWidth :: Lens' Thumbnails (Maybe Text)
- data TimeSpan
- timeSpan :: TimeSpan
- tsStartTime :: Lens' TimeSpan (Maybe Text)
- tsDuration :: Lens' TimeSpan (Maybe Text)
- data Timing
- timing :: Timing
- tSubmitTimeMillis :: Lens' Timing (Maybe Integer)
- tFinishTimeMillis :: Lens' Timing (Maybe Integer)
- tStartTimeMillis :: Lens' Timing (Maybe Integer)
- data VideoParameters
- videoParameters :: VideoParameters
- vpKeyframesMaxDist :: Lens' VideoParameters (Maybe Text)
- vpFrameRate :: Lens' VideoParameters (Maybe Text)
- vpSizingPolicy :: Lens' VideoParameters (Maybe Text)
- vpMaxFrameRate :: Lens' VideoParameters (Maybe Text)
- vpMaxHeight :: Lens' VideoParameters (Maybe Text)
- vpWatermarks :: Lens' VideoParameters [PresetWatermark]
- vpDisplayAspectRatio :: Lens' VideoParameters (Maybe Text)
- vpResolution :: Lens' VideoParameters (Maybe Text)
- vpCodec :: Lens' VideoParameters (Maybe Text)
- vpAspectRatio :: Lens' VideoParameters (Maybe Text)
- vpPaddingPolicy :: Lens' VideoParameters (Maybe Text)
- vpMaxWidth :: Lens' VideoParameters (Maybe Text)
- vpBitRate :: Lens' VideoParameters (Maybe Text)
- vpFixedGOP :: Lens' VideoParameters (Maybe Text)
- vpCodecOptions :: Lens' VideoParameters (HashMap Text Text)
- data Warning
- warning :: Warning
- wCode :: Lens' Warning (Maybe Text)
- wMessage :: Lens' Warning (Maybe Text)
Service Configuration
elasticTranscoder :: Service Source #
API version 2012-09-25
of the Amazon Elastic Transcoder SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ElasticTranscoder
.
IncompatibleVersionException
_IncompatibleVersionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for IncompatibleVersionException' errors.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more required parameter values were not provided in the request.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
General authentication failure. The request was not signed correctly.
InternalServiceException
_InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
JobComplete
jobComplete :: Wait ReadJob Source #
Polls ReadJob
every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DeletePreset
UpdatePipelineStatus
ListJobsByPipeline (Paginated)
UpdatePipeline
DeletePipeline
CreateJob
ListPipelines (Paginated)
CreatePreset
ListPresets (Paginated)
ReadPreset
ReadJob
UpdatePipelineNotifications
ReadPipeline
CreatePipeline
ListJobsByStatus (Paginated)
CancelJob
Types
Artwork
The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20.
To remove artwork or leave the artwork empty, you can either set Artwork
to null, or set the Merge Policy
to Replace and use an empty Artwork
array.
To pass through existing artwork unchanged, set the Merge Policy
to Prepend, Append, or Fallback, and use an empty Artwork
array.
See: artwork
smart constructor.
Instances
Creates a value of Artwork
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aSizingPolicy
- Specify one of the following values to control scaling of the output album art: *Fit:
Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidth
orMaxHeight
without exceeding the other value. *Fill:
Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidth
orMaxHeight
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 forMaxWidth
andMaxHeight
. 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 forMaxWidth
andMaxHeight
, 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 ofMaxWidth
andMaxHeight
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 ofMaxWidth
andMaxHeight
without dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.aAlbumArtFormat
- The format of album art, if any. Valid formats are.jpg
and.png
.aMaxHeight
- The maximum height of the output album art in pixels. If you specifyauto
, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.aInputKey
- The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified byPipelineId
; theInputBucket
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.aPaddingPolicy
- When you setPaddingPolicy
toPad
, 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 forMaxWidth
andMaxHeight
.aEncryption
- The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.aMaxWidth
- The maximum width of the output album art in pixels. If you specifyauto
, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.
aSizingPolicy :: Lens' Artwork (Maybe Text) Source #
Specify one of the following values to control scaling of the output album art: * 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.
aAlbumArtFormat :: Lens' Artwork (Maybe Text) Source #
The format of album art, if any. Valid formats are .jpg
and .png
.
aMaxHeight :: Lens' Artwork (Maybe Text) Source #
The maximum height of the output album art in pixels. If you specify auto
, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.
aInputKey :: Lens' Artwork (Maybe Text) Source #
The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by 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.
aPaddingPolicy :: Lens' Artwork (Maybe Text) Source #
When you set 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
.
aEncryption :: Lens' Artwork (Maybe Encryption) Source #
The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
aMaxWidth :: Lens' Artwork (Maybe Text) Source #
The maximum width of the output album art in pixels. If you specify auto
, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.
AudioCodecOptions
data AudioCodecOptions Source #
Options associated with your audio codec.
See: audioCodecOptions
smart constructor.
Instances
audioCodecOptions :: AudioCodecOptions Source #
Creates a value of AudioCodecOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acoSigned
- You can only choose whether an audio sample is signed when you specifypcm
for the value of Audio:Codec. Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers (unsigned). The supported value isSigned
.acoBitDepth
- You can only choose an audio bit depth when you specifyflac
orpcm
for the value of Audio:Codec. The bit depth of a sample is how many bits of information are included in the audio samples. The higher the bit depth, the better the audio, but the larger the file. Valid values are16
and24
. The most common bit depth is24
.acoProfile
- You can only choose an audio profile when you specify AAC for the value of Audio:Codec. Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles: *auto
: If you specifyauto
, Elastic Transcoder selects the profile based on the bit rate selected for the output file. *AAC-LC
: The most common AAC profile. Use for bit rates larger than 64 kbps. *HE-AAC
: Not supported on some older players and devices. Use for bit rates between 40 and 80 kbps. *HE-AACv2
: Not supported on some players and devices. Use for bit rates less than 48 kbps. All outputs in aSmooth
playlist must have the same value forProfile
.acoBitOrder
- You can only choose an audio bit order when you specifypcm
for the value of Audio:Codec. The order the bits of a PCM sample are stored in. The supported value isLittleEndian
.
acoSigned :: Lens' AudioCodecOptions (Maybe Text) Source #
You can only choose whether an audio sample is signed when you specify pcm
for the value of Audio:Codec. Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers (unsigned). The supported value is Signed
.
acoBitDepth :: Lens' AudioCodecOptions (Maybe Text) Source #
You can only choose an audio bit depth when you specify flac
or pcm
for the value of Audio:Codec. The bit depth of a sample is how many bits of information are included in the audio samples. The higher the bit depth, the better the audio, but the larger the file. Valid values are 16
and 24
. The most common bit depth is 24
.
acoProfile :: Lens' AudioCodecOptions (Maybe Text) Source #
You can only choose an audio profile when you specify AAC for the value of Audio:Codec. Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles: * auto
: If you specify auto
, Elastic Transcoder selects the profile based on the bit rate selected for the output file. * AAC-LC
: The most common AAC profile. Use for bit rates larger than 64 kbps. * HE-AAC
: Not supported on some older players and devices. Use for bit rates between 40 and 80 kbps. * HE-AACv2
: Not supported on some players and devices. Use for bit rates less than 48 kbps. All outputs in a Smooth
playlist must have the same value for Profile
.
acoBitOrder :: Lens' AudioCodecOptions (Maybe Text) Source #
You can only choose an audio bit order when you specify pcm
for the value of Audio:Codec. The order the bits of a PCM sample are stored in. The supported value is LittleEndian
.
AudioParameters
data AudioParameters Source #
Parameters required for transcoding audio.
See: audioParameters
smart constructor.
Instances
audioParameters :: AudioParameters Source #
Creates a value of AudioParameters
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
apChannels
- The number of audio channels in the output file. The following values are valid:auto
,0
,1
,2
One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, selectauto
. The output of a specific channel value and inputs are as follows: *auto
channel specified, with any input: Pass through up to eight input channels. *0
channels specified, with any input: Audio omitted from the output. *1
channel specified, with at least one input channel: Mono sound. *2
channels specified, with any input: Two identical mono channels or stereo. For more information about tracks, seeAudio:AudioPackingMode.
For more information about how Elastic Transcoder organizes channels and tracks, seeAudio:AudioPackingMode
.apCodec
- The audio codec for the output file. Valid values includeaac
,flac
,mp2
,mp3
,pcm
, andvorbis
.apAudioPackingMode
- The method of organizing audio channels and tracks. UseAudio:Channels
to specify the number of channels in your output, andAudio:AudioPackingMode
to specify the number of tracks and their relation to the channels. If you do not specify anAudio:AudioPackingMode
, Elastic Transcoder usesSingleTrack
. The following values are valid:SingleTrack
,OneChannelPerTrack
, andOneChannelPerTrackWithMosTo8Tracks
When you specifySingleTrack
, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. UseSingleTrack
for all non-mxf
containers. The outputs ofSingleTrack
for a specific channel value and inputs are as follows: *0
channels with any input: Audio omitted from the output *1, 2, or auto
channels with no audio input: Audio omitted from the output *1
channel with any input with audio: One track with one channel, downmixed if necessary *2
channels with one track with one channel: One track with two identical channels *2 or auto
channels with two tracks with one channel each: One track with two channels *2 or auto
channels with one track with two channels: One track with two channels *2
channels with one track with multiple channels: One track with two channels *auto
channels with one track with one channel: One track with one channel *auto
channels with one track with multiple channels: One track with multiple channels When you specifyOneChannelPerTrack
, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks. The outputs ofOneChannelPerTrack
for a specific channel value and inputs are as follows: *0
channels with any input: Audio omitted from the output *1, 2, or auto
channels with no audio input: Audio omitted from the output *1
channel with any input with audio: One track with one channel, downmixed if necessary *2
channels with one track with one channel: Two tracks with one identical channel each *2 or auto
channels with two tracks with one channel each: Two tracks with one channel each *2 or auto
channels with one track with two channels: Two tracks with one channel each *2
channels with one track with multiple channels: Two tracks with one channel each *auto
channels with one track with one channel: One track with one channel *auto
channels with one track with multiple channels: Up to eight tracks with one channel each When you specifyOneChannelPerTrackWithMosTo8Tracks
, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks. The outputs ofOneChannelPerTrackWithMosTo8Tracks
for a specific channel value and inputs are as follows: *0
channels with any input: Audio omitted from the output *1, 2, or auto
channels with no audio input: Audio omitted from the output *1
channel with any input with audio: One track with one channel, downmixed if necessary, plus six MOS tracks *2
channels with one track with one channel: Two tracks with one identical channel each, plus six MOS tracks *2 or auto
channels with two tracks with one channel each: Two tracks with one channel each, plus six MOS tracks *2 or auto
channels with one track with two channels: Two tracks with one channel each, plus six MOS tracks *2
channels with one track with multiple channels: Two tracks with one channel each, plus six MOS tracks *auto
channels with one track with one channel: One track with one channel, plus seven MOS tracks *auto
channels with one track with multiple channels: Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in allapSampleRate
- The sample rate of the audio stream in the output file, in Hertz. Valid values include:auto
,22050
,32000
,44100
,48000
,96000
If you specifyauto
, Elastic Transcoder automatically detects the sample rate.apBitRate
- The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.apCodecOptions
- If you specifiedAAC
forAudio:Codec
, this is theAAC
compression profile to use. Valid values include:auto
,AAC-LC
,HE-AAC
,HE-AACv2
If you specifyauto
, Elastic Transcoder chooses a profile based on the bit rate of the output file.
apChannels :: Lens' AudioParameters (Maybe Text) Source #
The number of audio channels in the output file. The following values are valid: auto
, 0
, 1
, 2
One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, select auto
. The output of a specific channel value and inputs are as follows: * auto
channel specified, with any input: Pass through up to eight input channels. * 0
channels specified, with any input: Audio omitted from the output. * 1
channel specified, with at least one input channel: Mono sound. * 2
channels specified, with any input: Two identical mono channels or stereo. For more information about tracks, see Audio:AudioPackingMode.
For more information about how Elastic Transcoder organizes channels and tracks, see Audio:AudioPackingMode
.
apCodec :: Lens' AudioParameters (Maybe Text) Source #
The audio codec for the output file. Valid values include aac
, flac
, mp2
, mp3
, pcm
, and vorbis
.
apAudioPackingMode :: Lens' AudioParameters (Maybe Text) Source #
The method of organizing audio channels and tracks. Use Audio:Channels
to specify the number of channels in your output, and Audio:AudioPackingMode
to specify the number of tracks and their relation to the channels. If you do not specify an Audio:AudioPackingMode
, Elastic Transcoder uses SingleTrack
. The following values are valid: SingleTrack
, OneChannelPerTrack
, and OneChannelPerTrackWithMosTo8Tracks
When you specify SingleTrack
, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. Use SingleTrack
for all non-mxf
containers. The outputs of SingleTrack
for a specific channel value and inputs are as follows: * 0
channels with any input: Audio omitted from the output * 1, 2, or auto
channels with no audio input: Audio omitted from the output * 1
channel with any input with audio: One track with one channel, downmixed if necessary * 2
channels with one track with one channel: One track with two identical channels * 2 or auto
channels with two tracks with one channel each: One track with two channels * 2 or auto
channels with one track with two channels: One track with two channels * 2
channels with one track with multiple channels: One track with two channels * auto
channels with one track with one channel: One track with one channel * auto
channels with one track with multiple channels: One track with multiple channels When you specify OneChannelPerTrack
, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks. The outputs of OneChannelPerTrack
for a specific channel value and inputs are as follows: * 0
channels with any input: Audio omitted from the output * 1, 2, or auto
channels with no audio input: Audio omitted from the output * 1
channel with any input with audio: One track with one channel, downmixed if necessary * 2
channels with one track with one channel: Two tracks with one identical channel each * 2 or auto
channels with two tracks with one channel each: Two tracks with one channel each * 2 or auto
channels with one track with two channels: Two tracks with one channel each * 2
channels with one track with multiple channels: Two tracks with one channel each * auto
channels with one track with one channel: One track with one channel * auto
channels with one track with multiple channels: Up to eight tracks with one channel each When you specify OneChannelPerTrackWithMosTo8Tracks
, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks. The outputs of OneChannelPerTrackWithMosTo8Tracks
for a specific channel value and inputs are as follows: * 0
channels with any input: Audio omitted from the output * 1, 2, or auto
channels with no audio input: Audio omitted from the output * 1
channel with any input with audio: One track with one channel, downmixed if necessary, plus six MOS tracks * 2
channels with one track with one channel: Two tracks with one identical channel each, plus six MOS tracks * 2 or auto
channels with two tracks with one channel each: Two tracks with one channel each, plus six MOS tracks * 2 or auto
channels with one track with two channels: Two tracks with one channel each, plus six MOS tracks * 2
channels with one track with multiple channels: Two tracks with one channel each, plus six MOS tracks * auto
channels with one track with one channel: One track with one channel, plus seven MOS tracks * auto
channels with one track with multiple channels: Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all
apSampleRate :: Lens' AudioParameters (Maybe Text) Source #
The sample rate of the audio stream in the output file, in Hertz. Valid values include: auto
, 22050
, 32000
, 44100
, 48000
, 96000
If you specify auto
, Elastic Transcoder automatically detects the sample rate.
apBitRate :: Lens' AudioParameters (Maybe Text) Source #
The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.
apCodecOptions :: Lens' AudioParameters (Maybe AudioCodecOptions) Source #
If you specified 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.
CaptionFormat
data CaptionFormat Source #
The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error.
See: captionFormat
smart constructor.
Instances
captionFormat :: CaptionFormat Source #
Creates a value of CaptionFormat
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfPattern
- The prefix for caption filenames, in the form description -{language}
, where: * description is a description of the video. *{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 is be Sydney-en-sunrise00000.srt.cfFormat
- The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output. * Valid Embedded Caption Formats: * for FLAC : None * 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. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. * For FMP4 : dfxp * Non-FMP4 outputs : All sidecar typesfmp4
captions have an extension of.ismt
cfEncryption
- The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.
cfPattern :: Lens' CaptionFormat (Maybe Text) Source #
The prefix for caption filenames, in the form description -{language}
, where: * description is a description of the video. * {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 is be Sydney-en-sunrise00000.srt.
cfFormat :: Lens' CaptionFormat (Maybe Text) Source #
The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output. * Valid Embedded Caption Formats: * for FLAC : None * 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. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. * For FMP4 : dfxp * Non-FMP4 outputs : All sidecar types fmp4
captions have an extension of .ismt
cfEncryption :: Lens' CaptionFormat (Maybe Encryption) Source #
The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.
CaptionSource
data CaptionSource Source #
A source file for the input sidecar captions used during the transcoding process.
See: captionSource
smart constructor.
Instances
captionSource :: CaptionSource Source #
Creates a value of CaptionSource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csTimeOffset
- For clip generation or captions that do not start at the same time as the associated video file, theTimeOffset
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.csEncryption
- The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.csKey
- The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.csLanguage
- A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of: * 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.csLabel
- The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.
csTimeOffset :: Lens' CaptionSource (Maybe Text) Source #
For clip generation or captions that do not start at the same time as the associated video file, the 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.
csEncryption :: Lens' CaptionSource (Maybe Encryption) Source #
The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.
csKey :: Lens' CaptionSource (Maybe Text) Source #
The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
csLanguage :: Lens' CaptionSource (Maybe Text) Source #
A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of: * 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.
csLabel :: Lens' CaptionSource (Maybe Text) Source #
The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.
Captions
The captions to be created, if any.
See: captions
smart constructor.
Instances
Creates a value of Captions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cMergePolicy
- A policy that determines how Elastic Transcoder handles the existence of multiple captions. * 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. IfCaptionSources
is empty, Elastic Transcoder omits all sidecar captions from the output files. * Override: Elastic Transcoder transcodes only the sidecar captions that you specify inCaptionSources
.MergePolicy
cannot be null.cCaptionSources
- Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leaveCaptionSources
blank.cCaptionFormats
- The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
cMergePolicy :: Lens' Captions (Maybe Text) Source #
A policy that determines how Elastic Transcoder handles the existence of multiple captions. * 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 CaptionSources
is empty, Elastic Transcoder omits all sidecar captions from the output files. * Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources
. MergePolicy
cannot be null.
cCaptionSources :: Lens' Captions [CaptionSource] Source #
Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources
blank.
cCaptionFormats :: Lens' Captions [CaptionFormat] Source #
The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
Clip
Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.
See: clip
smart constructor.
Instances
Eq Clip Source # | |
Data Clip Source # | |
Defined in Network.AWS.ElasticTranscoder.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Clip -> c Clip # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Clip # dataTypeOf :: Clip -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Clip) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Clip) # gmapT :: (forall b. Data b => b -> b) -> Clip -> Clip # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Clip -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Clip -> r # gmapQ :: (forall d. Data d => d -> u) -> Clip -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Clip -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Clip -> m Clip # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Clip -> m Clip # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Clip -> m Clip # | |
Read Clip Source # | |
Show Clip Source # | |
Generic Clip Source # | |
Hashable Clip Source # | |
Defined in Network.AWS.ElasticTranscoder.Types.Product | |
ToJSON Clip Source # | |
Defined in Network.AWS.ElasticTranscoder.Types.Product | |
FromJSON Clip Source # | |
NFData Clip Source # | |
Defined in Network.AWS.ElasticTranscoder.Types.Product | |
type Rep Clip Source # | |
Defined in Network.AWS.ElasticTranscoder.Types.Product |
cTimeSpan :: Lens' Clip (Maybe TimeSpan) Source #
Settings that determine when a clip begins and how long it lasts.
CreateJobOutput
data CreateJobOutput Source #
The CreateJobOutput
structure.
See: createJobOutput
smart constructor.
Instances
createJobOutput :: CreateJobOutput Source #
Creates a value of CreateJobOutput
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cjoThumbnailPattern
- 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 theThumbnailPattern
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. Important: 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 theThumbnailPattern
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 theThumbnailPattern
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 thePresetID
value ofCreateJobOutput
. Elastic Transcoder also appends the applicable file name extension.cjoCaptions
- 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), andmov-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), andwebvtt
Valid outputs include:dfxp
(first div element only),scc
,srt
, andwebvtt
. 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, setCaptions
to null. To pass through existing captions unchanged, set theMergePolicy
toMergeRetain
, and pass in a nullCaptionSources
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.cjoPresetId
- TheId
of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.cjoComposition
- 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.cjoAlbumArt
- 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.cjoWatermarks
- 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.cjoEncryption
- You can specify encryption settings for any output files that you want to use for a transcoding job. This includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must specify encryption settings for each file individually.cjoKey
- The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by theOutputBucket
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.cjoSegmentDuration
- Important: (Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
isfmp4
(Fragmented MP4) orts
(MPEG-TS),SegmentDuration
is the target maximum duration of each segment in seconds. ForHLSv3
format playlists, each media segment is stored in a separate.ts
file. ForHLSv4
andSmooth
playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of theSegmentDuration
, 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 bySegmentDuration
, the duration of the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder creates an output-specific playlist for each outputHLS
output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in theOutputKeys
of the associated playlist.cjoThumbnailEncryption
- The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.cjoRotate
- 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 valueauto
generally works only if the file that you're transcoding contains rotation metadata.
cjoThumbnailPattern :: Lens' CreateJobOutput (Maybe Text) Source #
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. Important: 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.
cjoCaptions :: Lens' CreateJobOutput (Maybe Captions) Source #
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.
cjoPresetId :: Lens' CreateJobOutput (Maybe Text) Source #
The Id
of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.
cjoComposition :: Lens' CreateJobOutput [Clip] Source #
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.
cjoAlbumArt :: Lens' CreateJobOutput (Maybe JobAlbumArt) Source #
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.
cjoWatermarks :: Lens' CreateJobOutput [JobWatermark] Source #
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.
cjoEncryption :: Lens' CreateJobOutput (Maybe Encryption) Source #
You can specify encryption settings for any output files that you want to use for a transcoding job. This includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must specify encryption settings for each file individually.
cjoKey :: Lens' CreateJobOutput (Maybe Text) Source #
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. If a file with the specified name already exists in the output bucket, the job fails.
cjoSegmentDuration :: Lens' CreateJobOutput (Maybe Text) Source #
Important: (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
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.
cjoThumbnailEncryption :: Lens' CreateJobOutput (Maybe Encryption) Source #
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
cjoRotate :: Lens' CreateJobOutput (Maybe Text) Source #
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.
CreateJobPlaylist
data CreateJobPlaylist Source #
Information about the master playlist.
See: createJobPlaylist
smart constructor.
Instances
createJobPlaylist :: CreateJobPlaylist Source #
Creates a value of CreateJobPlaylist
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cjpPlayReadyDrm
- The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.cjpFormat
- The format of the output playlist. Valid formats includeHLSv3
,HLSv4
, andSmooth
.cjpOutputKeys
- For each output in this job that you want to include in a master playlist, the value of theOutputs:Key
object. * If your output is notHLS
or does not have a segment duration set, the name of the output file is a concatenation ofOutputKeyPrefix
andOutputs:Key
: OutputKeyPrefixOutputs:Key
* If your output isHLSv3
and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of.m3u8
, and a series of.ts
files that include a five-digit sequential counter beginning with 00000: OutputKeyPrefixOutputs:Key
.m3u8 OutputKeyPrefixOutputs:Key
00000.ts * If your output isHLSv4
, has a segment duration set, and is included in anHLSv4
playlist, Elastic Transcoder creates an output playlist file with a file extension of_v4.m3u8
. If the output is video, Elastic Transcoder also creates an output file with an extension of_iframe.m3u8
: OutputKeyPrefixOutputs:Key
_v4.m3u8 OutputKeyPrefixOutputs:Key
_iframe.m3u8 OutputKeyPrefixOutputs:Key
.ts Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions. If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. ForSmooth
playlists, theAudio:Profile
,Video:Profile
, andVideo:FrameRate
toVideo:KeyframesMaxDist
ratio must be the same for all outputs.cjpName
- The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a/
character, the section of the name before the last/
must be identical for allName
objects. If you create more than one master playlist, the values of allName
objects must be unique.cjpHlsContentProtection
- The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
cjpPlayReadyDrm :: Lens' CreateJobPlaylist (Maybe PlayReadyDrm) Source #
The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
cjpFormat :: Lens' CreateJobPlaylist (Maybe Text) Source #
The format of the output playlist. Valid formats include HLSv3
, HLSv4
, and Smooth
.
cjpOutputKeys :: Lens' CreateJobPlaylist [Text] Source #
For each output in this job that you want to include in a master playlist, the value of the Outputs:Key
object. * If your output is not HLS
or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix
and Outputs:Key
: OutputKeyPrefixOutputs:Key
* If your output is HLSv3
and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8
, and a series of .ts
files that include a five-digit sequential counter beginning with 00000: OutputKeyPrefixOutputs:Key
.m3u8 OutputKeyPrefixOutputs:Key
00000.ts * If your output is HLSv4
, has a segment duration set, and is included in an HLSv4
playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8
. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8
: OutputKeyPrefixOutputs:Key
_v4.m3u8 OutputKeyPrefixOutputs:Key
_iframe.m3u8 OutputKeyPrefixOutputs:Key
.ts Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions. If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth
playlists, the Audio:Profile
, Video:Profile
, and Video:FrameRate
to Video:KeyframesMaxDist
ratio must be the same for all outputs.
cjpName :: Lens' CreateJobPlaylist (Maybe Text) Source #
The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a /
character, the section of the name before the last /
must be identical for all Name
objects. If you create more than one master playlist, the values of all Name
objects must be unique.
cjpHlsContentProtection :: Lens' CreateJobPlaylist (Maybe HlsContentProtection) Source #
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
DetectedProperties
data DetectedProperties Source #
The detected properties of the input file. Elastic Transcoder identifies these values from the input file.
See: detectedProperties
smart constructor.
Instances
detectedProperties :: DetectedProperties Source #
Creates a value of DetectedProperties
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dpHeight
- The detected height of the input file, in pixels.dpFrameRate
- The detected frame rate of the input file, in frames per second.dpFileSize
- The detected file size of the input file, in bytes.dpWidth
- The detected width of the input file, in pixels.dpDurationMillis
- The detected duration of the input file, in milliseconds.
dpHeight :: Lens' DetectedProperties (Maybe Int) Source #
The detected height of the input file, in pixels.
dpFrameRate :: Lens' DetectedProperties (Maybe Text) Source #
The detected frame rate of the input file, in frames per second.
dpFileSize :: Lens' DetectedProperties (Maybe Integer) Source #
The detected file size of the input file, in bytes.
dpWidth :: Lens' DetectedProperties (Maybe Int) Source #
The detected width of the input file, in pixels.
dpDurationMillis :: Lens' DetectedProperties (Maybe Integer) Source #
The detected duration of the input file, in milliseconds.
Encryption
data Encryption Source #
The encryption settings, if any, that are used for decrypting your input files or encrypting your output files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file, otherwise you must specify the mode you want Elastic Transcoder to use to encrypt your output files.
See: encryption
smart constructor.
Instances
encryption :: Encryption Source #
Creates a value of Encryption
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eMode
- The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options: * S3: Amazon S3 creates and manages the keys used for encrypting your files. * S3-AWS-KMS: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specifyS3-AWS-KMS
and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline. * AES-CBC-PKCS7: A padded cipher-block mode of operation originally used for HLS files. * AES-CTR: AES Counter Mode. * AES-GCM: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with fails the decryption process. For all three AES options, you must provide the following settings, which must be base64-encoded: * Key * Key MD5 * Initialization Vector Important: For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.eKeyMD5
- The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.eKey
- The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:128
,192
, or256
. The key must also be encrypted by using the Amazon Key Management Service.eInitializationVector
- The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
eMode :: Lens' Encryption (Maybe Text) Source #
The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options: * S3: Amazon S3 creates and manages the keys used for encrypting your files. * S3-AWS-KMS: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify S3-AWS-KMS
and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline. * AES-CBC-PKCS7: A padded cipher-block mode of operation originally used for HLS files. * AES-CTR: AES Counter Mode. * AES-GCM: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with fails the decryption process. For all three AES options, you must provide the following settings, which must be base64-encoded: * Key * Key MD5 * Initialization Vector Important: For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.
eKeyMD5 :: Lens' Encryption (Maybe Text) Source #
The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
eKey :: Lens' Encryption (Maybe Text) Source #
The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded: 128
, 192
, or 256
. The key must also be encrypted by using the Amazon Key Management Service.
eInitializationVector :: Lens' Encryption (Maybe Text) Source #
The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
HlsContentProtection
data HlsContentProtection Source #
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to your output files.
See: hlsContentProtection
smart constructor.
Instances
hlsContentProtection :: HlsContentProtection Source #
Creates a value of HlsContentProtection
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hcpKeyMD5
- If Elastic Transcoder is generating your key for you, you must leave this field blank. The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64- encoded.hcpKeyStoragePolicy
- Specify whether you want Elastic Transcoder to write your HLS license key to an Amazon S3 bucket. If you chooseWithVariantPlaylists
,LicenseAcquisitionUrl
must be left blank and Elastic Transcoder writes your data key into the same bucket as the associated playlist.hcpKey
- If you want Elastic Transcoder to generate a key for you, leave this field blank. If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:128
,192
, or256
.hcpMethod
- The content protection method for your output. The only valid value is:aes-128
. This value is written into the method attribute of theEXT-X-KEY
metadata tag in the output playlist.hcpInitializationVector
- If Elastic Transcoder is generating your key for you, you must leave this field blank. The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.hcpLicenseAcquisitionURL
- The location of the license key required to decrypt your HLS playlist. The URL must be an absolute path, and is referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file.
hcpKeyMD5 :: Lens' HlsContentProtection (Maybe Text) Source #
If Elastic Transcoder is generating your key for you, you must leave this field blank. The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64- encoded.
hcpKeyStoragePolicy :: Lens' HlsContentProtection (Maybe Text) Source #
Specify whether you want Elastic Transcoder to write your HLS license key to an Amazon S3 bucket. If you choose WithVariantPlaylists
, LicenseAcquisitionUrl
must be left blank and Elastic Transcoder writes your data key into the same bucket as the associated playlist.
hcpKey :: Lens' HlsContentProtection (Maybe Text) Source #
If you want Elastic Transcoder to generate a key for you, leave this field blank. If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded: 128
, 192
, or 256
.
hcpMethod :: Lens' HlsContentProtection (Maybe Text) Source #
The content protection method for your output. The only valid value is: aes-128
. This value is written into the method attribute of the EXT-X-KEY
metadata tag in the output playlist.
hcpInitializationVector :: Lens' HlsContentProtection (Maybe Text) Source #
If Elastic Transcoder is generating your key for you, you must leave this field blank. The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.
hcpLicenseAcquisitionURL :: Lens' HlsContentProtection (Maybe Text) Source #
The location of the license key required to decrypt your HLS playlist. The URL must be an absolute path, and is referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file.
InputCaptions
data InputCaptions Source #
The captions to be created, if any.
See: inputCaptions
smart constructor.
Instances
inputCaptions :: InputCaptions Source #
Creates a value of InputCaptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
icMergePolicy
- A policy that determines how Elastic Transcoder handles the existence of multiple captions. * 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. IfCaptionSources
is empty, Elastic Transcoder omits all sidecar captions from the output files. * Override: Elastic Transcoder transcodes only the sidecar captions that you specify inCaptionSources
.MergePolicy
cannot be null.icCaptionSources
- Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leaveCaptionSources
blank.
icMergePolicy :: Lens' InputCaptions (Maybe Text) Source #
A policy that determines how Elastic Transcoder handles the existence of multiple captions. * 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 CaptionSources
is empty, Elastic Transcoder omits all sidecar captions from the output files. * Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources
. MergePolicy
cannot be null.
icCaptionSources :: Lens' InputCaptions [CaptionSource] Source #
Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources
blank.
Job'
A section of the response body that provides information about the job that is created.
See: job'
smart constructor.
Instances
Creates a value of Job'
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jStatus
- The status of the job:Submitted
,Progressing
,Complete
,Canceled
, orError
.jPipelineId
- TheId
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.jARN
- The Amazon Resource Name (ARN) for the job.jInputs
- Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output.jInput
- A section of the request or response body that provides information about the file that is being transcoded.jUserMetadata
- User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata inkey/value
pairs, and you can add up to 10key/value
pairs per job. Elastic Transcoder does not guarantee thatkey/value
pairs are returned in the same order in which you specify them. Metadatakeys
andvalues
must use characters from the following list: *0-9
*A-Z
anda-z
*Space
* The following symbols:_.:/=+-%
@jOutputs
- Information about the output files. We recommend that you use theOutputs
syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both theOutputs
andOutput
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.jOutput
- 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. Important: Outputs recommended instead. A section of the request or response body that provides information about the transcoded (target) file.jId
- The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.jPlaylists
- Important: Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
is fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlists
contains information about the master playlists that you want Elastic Transcoder to create. The maximum number of master playlists in a job is 30.jOutputKeyPrefix
- The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of theOutputKeyPrefix
.jTiming
- Details about the timing of a job.
jStatus :: Lens' Job' (Maybe Text) Source #
The status of the job: Submitted
, Progressing
, Complete
, Canceled
, or Error
.
jPipelineId :: Lens' Job' (Maybe Text) Source #
The 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.
jInputs :: Lens' Job' [JobInput] Source #
Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output.
jInput :: Lens' Job' (Maybe JobInput) Source #
A section of the request or response body that provides information about the file that is being transcoded.
jUserMetadata :: Lens' Job' (HashMap Text Text) Source #
User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value
pairs, and you can add up to 10 key/value
pairs per job. Elastic Transcoder does not guarantee that key/value
pairs are returned in the same order in which you specify them. Metadata keys
and values
must use characters from the following list: * 0-9
* A-Z
and a-z
* Space
* The following symbols: _.:/=+-%
@
jOutputs :: Lens' Job' [JobOutput] Source #
Information about the output files. We recommend that you use the 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.
jOutput :: Lens' Job' (Maybe JobOutput) Source #
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. Important: Outputs recommended instead. A section of the request or response body that provides information about the transcoded (target) file.
jId :: Lens' Job' (Maybe Text) Source #
The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.
jPlaylists :: Lens' Job' [Playlist] Source #
Important: 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), Playlists
contains information about the master playlists that you want Elastic Transcoder to create. The maximum number of master playlists in a job is 30.
jOutputKeyPrefix :: Lens' Job' (Maybe Text) Source #
The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the OutputKeyPrefix
.
JobAlbumArt
data JobAlbumArt Source #
The .jpg or .png file associated with an audio file.
See: jobAlbumArt
smart constructor.
Instances
jobAlbumArt :: JobAlbumArt Source #
Creates a value of JobAlbumArt
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jaaMergePolicy
- A policy that determines how Elastic Transcoder handles the existence of multiple album artwork files. *Replace:
The specified album art replaces any existing album art. *Prepend:
The specified album art is placed in front of any existing album art. *Append:
The specified album art is placed after any existing album art. *Fallback:
If the original input file contains artwork, Elastic Transcoder uses that artwork for the output. If the original input does not contain artwork, Elastic Transcoder uses the specified album art file.jaaArtwork
- The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20. Valid formats are.jpg
and.png
jaaMergePolicy :: Lens' JobAlbumArt (Maybe Text) Source #
A policy that determines how Elastic Transcoder handles the existence of multiple album artwork files. * Replace:
The specified album art replaces any existing album art. * Prepend:
The specified album art is placed in front of any existing album art. * Append:
The specified album art is placed after any existing album art. * Fallback:
If the original input file contains artwork, Elastic Transcoder uses that artwork for the output. If the original input does not contain artwork, Elastic Transcoder uses the specified album art file.
jaaArtwork :: Lens' JobAlbumArt [Artwork] Source #
The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20. Valid formats are .jpg
and .png
JobInput
Information about the file that you're transcoding.
See: jobInput
smart constructor.
Instances
Creates a value of JobInput
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jiFrameRate
- The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specifyauto
. 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 thanauto
, Elastic Transcoder disables automatic detection of the frame rate.jiResolution
- This value must beauto
, which causes Elastic Transcoder to automatically detect the resolution of the input file.jiAspectRatio
- The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specifyauto
. 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 thanauto
, Elastic Transcoder disables automatic detection of the aspect ratio.jiTimeSpan
- Settings for clipping an input. Each input can have different clip settings.jiEncryption
- The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.jiKey
- The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. TheInputBucket
object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from. If the file name includes a prefix, such ascooking/lasagna.mpg
, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.jiDetectedProperties
- The detected properties of the input file.jiContainer
- The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specifyauto
. 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
jiInterlaced
- Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specifyauto
. 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 thanauto
, Elastic Transcoder disables automatic detection of interlacing.jiInputCaptions
- 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), andmov-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), andwebvtt
Valid outputs include:dfxp
(first div element only),scc
,srt
, andwebvtt
. 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, setCaptions
to null. To pass through existing captions unchanged, set theMergePolicy
toMergeRetain
, and pass in a nullCaptionSources
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.
jiFrameRate :: Lens' JobInput (Maybe Text) Source #
The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify 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.
jiResolution :: Lens' JobInput (Maybe Text) Source #
This value must be auto
, which causes Elastic Transcoder to automatically detect the resolution of the input file.
jiAspectRatio :: Lens' JobInput (Maybe Text) Source #
The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify 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.
jiTimeSpan :: Lens' JobInput (Maybe TimeSpan) Source #
Settings for clipping an input. Each input can have different clip settings.
jiEncryption :: Lens' JobInput (Maybe Encryption) Source #
The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.
jiKey :: Lens' JobInput (Maybe Text) Source #
The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The 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.
jiDetectedProperties :: Lens' JobInput (Maybe DetectedProperties) Source #
The detected properties of the input file.
jiContainer :: Lens' JobInput (Maybe Text) Source #
The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify 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
jiInterlaced :: Lens' JobInput (Maybe Text) Source #
Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify 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.
jiInputCaptions :: Lens' JobInput (Maybe InputCaptions) Source #
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.
JobOutput
Important: 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.
See: jobOutput
smart constructor.
Instances
jobOutput :: JobOutput Source #
Creates a value of JobOutput
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
joAppliedColorSpaceConversion
- If Elastic Transcoder used a preset with aColorSpaceConversionMode
to transcode the output file, theAppliedColorSpaceConversion
parameter shows the conversion used. If noColorSpaceConversionMode
was defined in the preset, this parameter is not be included in the job response.joThumbnailPattern
- 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 theThumbnailPattern
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. Important: 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 theThumbnailPattern
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 theThumbnailPattern
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 thePresetID
value ofCreateJobOutput
. Elastic Transcoder also appends the applicable file name extension.joStatus
- The status of one output in a job. If you specified only one output for the job,Outputs:Status
is always the same asJob:Status
. If you specified more than one output: *Job:Status
andOutputs: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 andJob:Status
both change to Progressing. For each output, the value ofOutputs: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 ifOutputs:Status
for all of the outputs isComplete
. IfOutputs:Status
for one or more outputs isError
, the terminal status forJob:Status
is alsoError
. The value ofStatus
is one of the following:Submitted
,Progressing
,Complete
,Canceled
, orError
.joHeight
- Height of the output file, in pixels.joFrameRate
- Frame rate of the output file, in frames per second.joCaptions
- 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), andmov-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), andwebvtt
Valid outputs include:dfxp
(first div element only),scc
,srt
, andwebvtt
. 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, setCaptions
to null. To pass through existing captions unchanged, set theMergePolicy
toMergeRetain
, and pass in a nullCaptionSources
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.joPresetId
- The value of theId
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 withListPresets
.joComposition
- 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.joAlbumArt
- The album art to be associated with the output file, if any.joFileSize
- File size of the output file, in bytes.joWatermarks
- 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 inPreset
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.joWidth
- Specifies the width of the output file in pixels.joEncryption
- 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.joKey
- The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by theOutputBucket
object in the pipeline that is specified by the pipeline ID.joStatusDetail
- Information that further explainsStatus
.joId
- 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.joSegmentDuration
- Important: (Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
isfmp4
(Fragmented MP4) orts
(MPEG-TS),SegmentDuration
is the target maximum duration of each segment in seconds. ForHLSv3
format playlists, each media segment is stored in a separate.ts
file. ForHLSv4
,MPEG-DASH
, andSmooth
playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of theSegmentDuration
, 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 bySegmentDuration
, the duration of the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder creates an output-specific playlist for each outputHLS
output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in theOutputKeys
of the associated playlist.joDurationMillis
- Duration of the output file, in milliseconds.joThumbnailEncryption
- The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.joDuration
- Duration of the output file, in seconds.joRotate
- 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 valueauto
generally works only if the file that you're transcoding contains rotation metadata.
joAppliedColorSpaceConversion :: Lens' JobOutput (Maybe Text) Source #
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.
joThumbnailPattern :: Lens' JobOutput (Maybe Text) Source #
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. Important: 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.
joStatus :: Lens' JobOutput (Maybe Text) Source #
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
.
joFrameRate :: Lens' JobOutput (Maybe Text) Source #
Frame rate of the output file, in frames per second.
joCaptions :: Lens' JobOutput (Maybe Captions) Source #
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.
joPresetId :: Lens' JobOutput (Maybe Text) Source #
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
.
joComposition :: Lens' JobOutput [Clip] Source #
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.
joAlbumArt :: Lens' JobOutput (Maybe JobAlbumArt) Source #
The album art to be associated with the output file, if any.
joWatermarks :: Lens' JobOutput [JobWatermark] Source #
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.
joEncryption :: Lens' JobOutput (Maybe Encryption) Source #
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.
joKey :: Lens' JobOutput (Maybe Text) Source #
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.
joId :: Lens' JobOutput (Maybe Text) Source #
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.
joSegmentDuration :: Lens' JobOutput (Maybe Text) Source #
Important: (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.
joDurationMillis :: Lens' JobOutput (Maybe Integer) Source #
Duration of the output file, in milliseconds.
joThumbnailEncryption :: Lens' JobOutput (Maybe Encryption) Source #
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
joRotate :: Lens' JobOutput (Maybe Text) Source #
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.
JobWatermark
data JobWatermark Source #
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.
See: jobWatermark
smart constructor.
Instances
jobWatermark :: JobWatermark Source #
Creates a value of JobWatermark
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jwPresetWatermarkId
- The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.jwInputKey
- The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified byPipeline
; theInput 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.jwEncryption
- The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.
jwPresetWatermarkId :: Lens' JobWatermark (Maybe Text) Source #
The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.
jwInputKey :: Lens' JobWatermark (Maybe Text) Source #
The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by 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.
jwEncryption :: Lens' JobWatermark (Maybe Encryption) Source #
The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.
Notifications
data Notifications Source #
The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.
Important: To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
See: notifications
smart constructor.
Instances
notifications :: Notifications Source #
Creates a value of Notifications
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nError
- The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.nWarning
- The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.nProgressing
- The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.nCompleted
- The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
nError :: Lens' Notifications (Maybe Text) Source #
The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
nWarning :: Lens' Notifications (Maybe Text) Source #
The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
nProgressing :: Lens' Notifications (Maybe Text) Source #
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
nCompleted :: Lens' Notifications (Maybe Text) Source #
The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
Permission
data Permission Source #
The Permission
structure.
See: permission
smart constructor.
Instances
permission :: Permission Source #
Creates a value of Permission
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pAccess
- 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 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.pGranteeType
- The type of value that appears in the Grantee object: *Canonical
: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. Important: A canonical user ID is not the same as an AWS account number. *Email
: The registered email address of an AWS account. *Group
: One of the following predefined Amazon S3 groups:AllUsers
,AuthenticatedUsers
, orLogDelivery
.pGrantee
- The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
pAccess :: Lens' Permission [Text] Source #
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 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.
pGranteeType :: Lens' Permission (Maybe Text) Source #
The type of value that appears in the Grantee object: * Canonical
: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. Important: A canonical user ID is not the same as an AWS account number. * Email
: The registered email address of an AWS account. * Group
: One of the following predefined Amazon S3 groups: AllUsers
, AuthenticatedUsers
, or LogDelivery
.
pGrantee :: Lens' Permission (Maybe Text) Source #
The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
Pipeline
The pipeline (queue) that is used to manage jobs.
See: pipeline
smart constructor.
Instances
Creates a value of Pipeline
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pipStatus
- The current status of the pipeline: *Active
: The pipeline is processing jobs. *Paused
: The pipeline is not currently processing jobs.pipARN
- The Amazon Resource Name (ARN) for the pipeline.pipInputBucket
- The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.pipContentConfig
- Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify bothContentConfig
andThumbnailConfig
, or you specifyOutputBucket
. * Bucket : The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. * Permissions : A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have. * GranteeType: The type of value that appears in theGrantee
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
, orLogDelivery
. *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 inGrantee
. 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 hasREAD
,READ_ACP
, andWRITE_ACP
permissions for the objects 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 video files and playlists that it stores in your Amazon S3 bucket.pipOutputBucket
- The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify bothContentConfig
andThumbnailConfig
.pipRole
- The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.pipName
- The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. Constraints: Maximum 40 characterspipAWSKMSKeyARN
- The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline. If you use eitherS3
orS3-AWS-KMS
as yourEncryption:Mode
, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using anEncryption:Mode
ofAES-PKCS7
,AES-CTR
, orAES-GCM
.pipId
- The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.pipNotifications
- The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. Important: To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. * Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job. * Completed (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job. * Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. * Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.pipThumbnailConfig
- Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify bothContentConfig
andThumbnailConfig
, or you specifyOutputBucket
. *Bucket
: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. *Permissions
: A list of the users andor predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have. * GranteeType: The type of value that appears in the Grantee object: *Canonical
: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. Important:/ A canonical user ID is not the same as an AWS account number. *Email
: The registered email address of an AWS account. *Group
: One of the following predefined Amazon S3 groups:AllUsers
,AuthenticatedUsers
, orLogDelivery
. *Grantee
: The AWS user or group that you want to have access to thumbnail files. * 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 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
orReducedRedundancy
, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.
pipStatus :: Lens' Pipeline (Maybe Text) Source #
The current status of the pipeline: * Active
: The pipeline is processing jobs. * Paused
: The pipeline is not currently processing jobs.
pipInputBucket :: Lens' Pipeline (Maybe Text) Source #
The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.
pipContentConfig :: Lens' Pipeline (Maybe PipelineOutputConfig) Source #
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig
and ThumbnailConfig
, or you specify OutputBucket
. * Bucket : The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. * Permissions : A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have. * GranteeType: The type of value that appears in the 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. * StorageClass : The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.